Commands Reference

Complete reference for every CLI command. All commands support the global --format, --json, --llm, and --project flags.

Global flags

These flags can be used with any command:

Flag	Description
`--api-url string`	Override API URL
`--format string`	Output format: text, json, llm (default "text")
`--json`	Output as JSON (shorthand for --format json)
`--llm`	Output as compact markdown for LLMs (shorthand for --format llm)
`-p, --project string`	Project ID or name to use

AI credit confirmation

Commands that call Shipchart AI features use your AI credit balance. When run interactively, the CLI asks you to confirm before it starts the AI request and reminds you to check the website for information about how many credits the command may use.

For scripts and trusted workflows, add --credits to skip the confirmation prompt.

shipchart ai generate <roadmap-item-id> --credits

auth

shipchart auth login [flags]

Flag	Description
`--token`	Login by pasting an API token

auth logout

Remove the stored authentication token.

shipchart auth logout

auth status

Display the current authentication state and user info.

shipchart auth status

dashboard

Show portfolio dashboard. Aliases: dash

shipchart dashboard

status

Aggregated status overview across all projects, goals, delegations, and errors.

shipchart status

projects

List, view, and manage your projects. Aliases: project, p

projects list

List all projects.

shipchart projects list [flags]

Flag	Description
`--sort string`	Sort by: name, created_at, updated_at
`--stage string`	Filter by stage (planning, building, launched, growing, dormant, dead)

projects show

Show project details.

shipchart projects show [id-or-name]

projects create

Create a new project.

shipchart projects create [name] [flags]

Flag	Description
`--currency string`	Currency code (GBP, USD, EUR)
`--description string`	Short description
`--stage string`	Project stage
`--url string`	Project URL

projects update

Update a project.

shipchart projects update [id-or-name] [flags]

Flag	Description
`--description string`	Update description
`--name string`	Rename project
`--stage string`	Update stage
`--url string`	Update URL

projects delete

Delete (archive) a project.

shipchart projects delete [id-or-name] [flags]

Flag	Description
`--yes`	Skip confirmation prompt

roadmap

View and manage your roadmap across projects.

roadmap list

List roadmap items.

shipchart roadmap list [project] [flags]

Flag	Description
`--horizon string`	Filter by horizon (now, next, later)

roadmap show

Show roadmap item details.

shipchart roadmap show <id>

roadmap add

Add a roadmap item.

shipchart roadmap add [project] [flags]

Flag	Description
`--title string`	Item title (required)
`--description string`	Feature description
`--horizon string`	Horizon: now, next, later (default: now)
`--status string`	Status: planned, in_progress, done, dropped (default: planned)
`--quarter string`	Target quarter (e.g. 2026-Q2)
`--public`	Make publicly visible

roadmap update

Update a roadmap item.

shipchart roadmap update <id> [flags]

Flag	Description
`--title string`	Update title
`--description string`	Update description
`--horizon string`	Update horizon
`--status string`	Update status
`--quarter string`	Update target quarter
`--public / --no-public`	Toggle visibility

roadmap delete

Delete a roadmap item.

shipchart roadmap delete <id> [flags]

Flag	Description
`--yes`	Skip confirmation prompt

roadmap summary

Show roadmap summary.

shipchart roadmap summary [project]

work

List, create, update, delegate, and manage work units. A work unit can stand alone or be linked to a roadmap item. Aliases: w

work list

List work units. Scope to a project, a roadmap item, or all projects.

shipchart work list [project] [flags]

Flag	Description
`--all`	List across all projects
`--roadmap-item string`	Only work units linked to this roadmap item (project derived automatically)
`--standalone`	Only standalone work units (not linked to a roadmap item)
`--status string`	Filter by status: open, delegated, in_review, done, blocked
`--size string`	Filter by size: single_pass, multi_step, spike

work show

Show full detail of a work unit.

shipchart work show <id>

work create

Create a work unit. Interactive when --title is omitted.

shipchart work create [project] [flags]

Flag	Description
`--title string`	Work unit title
`--description string`	Work unit description
`--size string`	Size: single_pass, multi_step, spike
`--priority int`	Priority: 1=Urgent, 2=High, 3=Normal, 4=Low
`--roadmap-item string`	Link to a roadmap item (project derived automatically)
`--parent string`	Parent work unit ID (for nesting)

work update

Update a work unit.

shipchart work update <id> [flags]

