Connect CLI reference
Run the standalone bridge for the paired Computer.
Use this page to inspect every public atoi connect command, its accepted flags, and one runnable example.
atoi connectRun the standalone bridge for the paired Computer.
#connect
Keep the paired Computer online for context, Tasks, and verification.
atoi connect [--code <code>] [--computer-token <token>] [--host-token <token>] [--convex-site-url <url>] [--computer-id <id>] [--host-id <id>] [--identity-source <source>] [--legacy-host-id <id>] [--platform <platform>] [--label <label>] [--cwd <path>] [--capabilities <list>] [--client-kind <app|cli>] [--once] [--poll-interval-ms <ms>] [--timeout-ms <ms>] [--dry-run]
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--code | string | Pair this computer with a code from Settings → Computers, shaped XXXX-XXXX and valid for ten minutes. | ||
--computer-token | string | Use a Computer token for this connection. | ||
--host-token | string | Use a host token with the compatibility spelling. | ||
--convex-site-url | string | Override the Atoi HTTP endpoint. | ||
--computer-id | string | Set an explicit Computer identity. | ||
--host-id | string | Set an explicit host identity with the compatibility spelling. | ||
--identity-source | string | Describe how the Computer identity was selected. | ||
--legacy-host-id | string | Supply the prior host identity for adoption. | ||
--platform | string | Override the reported platform. | ||
--label | string | Set the Computer label. | ||
--cwd | string | current directory | Set the working directory advertised to Atoi. | |
--capabilities | string | Advertise a comma-separated capability list. | ||
--client-kind | string | cli | app, cli | Identify an app or CLI bridge client. |
--once | boolean | Claim at most one unit of work and exit. | ||
--poll-interval-ms | number | 2000 | Wait this many milliseconds between polls. | |
--timeout-ms | number | 0 | Exit after this many milliseconds. Zero leaves the loop open. | |
--dry-run | boolean | Print the resolved connection plan without connecting. | ||
--json | boolean | false | Emit the canonical JSON envelope. | |
--ndjson | boolean | false | Emit one canonical JSON envelope per line. | |
--format | string | text | text, json | Choose human text or the JSON envelope. |
--help -h | boolean | Show command help. |
#Run connect
atoi connect --cwd . --once --json
Read Set up the CLI for the rest of this group, or the CLI reference index for every command.
Was this useful?