Instalasi
Prasyarat
- Node.js 20.19.0 atau lebih tinggi — Periksa versi Anda:
node --version
Instal dengan asisten AI Anda
Tidak ingin melakukannya secara manual? Tempelkan prompt di bawah ini ke dalam asisten pengkodean apa pun yang dapat menjalankan perintah shell — Claude Code, Codex, Cursor, Gemini CLI, Copilot, dan alat-alat lainnya yang didukung. Ini akan menginstal CLI, menginisialisasi proyek ini, dan melaporkan apa yang sebenarnya terjadi.
Langkah-langkah manual di bawah ini adalah sumber kebenaran — prompt hanya menjalankannya untuk Anda. Jika asisten Anda berhenti dan menyerahkan sesuatu kembali, itu sesuai desain: ia bertanya sebelum melakukan apa pun yang bersifat istimewa dan tidak pernah mengedit file startup shell Anda. Selesaikan bagian-bagian tersebut sendiri dengan Package Managers dan Troubleshooting.
Install OpenSpec in this project and set it up for me. Follow these steps in
order, and stop where a step tells you to stop.
1. RUNTIME. Run `node --version`. OpenSpec needs Node.js 20.19.0 or higher. If
Node is missing or older, say so and stop — don't install Node, switch
versions, or reconfigure my version manager for me.
2. INSTALL. Use whichever package manager is already on my PATH, preferring npm:
npm install -g @fission-ai/openspec@latest
pnpm add -g @fission-ai/openspec@latest
bun add -g @fission-ai/openspec@latest
yarn global add @fission-ai/openspec@latest (Yarn 1.x only)
Don't pick based on this project's lockfile — a global install has nothing to
do with how this repo's own dependencies are installed. If none of those four
is available, stop and tell me — don't improvise an install. (If I'm on Nix,
point me at the Nix section of the OpenSpec installation docs instead.)
Show me the exact command and let me confirm before you run it; this installs
software outside the project, and I may want a different package manager to
own it.
Stop and ask me again if the install needs sudo or admin rights, fails with a
permissions error, or reports that its global bin directory is missing or
unconfigured. Never edit my shell startup files (.bashrc, .zshrc, .profile,
fish, PowerShell profile), and never run a setup command that edits them for
me — show me the change and let me make it.
3. PATH. Run `openspec --version`. If the command isn't found, it may just be
missing from this shell: tell me where the package manager installed it and
how to add that directory to PATH for my shell and OS, then stop until I
confirm. If it prints an older version than the one the install just
reported, an earlier copy is shadowing it on PATH — tell me both versions
instead of continuing. If I use a version manager, say so rather than editing
PATH around it: with nvm or fnm the CLI is tied to the Node version that was
active when you installed it, and with asdf or volta a shim may need
regenerating.
4. INITIALIZE. Ask me which AI coding tool or tools I use and map each to an id
from `openspec init --help` (Copilot is `github-copilot`, Zoo Code is
`roocode`). `--tools` takes a comma-separated list, so name all of them.
`openspec init --tools <ids>` deletes leftovers from older OpenSpec versions
automatically, without asking — including `opsx-*.md` prompt files in my home
directory (Codex keeps them in ~/.codex/prompts). Before you run it, look for
those: `.../commands/openspec/` folders, OpenSpec marker blocks in files like
CLAUDE.md or AGENTS.md, and home-directory `opsx-*.md` prompts. List whatever
you find and wait for my go-ahead; if you find nothing, say so and carry on
without asking. An existing `openspec/` folder is not a problem — init
refreshes it and leaves my specs and changes alone.
Confirm I'm in the right folder too: init creates `openspec/` wherever it
runs, including inside a monorepo package.
Then run: openspec init --tools <ids>
5. REPORT. Don't assume what should exist — tell me what init actually printed:
how many skills and/or commands it created and where, the config file line,
any "Setup required" note, and what to restart or reload. Some tools are
skills-only and correctly create zero command files, so missing commands is
not a failure on its own. If init said nothing was generated, relay the fix
it suggested instead of retrying. Finish by telling me how to invoke OpenSpec
in my tool, and take the exact spelling from the files init created rather
than from its summary line: the punctuation differs per tool (/opsx:propose
in some, /opsx-propose in others, @opsx-propose in Amazon Q), and tools that
get skills instead of commands are invoked by skill name (/openspec-propose,
or $openspec-propose in Codex, or /skill:openspec-propose in Kimi Code).Tidak ada dalam prompt yang spesifik vendor: ini adalah instruksi biasa ditambah perintah yang sama yang didokumentasikan di halaman ini. Ini berfungsi di macOS, Linux, dan Windows, dan sengaja berhenti daripada melakukan improvisasi ketika sebuah langkah memerlukan izin Anda. Asisten Anda perlu mampu menjalankan perintah shell — beberapa integrasi IDE tidak bisa.
Package Managers
npm
npm install -g @fission-ai/openspec@latestpnpm
pnpm add -g @fission-ai/openspec@latestyarn
yarn global add @fission-ai/openspec@latestYarn 2 dan selanjutnya (Berry) menghapus perintah global. Pada versi tersebut, instal OpenSpec dengan npm, pnpm, atau bun sebagai gantinya — CLI global tidak perlu berbagi package manager proyek Anda.
deno
Deno terkadang memiliki masalah saat mem-parse tag @latest, tetapi kita dapat menentukan versi saat menginstal awalnya. Jika itu terjadi, Anda bisa mencoba mengubah tag @latest dengan versi, seperti @^1.3.1
deno install --global \
--allow-read --allow-write --allow-env --allow-sys=cpus,homedir --allow-net=edge.openspec.dev \
npm:@fission-ai/openspec@latest
# or
deno install --global \
--allow-read --allow-write --allow-env --allow-sys=cpus,homedir --allow-net=edge.openspec.dev \
npm:@fission-ai/openspec@^1.3.1Catatan: Jika subperintah Anda meluncurkan alat eksternal, seperti edit konfigurasi, umpan balik, atau buka workspace, Anda mungkin memerlukan --allow-run=<program> yang diskopkan.
bun
Bun dapat menginstal OpenSpec secara global, tetapi OpenSpec saat ini berjalan di Node.js. Anda masih membutuhkan Node.js 20.19.0 atau lebih tinggi yang tersedia di PATH.
bun add -g @fission-ai/openspec@latestNix
Jalankan OpenSpec langsung tanpa instalasi:
nix run github:Fission-AI/OpenSpec -- initAtau instal ke profil Anda:
nix profile install github:Fission-AI/OpenSpecAtau tambahkan ke lingkungan pengembangan Anda di flake.nix:
{
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
openspec.url = "github:Fission-AI/OpenSpec";
};
outputs = { nixpkgs, openspec, ... }: {
devShells.x86_64-linux.default = nixpkgs.legacyPackages.x86_64-linux.mkShell {
buildInputs = [ openspec.packages.x86_64-linux.default ];
};
};
}Verifikasi Instalasi
openspec --versionPembaruan
Tingkatkan paket, lalu segarkan file yang dihasilkan di setiap proyek:
npm install -g @fission-ai/openspec@latest # or pnpm/yarn/bun equivalent
openspec update # run inside each projectopenspec update menghasilkan ulang file skill dan command untuk alat yang telah Anda konfigurasikan, sehingga perintah slash Anda tetap terkini dengan versi yang terinstal. Ini juga memeriksa apakah CLI baru telah diterbitkan dan menawarkan untuk meningkatkan, karena peningkatan adalah apa yang membuat alur kerja baru tersedia sejak awal — lihat CLI Reference.
Penghapusan
Tidak ada perintah openspec uninstall, karena OpenSpec hanyalah paket global ditambah beberapa file di proyek Anda. Menghapusnya adalah beberapa langkah manual, dan tidak ada di sini yang menyentuh kode sumber Anda.
1. Hapus paket global:
npm uninstall -g @fission-ai/openspec # or: pnpm rm -g / yarn global remove / bun rm -g2. Hapus OpenSpec dari proyek (opsional). Hapus direktori openspec/ jika Anda tidak lagi menginginkan spesifikasi dan perubahan-nya:
rm -rf openspec/Pikirkan sebelum melakukan ini: openspec/specs/ dan openspec/changes/archive/ adalah catatan Anda tentang bagaimana sistem berperilaku dan mengapa berubah. Jika Anda mungkin ingin riwayat itu, simpan folder (atau simpan di git) bahkan setelah penghapusan.
3. Hapus file alat AI yang dihasilkan (opsional). OpenSpec menulis file skill dan command ke dalam direktori per-alat seperti .claude/skills/openspec-*/, .cursor/commands/opsx-*, dan seterusnya. Hapus skill openspec-* dan command opsx-* untuk alat mana pun yang telah Anda konfigurasikan. Jalur yang tepat per alat terdaftar di Supported Tools.
Jika Anda juga memiliki blok penanda OpenSpec di file seperti CLAUDE.md atau AGENTS.md, hapus blok-blok tersebut secara manual; konten Anda sendiri di file-file tersebut adalah milik Anda untuk disimpan.
Langkah Selanjutnya
Setelah menginstal, inisialisasi OpenSpec di proyek Anda:
cd your-project
openspec initLihat Getting Started untuk panduan lengkap.