Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.crewship.ai/llms.txt

Use this file to discover all available pages before exploring further.

Crewship CLI

The crewship command-line interface lets you manage agents, crews, missions, skills, credentials, and more from the terminal.
crewship [command] [flags]

Global Flags

Every command inherits these persistent flags:
FlagShortTypeDefaultDescription
--server-sstringhttp://localhost:8080Server URL. Also via CREWSHIP_SERVER env var.
--workspace-wstring(from config)Workspace ID or slug. Also via CREWSHIP_WORKSPACE env var.
--format-fstringtableOutput format: table, json, yaml, or quiet.
--verbose-vboolfalseVerbose output.
--no-colorboolfalseDisable ANSI colors.
In addition: CREWSHIP_DEFAULT_AGENT env var sets the default agent for crewship ask / crewship explain. Resolution order: command-line flag → env var → config key.

Authentication

crewship init

Initialize Crewship with the first admin user on a fresh database.
crewship init --email admin@crewship.ai --name "Pavel Srba"
This command only works on an empty database (no existing users). It creates an admin user with OWNER role and returns a CLI token.
FlagTypeDefaultDescription
--serverstringhttp://localhost:8080Crewship server URL.
--emailstring(required)Admin email address.
--namestring(required)Admin full name.
--passwordstring(prompted)Admin password (min 8 chars). Prompted interactively if omitted.

crewship login

Authenticate the CLI with a Crewship server.
# Interactive mode (email + password)
crewship login

# Token mode
crewship login --token <api-token>
FlagTypeDefaultDescription
--tokenstringAPI token for non-interactive login.
The token is saved to ~/.crewship/cli-config.yaml.

crewship logout

Remove the stored authentication token.
crewship logout

crewship whoami

Display the current user and workspace info.
crewship whoami
Outputs the user email, server URL, active workspace name, and user role.

Server

crewship start

Start the Crewship server.
crewship start
crewship start --config config.yaml --no-docker
FlagTypeDefaultDescription
--configstringPath to config file (YAML).
--dbstring~/.crewship/crewship.dbDatabase URL.
--no-dockerboolfalseStart without Docker (dashboard only, no agents).
A container runtime (Docker, Podman, Colima, OrbStack, Apple Containers) is required to run AI agents. Use --no-docker for dashboard-only mode.

Agent Execution

crewship run

Run an agent with a prompt and stream output to the terminal.
crewship run <agent-slug> [prompt]
crewship run viktor "Create a REST API"
crewship run viktor --prompt @task.txt
crewship run viktor --prompt @-                     # read prompt from stdin
cat error.log | crewship run viktor "what's wrong?" # auto-append stdin as context
crewship run viktor "review" --with-git-diff
crewship run viktor "explain" --with-file notes.md --with-file plan.md
crewship run viktor --interactive
crewship run viktor --chat <chatId> "follow-up question"
FlagShortTypeDefaultDescription
--prompt-pstringPrompt text, @file.txt, or @- for stdin.
--interactiveboolfalseInteractive chat mode (REPL).
--chatstringContinue an existing chat by chat ID.
--no-streamboolfalseWait for completion, show only the final result.
--quiet-qboolfalseOnly output text, suppress meta info.
--timeoutint0Timeout in seconds (0 = no timeout).
--with-git-diffboolfalseAppend git diff (working tree) as context.
--with-git-stagedboolfalseAppend git diff --staged as context.
--with-git-logboolfalseAppend last 20 commits as context.
--with-git-statusboolfalseAppend git status -s as context.
--with-file[]stringAppend file contents as context (repeatable).
--with-cmd[]stringAppend shell command output as context (repeatable).
--pasteboolfalseAppend system clipboard as context.
--savestringTee response to this path (atomic write, no ANSI).
--dry-runboolfalsePrint assembled prompt and exit without sending.
--estimateboolfalsePrint token count + cost estimate and exit.
--markdownboolauto on TTYForce markdown ANSI styling.
--no-markdownboolfalseDisable markdown ANSI styling.
In interactive mode, press Ctrl+C to cancel the current run. Press Ctrl+D to exit the session.Stdin is auto-detected when piped — git diff | crewship run viktor "review" works without an explicit flag. Piped data is appended after the positional prompt under a --- stdin --- separator. Each context block is capped at 64 KiB and labelled.

