CLI reference
Generated from the CLI's own argument parser; do not edit by hand. The CLI is not yet published to
PyPI. Supplied distributions include schemas, guides and sample worlds; installed use does not
need a repository checkout. Contributors can run it with uv run alive.
Exit codes: 0 success, 1 invalid document or request, 2 usage error, 3 API or network
error, 4 input or approval needed (an authoring session is waiting for answers).
--json may appear anywhere on the command line.
Success data is on stdout; progress is on stderr. Failures emit an error object in JSON mode.
See the agent workflow for recovery and sample worlds.
alive init
write a starter intakespec.json
alive init [-h] [--force] [directory]alive prompt
print a copyable prompt for your own AI assistant
alive prompt [-h] {intake,worldspec,convert-to-text}alive schema
print a published JSON Schema
alive schema [-h]
{intakespec,evaluation-plan,worldspec,resource-spec,run-manifest,finding,metric-summary,concept-review,business-assessment,operational-economics,tool-registry}alive intake validate
validate an IntakeSpec locally (free)
alive intake validate [-h] filealive intake from-file
draft an IntakeSpec from a document (hosted AI)
alive intake from-file [-h] --project PROJECT [--goal GOAL]
[--output OUTPUT]
filealive intake save
save a confirmed IntakeSpec to a project
alive intake save [-h] --project PROJECT
[--idempotency-key IDEMPOTENCY_KEY]
filealive author start
start an authoring session for a project
alive author start [-h] --project PROJECT --question QUESTION
[--mode {guided,auto_draft,expert}]
[--intake-revision INTAKE_REVISION]
[--ai {none,hosted,openai,anthropic,google}]
[--no-input]alive author show
show a session's current checkpoint
alive author show [-h] [--records] sessionalive author answer
answer the current questions (resumes any client's session)
alive author answer [-h] [--answers ANSWERS] [--set SET]
[--revision REVISION] [--relayed] [--no-input]
sessionalive author approve
approve the exact revision shown
alive author approve [-h] --revision REVISION sessionalive plan
plan evaluations for an IntakeSpec (local) or a project
alive plan [-h] [--project PROJECT] [file]alive models list
list catalog models
alive models list [-h]alive models show
show ports, parameters, constraints and a model card
alive models show [-h] refalive world validate
validate a WorldSpec locally (free)
alive world validate [-h] filealive world list
list bundled sample worlds
alive world list [-h]alive world pull
write a bundled sample world without network access
alive world pull [-h] [--output OUTPUT] [--force]
{consumer-app,rural-clinic,rural-clinic-economics,remote-monitoring}alive run
run a WorldSpec locally (free) or on Alive (--remote)
alive run [-h] (--world WORLD | --world-revision WORLD_REVISION)
[--output OUTPUT] [--remote] [--project PROJECT]
[--budget BUDGET] [--idempotency-key IDEMPOTENCY_KEY]
[--workers WORKERS]alive runs get
alive runs get [-h] run_idalive runs estimate
estimate an existing world revision without execution
alive runs estimate [-h] world_revisionalive runs cancel
cancel a run; an already-running calculation may finish
alive runs cancel [-h] run_idalive results export
download a run's ZIP export
alive results export [-h] [--output OUTPUT] run_idalive results get
read findings, metrics, assertions and assumptions
alive results get [-h] run_idalive experiments compare
read stored variant comparisons for one run
alive experiments compare [-h] run_idalive events list
read one page of events; follow next_offset explicitly
alive events list [-h] [--offset OFFSET] [--limit LIMIT]
[--variant VARIANT] [--replication REPLICATION]
[--event-type EVENT_TYPE]
run_idalive projects create
create an intervention project
alive projects create [-h] [--org ORG]
[--idempotency-key IDEMPOTENCY_KEY]
titlealive docs agents
print the customer agent entry guide
alive docs agents [-h]alive docs list
list bundled guides
alive docs list [-h]alive docs show
print one bundled Markdown guide
alive docs show [-h] pathalive doctor
inspect installed versions/resources; no secrets printed
alive doctor [-h] [--remote]alive context export
portable context manifest for another AI agent
alive context export [-h] projectalive login
store an API token
alive login [-h] [--token TOKEN] [--api-url API_URL]alive logout
forget the stored token
alive logout [-h]alive whoami
show the signed-in identity
alive whoami [-h]