# CLI

The `volae` command calls the same actions as the API, with your access token. Every command takes `--json` for machine-readable output and `--help` for its options (generated from the action's input schema).

The CLI package will be published to npm at launch.

## Sign in

Create an access token in **Settings → Access tokens**, then:

```bash
volae login --token vol_…
volae status
```

`VOLAE_TOKEN` and `VOLAE_API_URL` override the saved login (useful in CI). `volae logout` forgets the saved token.

## Commands

| Command | Action | What it does |
|---|---|---|
| `volae actions` | `list_actions` | List actions |
| `volae billing status` | `get_billing` | Credits & plan |
| `volae billing usage` | `get_credit_usage` | Credit usage |
| `volae business` | `get_business_metrics` | Business metrics |
| `volae changelog list` | `list_changelog` | List changelog |
| `volae commits list` | `list_changes` | Activity |
| `volae commits redo <id>` | `redo_change` | Redo |
| `volae commits undo <id>` | `undo_change` | Undo |
| `volae community people` | `find_community_people` | Find community people |
| `volae companies list` | `list_companies` | List companies |
| `volae content get <id>` | `get_content` | Get content |
| `volae content list` | `list_content` | List content |
| `volae decisions list` | `list_decisions` | List decisions |
| `volae events track <product> <name>` | `track_event` | Track an event |
| `volae export git` | `export_changes_git` | Export commits to git |
| `volae feedback list` | `list_public_feedback` | List public feedback |
| `volae files all` | `list_files` | List files |
| `volae files get <id> <version>` | `get_file` | Get a file |
| `volae files list <path>` | `list_path` | List files |
| `volae files read <path>` | `read_path` | Read a file |
| `volae files update <id>` | `update_file` | Rename or archive a file |
| `volae files write <path>` | `write_path` | Write a file |
| `volae findings list` | `list_findings` | List findings |
| `volae findings open <product> <title>` | `open_finding` | Open a finding |
| `volae findings update <id> <status>` | `update_finding` | Update a finding |
| `volae geo history <product>` | `get_geo_history` | History of a tracked question |
| `volae goals create <title>` | `set_goal` | Set a goal |
| `volae goals get <id>` | `get_goal` | Get a goal |
| `volae goals list` | `list_goals` | List goals |
| `volae goals pause <id>` | `pause_goal` | Pause a goal |
| `volae goals plan <goal>` | `get_goal_plan` | Get a goal's plan |
| `volae goals resume <id>` | `resume_goal` | Resume a goal |
| `volae goals update <id>` | `update_goal` | Update a goal |
| `volae inbox get <id>` | `get_conversation` | Get conversation |
| `volae inbox list` | `list_conversations` | List conversations |
| `volae industry check` | `check_compliance` | Check compliance |
| `volae industry records <kind>` | `get_industry_records` | Get industry records |
| `volae industry search <query>` | `search_industry` | Search industry data |
| `volae knowledge list <product>` | `list_knowledge` | List knowledge |
| `volae knowledge search <product> <query>` | `search_knowledge` | Search knowledge |
| `volae knowledge write <product>` | `propose_knowledge` | Write knowledge |
| `volae ledger list` | `list_ledger` | Change ledger |
| `volae lookup get <id>` | `get_lookup` | Get lookup |
| `volae lookup investigate <question>` | `start_investigation` | Start an investigation |
| `volae lookup list` | `list_lookups` | List lookups |
| `volae lookup open <input>` | `lookup_open` | Open a lookup |
| `volae lookup start <input>` | `lookup_start` | Start a lookup |
| `volae memory delete <product> <key>` | `delete_product_memory` | Delete product memory |
| `volae memory get <product>` | `get_product_memory` | Get product memory |
| `volae memory list` | `list_memories` | List memories |
| `volae memory recall <query>` | `recall` | Recall |
| `volae memory set <product> <key> <content>` | `update_product_memory` | Update product memory |
| `volae missions list` | `list_missions` | List missions |
| `volae missions show <id>` | `get_mission` | Get a mission |
| `volae missions start <section> <template>` | `start_mission` | Start a mission |
| `volae missions tab <mission> <tab>` | `get_mission_tab` | Read one tab of a mission |
| `volae overview <product>` | `get_overview` | Product overview |
| `volae people get <person>` | `get_person_context` | Get person context |
| `volae people search <query>` | `search_people` | Search people |
| `volae people unmerge <merge>` | `unmerge_people` | Undo a merge |
| `volae people update <person>` | `update_person` | Update person |
| `volae preferences list` | `list_preferences` | List preferences |
| `volae preferences set <scope> <key> <value>` | `set_preference` | Set a preference |
| `volae products create <name>` | `create_product` | Create product |
| `volae products list` | `list_products` | List products |
| `volae products update <product>` | `update_product` | Update product |
| `volae profile blocks <product>` | `get_profile_blocks` | Get profile blocks |
| `volae profile compare <product>` | `get_world_compare` | Compare the profile with the world |
| `volae profile source <id>` | `get_block_source` | Where a line came from |
| `volae profile update <id>` | `update_block` | Update a block |
| `volae proposals approve <id>` | `approve_proposal` | Approve proposal |
| `volae proposals from-problem <product>` | `propose_world_fix` | Turn a problem into a proposal |
| `volae proposals get <id>` | `get_proposal` | Get proposal |
| `volae proposals list` | `list_proposals` | List proposals |
| `volae proposals propose <kind>` | `propose_publish` | Propose publishing |
| `volae proposals reject <id>` | `reject_proposal` | Reject proposal |
| `volae proposals send-back <id> <note>` | `send_back_proposal` | Send a proposal back |
| `volae proposals submit <id>` | `submit_proposal` | Submit a proposal for checks |
| `volae proposals undo <id>` | `undo_proposal` | Undo a published proposal |
| `volae query <sql>` | `query` | Query (read-only SQL) |
| `volae records` | `list_run_records` | Records by run |
| `volae schedules list` | `list_schedules` | Schedules |
| `volae schema` | `get_schema` | Get schema |
| `volae sections list` | `list_sections` | Sections |
| `volae sections manage <section>` | `set_section_managed` | Let the coworker run a section |
| `volae sections set <section> <item>` | `set_section_prefs` | Change a section setting |
| `volae sections show <section>` | `get_section_overview` | Section overview |
| `volae segments list` | `list_segments` | List segments |
| `volae social check <text>` | `check_social_draft` | Check a social draft |
| `volae social list` | `list_social_posts` | List social posts |
| `volae social simulation <id>` | `get_simulation` | Get a simulation |
| `volae social simulations` | `list_simulations` | List simulations |
| `volae source-events get <id>` | `get_source_event` | Read a source event |
| `volae source-events list` | `list_source_events` | List source events |
| `volae sources get <connection>` | `get_connection` | Get data source |
| `volae sources list` | `list_connections` | List data sources |
| `volae sources query <id>` | `query_custom_source` | Query a custom data source |
| `volae sources sync <connection>` | `sync_connection` | Sync now |
| `volae stages check <stage>` | `request_stage_check` | Request a stage check |
| `volae stages result <stage>` | `get_stage_check` | Read a stage check |
| `volae standup` | `get_standup` | Today's standup |
| `volae themes get <id>` | `get_theme` | Get theme |
| `volae themes list` | `list_themes` | List themes |
| `volae today` | `get_today` | Today's brief |
| `volae works archive <id>` | `archive_work` | Archive a work |
| `volae works continue <id>` | `continue_work` | Continue a work |
| `volae works finish <id>` | `finish_work` | Finish a work |
| `volae works get <id>` | `get_work` | Get a work |
| `volae works list` | `list_works` | List works |
| `volae works pause <id>` | `pause_work` | Pause a work |
| `volae works resume <id>` | `resume_work` | Resume a work |
| `volae works start <prompt>` | `create_work` | Start a work |
| `volae works unarchive <id>` | `unarchive_work` | Unarchive a work |
| `volae works update <id>` | `update_work` | Update a work |

Actions that only make sense in the web app (access tokens, agent permissions, billing changes) have no command.

## Export to git

`volae export git > repo.fi` writes the commit log as a git fast-import stream, following every page. See [Commits, proposals, goals and works](workbench.md#export-commits-to-git) for how to import it and what it leaves out.

`volae changes` is another name for `volae commits`.