crewship run list

List recent runs across all agents. See also crewship history for a friendlier view with optional prompt previews.
crewship run list
Output columns: ID, AGENT, STATUS, TRIGGER, CREATED, FINISHED

crewship ask

Low-friction one-shot prompt against a default agent. Inherits the same --with-*, --save, --markdown, --dry-run, --estimate, and --paste flags as run. The agent is resolved from --agent flag → CREWSHIP_DEFAULT_AGENT env var → default-agent config key → interactive picker (TTY) → error. --agents <list> runs the same prompt against multiple agents in parallel.
crewship ask "what time is it?"
git diff | crewship ask "review this change"
crewship ask "summarize" --with-file notes.md
crewship ask --agent viktor "explain how the journal works"
crewship ask --prompt @-                              # full prompt from stdin

# One-time setup so future asks don't need --agent:
crewship config set default-agent viktor
Run crewship ask with no positional arg or default to launch a huh picker that lists every agent in the workspace. The picker offers to save the choice as the new default.

crewship retry

Re-run a previous run. Recovers the original first user prompt from the chat history and starts a new run on the same agent.
crewship retry r_abc                       # same agent, same prompt, NEW chat
crewship retry r_abc --continue            # append to the SAME chat
crewship retry r_abc --new-prompt "be more specific"
FlagTypeDefaultDescription
--new-promptstringOverride the original prompt.
--continueboolfalseAppend to the original chat instead of starting fresh.
--quietboolfalseOnly output text.
--no-streamboolfalseWait for completion, show only result.
--savestringTee the response to this path.

crewship copy-prompt

Recover the original prompt of a previous run without running anything. Pairs naturally with crewship retry --new-prompt for tweak-and-rerun loops.
crewship copy-prompt r_abc                  # to stdout
crewship copy-prompt r_abc --clipboard      # to system clipboard
crewship copy-prompt r_abc > prompt.txt

crewship explain

Summarize what happened in a run via the default agent. Fetches journal entries scoped to the run’s agent + start window and asks the agent for a 3-6 bullet summary.
crewship explain r_abc
crewship explain r_abc --agent reviewer
crewship explain r_abc --types error,keeper.decision,peer.escalation

crewship watch

Live-tail the Crew Journal. Top-level alias for journal --follow.
crewship watch
crewship watch --severity warn,error
crewship watch --crew backend-team

crewship inspect

Show a structured journal timeline of a run (no LLM, instant). Sibling of explain.
crewship inspect r_abc
crewship inspect r_abc --types error,exec.error,keeper.decision
crewship inspect r_abc --filter '.entries[] | select(.severity=="error")'
crewship inspect r_abc --watch 2s         # follow a running mission

crewship apply

Apply a YAML manifest describing a crew or workspace (agents + skills + credentials + sidecar services). Idempotent, plan-then-confirm, Terraform-style. See CLI → apply and Guides → Workspace Manifests.
crewship apply --file team.yaml --from-env       # convergent sync
crewship apply --file team.yaml --dry-run        # plan only
crewship apply --file team.yaml --strict         # fail if any resource exists

crewship export

Two distinct shapes:
# Manifest export — round-trip partner of apply
crewship export crew code-review > code-review.crew.yaml
crewship export workspace > acme.workspace.yaml

# Run export — bundle one run's chat + journal for post-mortems
crewship export r_abc                 # ./run-r_abc/{prompt,response,messages,journal,timeline}
crewship export r_abc --out /tmp/pm
See CLI → export for details.

crewship prompt

Local prompt library at ~/.crewship/prompts/<name>.md. Server-free.
crewship prompt save sec-review --content "Review this diff for security issues."
crewship prompt list
crewship prompt use sec-review | crewship ask
crewship prompt path sec-review
crewship prompt edit sec-review
crewship prompt delete sec-review

