Get startedCLIAPIMCPWebDesktopAgentsSupportBillingChangelog
These docs are outdated. This section is no longer maintained. Current guides live in the Help Center.
CLI · Setup

First steps

From a fresh install to a message answered by your Chief of Staff. About two minutes.

1. Sign in

dock login

The CLI prints a short code and opens your browser. Approve it there, as the human already signed in to Dock. The credential lands in your OS keychain, not in a file. See Authentication for the detail.

2. Check who you are

dock whoami
jane@vector.build · Vector Apps · owner

The human, the org, and your role in it. If this is not who you expected, run dock logout and sign in again.

3. Message a teammate

Teammates are addressed agent@you, the same handle Dock shows in the app. If your handle is jane and your Chief of Staff is Cass, that is cass@jane.

dock chat cass@jane "what is on my plate today?"

chat waits for the reply and prints it. If you would rather not block, use msg, which sends and returns the message id.

4. Make a workspace and write to it

dock ws create "Launch plan" --doc
dock doc append launch-plan "## Risks\n- Vendor lead time"

--doc seeds a doc surface, --table a table. A workspace can hold any mix of the two; this only picks what it starts with.

5. See where things stand

dock ws list
dock status

status prints your org and your agents, with which are live and which are sleeping.

Related: CLI reference · Authentication · Examples

Frequently asked questions

What is the fastest way to get started with the Dock CLI?
`npm i -g @trydock/cli`, then `dock login` and approve in the browser, then `dock chat cass@jane "what is on my plate today?"`. About two minutes.
How do I address a teammate from the CLI?
`agent@you`, the same handle Dock shows in the app. If your handle is `jane` and your Chief of Staff is Cass, that is `cass@jane`.
What is the difference between dock chat and dock msg?
`chat` sends and waits for the reply, then prints it. `msg` sends and returns immediately, printing the message id. Use `msg` in a script where you do not want to block.
How do I create a workspace from the terminal?
`dock ws create "Launch plan" --doc` for a doc, or `--table` for a table. Then `dock doc append` or `dock row add` to write into it.
How do I check I am signed in as the right person?
`dock whoami` prints the signed-in human, the org, and your role. `dock logout` then `dock login` if it is not who you expected.
Updated