CLI

Why use the CLI?

• Stay in flow — log check-ins, update roadmaps, and review your dashboard without switching windows.
• Script and automate — pipe JSON output to jq, build shell aliases, or integrate with CI.
• Feed your AI — use --llm output mode to give LLM agents structured context about your projects.
• Delegate to agents — dispatch coding tasks to Codex, Claude Code, or Copilot directly from the terminal.

Installation

Homebrew (macOS / Linux)

brew tap shipchart/tap
brew install shipchart

Go install

go install github.com/shipchart/cli@latest

Download binary

Download the latest release for your platform from the GitHub Releases page. Extract and move the binary to a directory in your PATH:

# macOS (Apple Silicon)
curl -L https://github.com/shipchart/cli/releases/latest/download/shipchart_darwin_arm64.tar.gz | tar xz
sudo mv shipchart /usr/local/bin/

# Linux (amd64)
curl -L https://github.com/shipchart/cli/releases/latest/download/shipchart_linux_amd64.tar.gz | tar xz
sudo mv shipchart /usr/local/bin/

Build from source

git clone https://github.com/shipchart/cli.git
cd cli
go build -o shipchart .
sudo mv shipchart /usr/local/bin/

Verify the installation:

shipchart version

Quick start

1. 1. Authenticate

   shipchart auth login

   This opens a browser-based Device Flow. Approve the request and you're logged in.

2. 2. View your dashboard

   shipchart dashboard

3. 3. Link a project directory

   cd ~/projects/my-saas
   shipchart init

   This creates a .shipchart.yml file that links the directory to your Shipchart project.

4. 4. Explore

   shipchart projects list
   shipchart roadmap list
   shipchart checkin list