crewship open

Open a web UI deep-link in your default browser.
crewship open chat c_abc123
crewship open mission MIS-42
crewship open journal
crewship open --print-only mission MIS-42
Resources: dashboard, agents, agent <slug>, crews, crew <slug>, chat <id>, mission <id>, journal, approvals, paymaster, crows-nest.

crewship chat

Print the full message history of a chat session as a rendered transcript.
crewship chat c_abc123
crewship chat c_abc123 --no-markdown
crewship chat c_abc123 --since 24h

crewship agent files | inbox | git-log

Per-agent introspection beyond agent debug:
crewship agent files viktor                       # list agent's working dir
crewship agent files viktor --download report.md  # download
crewship agent inbox viktor                       # peer messages received
crewship agent git-log viktor                     # git log inside container

crewship triage | recurring | saved-view | mcp-calls | metrics

Thin surfaces over existing API endpoints — --filter for jq, --format json|yaml for scripts.
crewship triage list
crewship triage process
crewship recurring list
crewship saved-view list
crewship mcp-calls --limit 50
crewship metrics                       # mission summary
crewship metrics --series active_runs --range 24h

crewship lint | doctor --fix | config validate

Local hygiene:
crewship lint              # static-analyse config + prompt library
crewship lint --strict     # warnings also fail (CI-friendly)
crewship doctor --fix      # safe auto-repairs (creates missing data dir)
crewship config validate   # token + workspace + default-agent sanity

crewship logs

View agent logs.
crewship logs <agent-slug>
crewship logs viktor --follow
crewship logs viktor --lines 50
FlagShortTypeDefaultDescription
--lines-nint100Number of log lines to show.
--follow-FboolfalseStream logs in real-time via WebSocket.

Observability

crewship activity

View the cross-crew activity feed including assignments, peer conversations, and escalations.
crewship activity
crewship activity --crew backend-team
crewship activity --lines 20
FlagTypeDefaultDescription
--crewstringFilter by crew slug or ID.
--linesint50Number of activity entries.

crewship audit

View audit logs for the workspace.
crewship audit
crewship audit --action create
crewship audit --lines 100
FlagTypeDefaultDescription
--actionstringFilter by action: create, update, delete.
--linesint50Number of audit entries.

crewship cost

Single-screen spend summary: total, top spenders, per-crew rollup, active subscription plans.
crewship cost                # last 24h, top 5 spenders
crewship cost --range 7d
crewship cost --range 30d --limit 10
crewship cost --format json  # for scripts
FlagTypeDefaultDescription
--rangestring24hTime window (1h, 24h, 7d, 30d).
--limitint5Number of top spenders to show.
For per-crew or per-agent rollups in full fidelity, see crewship paymaster.

crewship recall

Free-text search across the Crew Journal. Renders matched entries as snippet cards with the search term highlighted.
crewship recall "auth migration"
crewship recall "rate limit" --since 30d --limit 30
crewship recall "keeper denied" --crew backend-team
crewship recall "deploy" --format json | jq '.[].summary'
FlagTypeDefaultDescription
--limitint20Max matches to return.
--sincestringTime window (1h, 24h, 7d, or RFC3339).
--crewstringFilter by crew slug or ID.
--agentstringFilter by agent ID.
Hits the /api/v1/journal?q= FTS5 endpoint. Server caps the query at 200 chars.

crewship history

Recent runs across the workspace with timestamp, agent, status, and trigger. Optional prompt preview per run.
crewship history
crewship history --limit 50
crewship history --since 7d --status failed
crewship history --prompts        # also fetch first user prompt per run
FlagTypeDefaultDescription
--limitint20Max runs to list.
--sincestring24hTime window (filtered client-side).
--statusstringFilter by status (running, completed, failed).
--agentstringFilter by agent slug or ID.
--promptsboolfalseFetch first user prompt per run (slower; one extra GET each).

Token Management

crewship token list

