Installation
Install the PlanSpec CLI to validate and work with plan files.
Requirements
- macOS, Linux, or Windows
- For Cargo install: Rust 1.70+
Installation Methods
Cargo (Recommended)
If you have Rust installed, use Cargo for the simplest installation:
bash
cargo install planspec
To update to the latest version:
bash
cargo install planspec --force
GitHub Releases
Download pre-built binaries from GitHub Releases.
macOS (Apple Silicon)
bash
curl -L https://github.com/exponential-build/planspec/releases/latest/download/planspec-aarch64-apple-darwin.tar.gz | tar xz
sudo mv planspec /usr/local/bin/
macOS (Intel)
bash
curl -L https://github.com/exponential-build/planspec/releases/latest/download/planspec-x86_64-apple-darwin.tar.gz | tar xz
sudo mv planspec /usr/local/bin/
Linux
bash
curl -L https://github.com/exponential-build/planspec/releases/latest/download/planspec-x86_64-unknown-linux-gnu.tar.gz | tar xz
sudo mv planspec /usr/local/bin/
Build from Source
Clone and build the repository:
bash
git clone https://github.com/exponential-build/planspec.git
cd planspec
cargo build --release
The binary will be at target/release/planspec.
Verify Installation
Check that PlanSpec is installed correctly:
bash
planspec --version
Shell Completions
Generate shell completions for your shell:
bash
# Bash
planspec completions bash > ~/.local/share/bash-completion/completions/planspec
# Zsh
planspec completions zsh > ~/.zfunc/_planspec
# Fish
planspec completions fish > ~/.config/fish/completions/planspec.fish