Flag	Description
`--title string`	New title
`--description string`	New description (use "" to clear)
`--status string`	Status: open, delegated, in_review, done, blocked
`--size string`	Size: single_pass, multi_step, spike
`--priority int`	Priority: 1=Urgent, 2=High, 3=Normal, 4=Low
`--parent string`	Reparent under a different work unit
`--top-level`	Move to top level (clear parent)
`--roadmap-item string`	Link to a roadmap item

work done

Mark one or more work units as done.

shipchart work done <id>...

work delete

Delete a work unit.

shipchart work delete <id> [flags]

Flag	Description
`--yes`	Skip confirmation prompt

work reorder

Reorder work units within a project.

shipchart work reorder [project] [flags]

Flag	Description
`--order string`	New order as comma-separated ULIDs
`--tree string`	Full tree structure as JSON (id, parent_id, order)

work note

Add a human note to a work unit.

shipchart work note <id> <text>

work delegate

Delegate a work unit to an AI agent.

shipchart work delegate <id> [flags]

checkin

List, add, update, delete, and generate project check-ins. Aliases: checkins, ci

checkin list

List check-ins for a project.

shipchart checkin list [project] [flags]

Flag	Description
`--limit int`	Number of check-ins to show (max 50, default 10)

checkin add

Log a check-in. Body can be passed as an argument, piped via stdin, or written in $EDITOR.

shipchart checkin add [project] [body] [flags]

Flag	Description
`--mood string`	Mood: great, good, okay, struggling (default "okay")

checkin update

Update an existing check-in. Use --edit to open the current body in $EDITOR.

shipchart checkin update <checkin-id> [flags]

Flag	Description
`--body string`	New check-in body text
`--mood string`	New mood: great, good, okay, struggling
`--date string`	New date (YYYY-MM-DD)
`--edit`	Open current body in $EDITOR

checkin delete

Permanently delete a check-in.

shipchart checkin delete <checkin-id> [flags]

Flag	Description
`--yes`	Skip confirmation prompt

checkin generate

Uses AI to draft a check-in based on recent development activity.

shipchart checkin generate [project] [flags]

Flag	Description
`--save`	Auto-save without prompting
`--credits`	Confirm the command may use AI credits and skip the interactive credit prompt

revenue

List, add, update, and delete revenue entries for projects. Aliases: rev

revenue list

List revenue entries.

shipchart revenue list [project]

revenue add

Add a revenue entry.

shipchart revenue add [project] <amount> [flags]

Flag	Description
`--type string`	Revenue type: mrr, one_time (default "mrr")
`--period string`	Period (YYYY-MM, default: current month)
`--note string`	Optional note

revenue update

Update a revenue entry.

shipchart revenue update [project] <entry-id> <amount> [flags]

Flag	Description
`--note string`	Update note

revenue delete

Delete a revenue entry.

shipchart revenue delete [project] <entry-id> [flags]

Flag	Description
`--yes`	Skip confirmation

expenses

List, add, update, and delete expenses. Aliases: expense

expenses list

List expenses.

shipchart expenses list [flags]

Flag	Description
`--include-ended`	Include ended expenses

expenses add

Add an expense.

shipchart expenses add <name> <amount> [flags]

Flag	Description
`--frequency string`	Frequency: monthly, yearly, one_time (required)
`--category string`	Category: hosting, domain, tools, marketing, design, other
`--notes string`	Notes

expenses update

Update an expense.

shipchart expenses update <expense-id> [flags]

Flag	Description
`--name string`	Update name
`--amount float`	Update amount
`--frequency string`	Update frequency
`--category string`	Update category
`--notes string`	Update notes

expenses delete

Delete an expense.

shipchart expenses delete <expense-id> [flags]

Flag	Description
`--yes`	Skip confirmation

goals

List, add, update, and track progress on goals. Aliases: goal

goals list

List goals.

shipchart goals list [flags]

Flag	Description
`--status string`	Filter by status (active, achieved, missed, abandoned)

goals add

Create a goal.

shipchart goals add <title> [flags]

Flag	Description
`--description string`	Goal description
`--target float`	Target value
`--metric string`	Auto-track metric (total_revenue, customers, etc.)
`--quarter string`	Period type: monthly, quarterly, yearly
`--target-date string`	Specific deadline (YYYY-MM-DD)

goals update

Update a goal.

shipchart goals update <goal-id> [flags]

Flag	Description
`--title string`	Update title
`--description string`	Update description
`--target float`	Update target value
`--status string`	Update status: active, achieved, abandoned

goals progress

Update goal progress.

shipchart goals progress <goal-id> [flags]

Flag	Description
`--value float`	New current value

