Skip to content
DevelopersTerminal

Connect CLI reference


Run the standalone bridge for the paired Computer.

On this page

Use this page to inspect every public atoi connect command, its accepted flags, and one runnable example. Return to the CLI reference index to choose another command group.

atoi connectRun the standalone bridge for the paired Computer.

#connect

Keep the paired Computer online for context, Tasks, and verification.

atoi connect [--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]

FlagTypeDefaultValuesWhat it does
--computer-tokenstringUse a Computer token for this connection.
--host-tokenstringUse a host token with the compatibility spelling.
--convex-site-urlstringOverride the Atoi HTTP endpoint.
--computer-idstringSet an explicit Computer identity.
--host-idstringSet an explicit host identity with the compatibility spelling.
--identity-sourcestringDescribe how the Computer identity was selected.
--legacy-host-idstringSupply the prior host identity for adoption.
--platformstringOverride the reported platform.
--labelstringSet the Computer label.
--cwdstringcurrent directorySet the working directory advertised to Atoi.
--capabilitiesstringAdvertise a comma-separated capability list.
--client-kindstringcliapp, cliIdentify an app or CLI bridge client.
--oncebooleanClaim at most one unit of work and exit.
--poll-interval-msnumber2000Wait this many milliseconds between polls.
--timeout-msnumber0Exit after this many milliseconds. Zero leaves the loop open.
--dry-runbooleanPrint the resolved connection plan without connecting.
--jsonbooleanfalseEmit the canonical JSON envelope.
--ndjsonbooleanfalseEmit one canonical JSON envelope per line.
--formatstringtexttext, jsonChoose human text or the JSON envelope.
--help -hbooleanShow command help.

#Run connect

bash
atoi connect --cwd . --once --json

Was this useful?