OpenSpec

Siapkan proyek Anda ​

Tambahkan OpenSpec ke sebuah proyek: jalankan init, lihat apa yang ditulisnya, dan sesuaikan.

Pilih di mana OpenSpec berada ​

  • Di repo Anda (default): spec dan perubahan berada di samping kode yang mereka deskripsikan dan dilacak versinya bersama kode tersebut. Sisa halaman ini mengikuti jalur ini.
  • Di store: repo perencanaan terpisah yang dipakai bersama oleh repo-repo yang menggunakannya, untuk setup multi-repo atau menjaga perencanaan tetap di luar repo sepenuhnya. Store (beta) membahas kapan hal ini layak dilakukan dan cara menyiapkannya.

Inisialisasi proyek Anda ​

Dengan CLI terpasang (Instalasi), jalankan init di root proyek Anda. Di terminal Anda:

bash
cd <your-project>
openspec init

Init akan menanyakan alat AI mana yang Anda gunakan, menulis file alur kerja untuk alat yang Anda pilih, dan melaporkan apa yang Anda peroleh:

OpenSpec Setup Complete

Created: Claude Code
6 skills and 6 commands in .claude/
Config: openspec/config.yaml (schema: spec-driven)

Restart IDE Anda agar perintah baru dapat berlaku.

Menjalankan init ulang aman:

  • Alat yang sudah Anda siapkan akan mencetak Refreshed bukan Created.
  • Menjalankan init lagi dengan alat baru yang dipilih akan menambahkan alat tersebut.
  • Flag --tools melewati pemilih (Referensi CLI).

Migrasikan project.md yang sudah ada ​

Init tidak menyalin openspec/project.md lama ke config.yaml. Init akan mempertahankan file tersebut dan mencetak permintaan migrasi yang dibantu AI.

Di chat AI Anda:

Review openspec/project.md and migrate its useful content to openspec/config.yaml.
Keep context concise: include only project-wide facts needed during artifact creation, apply, and archive.
Move artifact-specific guidance into rules for the matching artifacts.
Move guidance for apply or archive into the matching operations entry.
Leave out generic, outdated, or verbose material. Do not delete project.md.

Tinjau config.yaml, lalu hapus project.md ketika siap.

Apa yang dipasang oleh init ​

Menjalankan init membuat dua hal di proyek Anda:

  • Folder openspec/ di root repo
  • File alur kerja (skill dan perintah) ditambahkan ke folder alat AI Anda (.agents/, .claude/, dll.)

Commit semuanya seperti sisa source Anda. Init tidak mengubah apa pun di repo Anda (jika menemukan sisa dari versi OpenSpec lama, init akan bertanya sebelum membersihkannya).

Folder openspec/ ​

Setiap artefak OpenSpec berada di sini, di root proyek Anda. Berikut tampilannya:

openspec/
├── config.yaml     project settings and context for the AI
├── specs/          your specs (empty for now)
└── changes/        in-motion changes (empty for now)
    └── archive/    completed changes move here

Konfigurasi proyek membahas config.yaml.

File alur kerja (skill dan perintah) ​

Ini adalah alur kerja OpenSpec, tindakan yang akan Anda gunakan saat bekerja. Berikut daftarnya sebagai skill yang dipasang, di folder .agents/ bersama yang dipakai kebanyakan alat:

.agents/skills/
├── openspec-explore/              think through an idea first
├── openspec-propose/              propose a change
├── openspec-apply-change/         implement a change's tasks
├── openspec-update-change/        revise a change's plan
├── openspec-sync-specs/           sync a change's spec updates into specs/
├── openspec-archive-change/       move a finished change to the archive
├── openspec-verify-change/        check the implementation matches the plan (not included by default)
└── openspec-bulk-archive-change/  archive several changes at once (not included by default)

Ini adalah set default ditambah dua alur kerja opsional. Profil mencantumkan semuanya dua belas.

Secara default setiap alur kerja dipasang dalam dua bentuk:

  • Skill (openspec-apply-change): instruksi yang diambil sendiri oleh agent Anda saat Anda meminta pekerjaan tersebut.
  • Perintah (/opsx:apply di Claude Code): titik masuk tertulis untuk alur kerja yang sama, dengan nama yang lebih pendek.

Keduanya secara fungsional identik. Skill dan perintah dari sebuah alur kerja membawa instruksi yang sama.

Mengapa dua: perintah hadir lebih dulu, dan setiap alat mengejanya dengan caranya sendiri. Skill adalah standar yang lebih baru yang dipakai lintas alat, tetapi tidak semua alat dapat memanggil skill secara langsung, jadi perintah tetap ada sebagai titik masuk alat-alat tersebut.

Beberapa alat hanya memasang dalam bentuk skill. Di mana alat menjalankan skill secara langsung, init melewati perintah dan menyatakannya (Commands skipped for: codex (uses skills)).

Kami lebih memilih skill dan berharap untuk pensiunkan perintah suatu hari nanti.

Ubah apa yang dipasang ​

Pemilih interaktif mengubah bentuk pengantaran dan set alur kerja (Profil). Di terminal Anda:

bash
openspec config profile

Berikut beralih ke skill saja:

Current profile settings
  Delivery: both

? What do you want to configure? Delivery only
? Delivery mode (how workflows are installed): Skills only

Config changes:
  delivery: both -> skills
? Apply changes to this project now? (Y/n) y

Menjawab ya menerapkannya ke proyek saat ini secara langsung. Proyek lain akan mengikutinya pada openspec update berikutnya. Pengaturan ini bersifat global, per mesin.

Claude Code tidak menampilkan alur kerja ​

Claude Code memuat alur kerja OpenSpec dari satu atau kedua path proyek berikut, berdasarkan pengaturan pengantaran Anda:

  • Skill: .claude/skills/openspec-*/SKILL.md
  • Perintah: .claude/commands/opsx/<id>.md

Jika file hilang, segarkan proyek. Di terminal Anda:

bash
openspec update

Jika file perintah ada tetapi /opsx: tidak menampilkan perintah OpenSpec, perbarui Claude Code dan restart. Jika perintah masih tidak dimuat, aktifkan juga skill. Di terminal Anda:

bash
openspec config set delivery both
openspec update

Restart Claude Code, lalu jalankan /openspec-propose di chat-nya. Jika hanya sebagian alur kerja yang hilang, ubah profil Anda.

Setup selesai. Quickstart membawa perubahan pertama Anda dari sini.