goals portfolio

Show portfolio-level goals.

shipchart goals portfolio

ideas

List, add, update, delete, and promote ideas. Aliases: idea

ideas list

List all ideas.

shipchart ideas list [flags]

Flag	Description
`--sort string`	Sort by: computed_score, created_at, excitement

ideas add

Add a new idea.

shipchart ideas add <name> [flags]

Flag	Description
`--description string`	Idea description
`--excitement int`	Excitement score (1-5)
`--difficulty int`	Difficulty score (1-5)
`--market-size int`	Market size score (1-5)

ideas update

Update an idea.

shipchart ideas update <id-or-name> [flags]

Flag	Description
`--name string`	Update name
`--description string`	Update description
`--excitement int`	Update excitement (1-5)
`--difficulty int`	Update difficulty (1-5)
`--market-size int`	Update market size (1-5)

ideas delete

Delete (archive) an idea.

shipchart ideas delete <id-or-name> [flags]

Flag	Description
`--yes`	Skip confirmation prompt

ideas destroy

Permanently delete an idea (cannot be undone).

shipchart ideas destroy <id-or-name> [flags]

Flag	Description
`--yes`	Skip confirmation prompt

ideas promote

Promote an idea to a project.

shipchart ideas promote <id-or-name> [flags]

Flag	Description
`--yes`	Skip confirmation prompt

analytics

Trends, comparisons, contributions, and leaderboards across your projects.

analytics trends

Show revenue trends.

shipchart analytics trends [project] [flags]

Flag	Description
`--months int`	Lookback period (max 24, default 12)

analytics compare

Compare revenue between two periods.

shipchart analytics compare [project] [flags]

Flag	Description
`--period-a string`	First period (YYYY-MM, YYYY-QN, YYYY-HN, YYYY)
`--period-b string`	Second period

analytics contributions

Show per-project revenue contributions.

shipchart analytics contributions

analytics leaderboard

Rank projects by monthly revenue.

shipchart analytics leaderboard

analytics export

Produce a shareable text summary of portfolio analytics.

shipchart analytics export [flags]

Flag	Description
`--period string`	Period (YYYY-MM, default: current month)

financials

Show financial summary. Aliases: fin, financial

shipchart financials [flags]

Flag	Description
`--month string`	Month (YYYY-MM, default: current)

forecast

Revenue forecasting.

forecast scenario

Run a forecast with custom parameters and compare against the base forecast.

shipchart forecast scenario [flags]

Flag	Description
`--months int`	Number of months to forecast (default 12)
`--growth-rate float`	Growth rate percentage
`--churn-rate float`	Churn rate percentage

delegate

Dispatch coding tasks to AI agent runners and monitor their progress. Aliases: del

delegate run

Delegate a task to an AI agent.

shipchart delegate run [project] [flags]

Flag	Description
`--title string`	Task title
`--description string`	Task description / instructions
`--runner string`	Runner: copilot, codex, claude_code, shipchart
`--environment string`	Runner environment (Shipchart Runner only)
`--source-issue string`	Link to existing issue ID
`--source-type string`	Source issue type: linear, github

delegate list

List delegations for a project.

shipchart delegate list [project] [flags]

Flag	Description
`--status string`	Filter by status: working, completed, failed, cancelled
`--runner string`	Filter by runner: copilot, codex, claude_code, shipchart
`--limit int`	Number of results (default 10)

delegate show

Show delegation details.

shipchart delegate show <delegation-id>

delegate watch

Watch a delegation until it completes.

shipchart delegate watch <delegation-id> [flags]

Flag	Description
`--interval int`	Poll interval in seconds (default 5)
`--timeout int`	Timeout in seconds (default 600)

delegate cancel

Cancel a queued delegation (blocked or pending).

shipchart delegate cancel <delegation-id> [flags]

Flag	Description
`--yes`	Skip confirmation prompt
`--dependent-action relink\|cascade`	Required when dependents exist: relink keeps downstream tasks queued, cascade cancels queued dependents.

delegate runners

List available agent runners.

shipchart delegate runners

issues

List, create, and manage issues from your connected tracker (Linear, GitHub). Aliases: issue, i

issues list

List issues for a project.

shipchart issues list [project] [flags]

Flag	Description
`--status string`	Filter by status (open, closed, all, backlog, current_iteration)
`--assignee string`	Filter by assignee
`--label string`	Filter by label
`--limit int`	Maximum number of issues (default 20)

issues create

Create a new issue.

shipchart issues create [project] [flags]

