Skip to content

installation.md

Latest commit

 

History

History
82 lines (56 loc) · 1.32 KB

installation.md

File metadata and controls

82 lines (56 loc) · 1.32 KB
Raw

Installation

Prerequisites

  • Node.js 20.19.0 or higher — Check your version: node --version

Package Managers

npm

npm install -g @ww-ai-lab/openspec@latest

pnpm

pnpm add -g @ww-ai-lab/openspec@latest

yarn

yarn global add @ww-ai-lab/openspec@latest

bun

Bun can install OpenSpec globally, but OpenSpec currently runs on Node.js. You still need Node.js 20.19.0 or higher available on PATH.

bun add -g @ww-ai-lab/openspec@latest

Nix

Run OpenSpec directly without installation:

nix run github:WW-AI-Lab/OpenSpec -- init

Or install to your profile:

nix profile install github:WW-AI-Lab/OpenSpec

Or add to your development environment in flake.nix:

{
  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
    openspec.url = "github:WW-AI-Lab/OpenSpec";
  };

  outputs = { nixpkgs, openspec, ... }: {
    devShells.x86_64-linux.default = nixpkgs.legacyPackages.x86_64-linux.mkShell {
      buildInputs = [ openspec.packages.x86_64-linux.default ];
    };
  };
}

Verify Installation

openspec --version

Next Steps

After installing, initialize OpenSpec in your project:

cd your-project
openspec init

See Getting Started for a full walkthrough.