The HAWI CLI
The same workspaces, agents, runs and approvals as the website, from a terminal, in plain words or commands.
The CLI is another way into the same HAWI as this site. It shows the same workspaces, agents, runs, approvals, connections and credits, and every request passes the same permission and approval checks on HAWI's servers. You never need it; it is there for people who prefer a terminal.
Signing in
Run hawi login
The terminal shows a short code and opens HAWI in your browser. Nothing secret is typed into the terminal.
Check the code and choose what it may do
The page names the terminal asking. You can grant View only, or add Operate and Approve.
Approve
The terminal keeps its session in the macOS Keychain or Linux keyring, or on Windows in a file only your account can read, and is ready.
| Permission | Lets the terminal |
|---|---|
| View | See workspaces, agents, runs, approvals, usage and connections. Always included. |
| Operate | Start, retry and cancel agent runs, and change an agent's control mode. |
| Approve | Approve or reject actions your agents are waiting on. |
A session lasts 30 days. Sign a terminal out with hawi logout, from another terminal with hawi sessions revoke, or from this site under Security, which lists every terminal signed in as you.
Asking in plain words
Run hawi on its own to start a session, then type what you want. Short questions such as "show my agents" or "what failed overnight?" run the matching command directly. Anything else goes to the HAWI assistant, which reads your real workspace data through the same checks.
Commands
| Command | What it does |
|---|---|
| hawi status | What is running and what needs you. |
| hawi agents | Create, inspect, switch on and run agents; change control mode. |
| hawi jobs | Runs: list, show, watch, cancel, retry. |
| hawi approvals | List, review one at a time, approve, reject. |
| hawi workspaces | List and switch workspaces. |
| hawi connectors | Connected services and their health. |
| hawi models | The model roster and what your plan includes. |
| hawi billing | Plan, credits and what is held for running work. |
| hawi sessions | Terminals signed in as you. |
| hawi mcp | Use HAWI from MCP apps. See the next page. |
| hawi doctor | Check setup, connection and terminal support. |
Agents and runs can be named instead of copied: hawi agents run Support "reply to today's tickets", or hawi jobs show 3f2a, where the start of an id is enough. Runs are cloud jobs: hawi jobs watch follows one, and Ctrl+C stops watching without stopping the run.
What opens the website
| Task | Why it opens the browser |
|---|---|
| Having a model draft an agent's instructions | The website's guided builder writes them for you. In the CLI you write them yourself with hawi agents create. |
| Connecting a service | The provider's own consent page has to run in a browser. |
| Paying, top-ups and invoices | Your bank may need to confirm the payment. Nothing is charged from the terminal. |
Scripting
hawi jobs list --status failed --json
hawi approvals approve 7c1e --yes
hawi agents run Support "summarise today's tickets" --workspace Acme- Exit codes
- 0 done, 1 failed, 2 usage, 3 sign-in needed, 4 not found, 5 not permitted, 69 HAWI unavailable, 75 network problem.
- HAWI_TOKEN
- Supplies a session token directly, for CI, instead of the credential store.
Accessibility
- --plain, or hawi config set plain true: no colour, artwork or animation, and a word for every status. Made for screen readers and logs.
- NO_COLOR is respected, and colour never carries meaning on its own.
- hawi config set motion reduced or none turns animation down or off.
- Everything is keyboard-driven; lists you choose from also accept a number.