Flag	Description
`--title string`	Issue title
`--description string`	Issue description

issues assign

Assign an issue to a team member.

shipchart issues assign [project] <issue-id> [flags]

Flag	Description
`--to string`	Name of the assignee (required)

issues members

List team members for a project.

shipchart issues members [project]

errors

View and manage error monitoring from Sentry. Aliases: error, err

errors show

Show error summary for a project.

shipchart errors show [project]

errors summary

Show cross-project error summary.

shipchart errors summary

errors browse

Browse error issues.

shipchart errors browse [project] [flags]

Flag	Description
`--page int`	Page number (default 1)
`--per-page int`	Issues per page (default 20)

errors cleanup

Get AI suggestion for fixing an error.

shipchart errors cleanup [project] [flags]

Flag	Description
`--title string`	Error title to analyze (required)
`--level string`	Error level (error, warning, info)
`--count int`	Number of occurrences
`--create`	Auto-create issue without prompting
`--credits`	Confirm the command may use AI credits and skip the interactive credit prompt

errors refresh

Refresh error data from Sentry.

shipchart errors refresh [project]

code

View code repository details, open PRs, and recent activity from GitHub.

code show

Show code repository summary.

shipchart code show [project]

code details

Show detailed repository info.

shipchart code details [project]

code refresh

Refresh repo data from GitHub.

shipchart code refresh [project]

dev

Development activity and summaries.

dev summary

Show cross-project development activity summary.

shipchart dev summary

context

View, update, and export project context for LLM consumption. Aliases: ctx

context show

Show project context fields.

shipchart context show [project]

context update

Update project context fields.

shipchart context update [project] [flags]

Flag	Description
`--brief string`	Project brief
`--audience string`	Target audience
`--tech-stack string`	Tech stack (comma-separated)
`--features string`	Key features
`--architecture string`	Architecture description
`--conventions string`	Coding conventions
`--limitations string`	Known limitations

context export

Generates an LLM-optimized markdown context summary.

shipchart context export [project] [flags]

Flag	Description
`--size string`	Context size: s (small), m (medium), l (large) (default "m")

context pull

Pull project instructions as AGENTS.md for coding agents.

shipchart context pull [project]

context sync-readme

Sync context from GitHub README.

shipchart context sync-readme [project]

ai

Think, challenge, generate work items, and more using AI.

ai think

Think through an idea with AI.

shipchart ai think [project] [flags]

Flag	Description
`--text string`	The text to think about
`--mode string`	Advisor mode: product, technical, balanced (default "balanced")
`--previous-text string`	Previous text version to avoid spending credits on tiny changes
`--existing-item string`	Existing insight to avoid repeating (repeatable)
`--credits`	Confirm the command may use AI credits and skip the interactive credit prompt

ai generate

Generate work items for a roadmap item.

shipchart ai generate <roadmap-item-id> [flags]

Flag	Description
`--save`	Auto-save without prompting
`--ask-questions`	Ask clarifying questions before generating work items
`--answer string`	Clarification answer as question=answer (repeatable)
`--credits`	Confirm the command may use AI credits and skip the interactive credit prompt

ai challenge

Challenge a roadmap item's plan or a work unit.

shipchart ai challenge <roadmap-item-id|work-unit-id> [flags]

Flag	Description
`--work-unit`	Treat the ID as a work unit ID instead of a roadmap item ID
`--credits`	Confirm the command may use AI credits and skip the interactive credit prompt

ai review

Review a roadmap item for completeness with AI.

shipchart ai review <roadmap-item-id> [flags]

Flag	Description
`--save-all`	Add all suggestions without prompting
`--credits`	Confirm the command may use AI credits and skip the interactive credit prompt

ai expand

Expand a work item into sub-items with AI.

shipchart ai expand <work-item-id> [flags]

Flag	Description
`--save`	Auto-save without prompting
`--credits`	Confirm the command may use AI credits and skip the interactive credit prompt

ai write

Generate a work item description with AI.

shipchart ai write <work-item-id> [flags]

Flag	Description
`--save`	Auto-save without prompting
`--credits`	Confirm the command may use AI credits and skip the interactive credit prompt

ai names

Generate name suggestions for a project.

shipchart ai names [project] [flags]

Flag	Description
`--mode string`	Generation mode: quick or extended (default "quick")
`--platform string`	Platform type: auto, web_app, mobile_app, cli_tool, saas, library
`--style string`	Name style: any, clean_modern, playful, technical, descriptive
`--notes string`	Additional naming preferences or constraints
`--credits`	Confirm the command may use AI credits and skip the interactive credit prompt

