Installation

Install the PlanSpec CLI to validate and work with plan files.

Requirements

  • macOS (Apple Silicon or Intel) or Linux (x64 or ARM64)
  • For building from source: Rust 1.70+

Installation Methods

GitHub Releases (Recommended)

Download pre-built binaries from GitHub Releases.

macOS (Apple Silicon)

bash
curl -fsSL https://github.com/exponential-build/planspec/releases/download/v0.1.0/planspec-darwin-aarch64.tar.gz | tar xz
sudo mv planspec /usr/local/bin/

macOS (Intel)

bash
curl -fsSL https://github.com/exponential-build/planspec/releases/download/v0.1.0/planspec-darwin-amd64.tar.gz | tar xz
sudo mv planspec /usr/local/bin/

Linux (x64)

bash
curl -fsSL https://github.com/exponential-build/planspec/releases/download/v0.1.0/planspec-linux-amd64.tar.gz | tar xz
sudo mv planspec /usr/local/bin/

Linux (ARM64)

bash
curl -fsSL https://github.com/exponential-build/planspec/releases/download/v0.1.0/planspec-linux-aarch64.tar.gz | tar xz
sudo mv planspec /usr/local/bin/

Check all releases for other versions.

Cargo

If you have Rust installed:

bash
cargo install planspec

To update to the latest version:

bash
cargo install planspec --force

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

Next Steps