List all CLI tokens.
crewship token list
Output columns: ID, NAME, CREATED, LAST USED, STATUS

crewship token create

Create a new CLI token.
crewship token create [name]
The name argument defaults to "CLI token" if omitted.
The token value is displayed only once at creation time. Store it securely.

crewship token revoke

Revoke a CLI token.
crewship token revoke <token-id>

crewship token validate

Validate the current CLI token.
crewship token validate

Diagnostics

crewship version

Print version information including commit hash, build date, Go version, and OS/architecture.
crewship version

crewship doctor

Check system requirements and health: container runtime detection, data directory, and database status.
crewship doctor

crewship completion

Generate shell completion scripts.
crewship completion [bash|zsh|fish|powershell]
Bash:
source <(crewship completion bash)
# Persistent:
crewship completion bash > /etc/bash_completion.d/crewship
Zsh:
source <(crewship completion zsh)
# Persistent:
crewship completion zsh > "${fpath[1]}/_crewship"
Fish:
crewship completion fish | source
# Persistent:
crewship completion fish > ~/.config/fish/completions/crewship.fish

Seed Data

crewship seed

Seed demo data via the API. Creates a complete demo environment: admin user, workspace, crews, agents with system prompts, credentials, integrations, and sample issues.
crewship seed
crewship seed --nuke
crewship seed --skip-issues
FlagTypeDefaultDescription
--nukeboolfalseDelete all workspace contents before seeding.
--skip-issuesboolfalseSkip issue/project/label seeding.
--passwordstringpassword123Admin password for bootstrap.
On a fresh database, seed automatically bootstraps the first admin user. On an existing database, it requires authentication via crewship login.

Output Formats

All list and detail commands support --format (-f):
FormatDescription
tableHuman-readable table (default).
jsonJSON output, suitable for piping to jq.
yamlYAML output.
quietMinimal output (IDs only).
crewship agent list -f json | jq '.[].slug'

Other commands (run --help for details)

The list below covers top-level commands that ship in the binary but don’t yet have a dedicated page on this site. Most are stable; some are internal or experimental. Use crewship <command> --help for the full flag list while we work through expanding the per-command reference.
CommandPurposeNote
crewship adminOperate on the local DB directly when crewshipd is stopped (reset password, promote, list users)See the Admin CLI guide
crewship telemetryManage crash-reporting consent (on / off / status)See the Telemetry guide
crewship diffShow diff of agent’s working tree vs. the workspace seed
crewship escalationList, inspect, and resolve agent escalations recorded by the sidecar
crewship exposeOpen / close a port-forward from a running agent’s container to the hostSee Port-expose API
crewship integrationManage workspace integrations (Linear, GitHub App, Slack, …)See the Integrations guide
crewship mcpInspect, register, and remove MCP servers attached to an agentSee the MCP / multi-CLI guide
crewship milestoneCRUD milestones on the workspace’s issue tracker
crewship notifySend a one-off notification to the active operator (used by routines)
crewship pipelineLower-level surface for routines (routine is the user-facing name)See the Routines guide
crewship planRender a routine DAG without executing it (dry-run + cost estimate)
crewship projectManage projects inside the issue tracker
crewship recapPrint a human-readable recap of recent crew activity
crewship resumeResume a paused waitpoint or a failed run from a checkpoint
crewship sessionInspect and manage CLI sessions (mostly an internal surface)
crewship setupOne-shot guided setup for a fresh install (wraps init + login + first crew)
crewship shellDrop into a shell inside an agent’s container
crewship slashRun a saved slash-command shortcut against the default agent
crewship templateManage agent and crew templates
crewship tuiLaunch the interactive terminal UI
crewship waitBlock until a run, mission, or waitpoint reaches a terminal state
crewship workspaceList, switch, and manage workspacesTouched briefly in Authentication above
crewship me / today / nowQuick-action shortcuts that route a default-agent prompt with built-in context (me = bio, today = day plan, now = the moment)
Anything missing from this table that you reach for often is a docs bug — open an issue or PR.