ai-agents

Create, configure, and manage your AI advisory agents.

ai-agents list

List AI agents.

shipchart ai-agents list [flags]

Flag	Description
`--active-only`	Show only active agents

ai-agents show

Show AI agent details.

shipchart ai-agents show <id-or-name>

ai-agents create

Create a new AI agent.

shipchart ai-agents create <name> [flags]

Flag	Description
`--role string`	Role description for the agent
`--instructions string`	Custom instructions
`--template string`	Template slug to base agent on
`--active`	Set agent as active (default true)

ai-agents update

Update an AI agent.

shipchart ai-agents update <id-or-name> [flags]

Flag	Description
`--name string`	Rename agent
`--role string`	Update role description
`--instructions string`	Update custom instructions

ai-agents delete

Delete an AI agent.

shipchart ai-agents delete <id-or-name> [flags]

Flag	Description
`--yes`	Skip confirmation prompt

ai-agents toggle

Toggle an AI agent active/inactive.

shipchart ai-agents toggle <id-or-name>

ai-agents templates

List available agent templates.

shipchart ai-agents templates

ai-agents prompt

Get the system prompt for an AI agent.

shipchart ai-agents prompt <id-or-name>

metrics

Record, list, and manage metrics for your projects. Supports both built-in metrics (customers, signups, etc.) and custom metrics you define.

metrics list

List all metrics with latest values.

shipchart metrics list [project]

metrics record

Record a value for a metric.

shipchart metrics record [project] <metric> [flags]

Flag	Description
`--value float`	Metric value (required)
`--period string`	Period (YYYY-MM, defaults to current month)

metrics define

Create or update a custom metric definition.

shipchart metrics define [project] [flags]

metrics history

Show value history for a metric.

shipchart metrics history [project] <metric>

metrics delete

Delete a custom metric and all its values.

shipchart metrics delete [project] <metric>

integrations

Manage connected integrations.

integrations list

List connected integrations.

shipchart integrations list

integrations show

Show integration details.

shipchart integrations show <id>

integrations sync

Trigger a sync for an integration.

shipchart integrations sync <id-or-provider>

integrations sync-all

Sync all connected integrations.

shipchart integrations sync-all

exchange-rates

View exchange rates and convert currencies. Aliases: fx

exchange-rates list

List exchange rates.

shipchart exchange-rates list

exchange-rates convert

Convert between currencies.

shipchart exchange-rates convert [<amount> <from> <to>] [flags]

Flag	Description
`--amount float`	Amount to convert
`--from string`	Source currency code (e.g. USD)
`--to string`	Target currency code (e.g. GBP)

credentials

Store and manage credentials for Shipchart Runner (e.g. Codex API keys). Aliases: creds

credentials list

List configured credentials.

shipchart credentials list

credentials add

Add runner credentials.

shipchart credentials add [flags]

Flag	Description
`--provider string`	Credential provider (e.g. codex)

credentials delete

Delete runner credentials.

shipchart credentials delete <id> [flags]

Flag	Description
`--yes`	Skip confirmation prompt

init

Link this directory to a Shipchart project.

shipchart init [flags]

Flag	Description
`-p, --project string`	Project ID or name to link
`--force`	Overwrite existing .shipchart.yml

open

Open Shipchart pages in your default browser.

shipchart open [page] [flags]

Flag	Description
`--print`	Print the URL instead of opening in browser

skills

Pull and manage AI Team Members as Claude Code skills. Aliases: skill

skills list

List available AI Team Members.

shipchart skills list [project]

skills pull

Pull AI Team Members as Claude Code skills.

shipchart skills pull [project]

worker

Start a local task runner that polls for delegated tasks and executes them using AI coding agents.

shipchart worker [project] [flags]

Flag	Description
`--agent string`	Agent to use: auto (detect all), codex, claude, or gemini (default "auto")
`--name string`	Custom worker name (default: hostname)
`--max-concurrent int`	Maximum concurrent tasks (default 3)
`--poll-interval int`	Polling frequency in seconds (default 5)
`--verbose`	Print detailed worker debug logs

whoami

Show current authenticated user. Alias for auth status.

shipchart whoami

llm

Print a concise, token-friendly CLI reference for AI agents. Outputs all commands and key concepts as markdown.

shipchart llm

version

Show CLI version.

shipchart version

Output Formats

Text, JSON, and LLM output modes

Shell Completions

Tab completion for bash, zsh, and fish