DevelopersTerminal
Login CLI reference
Pair the local Computer with Atoi.
On this page
Use this page to inspect every public atoi login command, its accepted flags, and one runnable example. Return to the CLI reference index to choose another command group.
atoi loginPair the local Computer with Atoi.
#login
Pair this Computer with Atoi and store its host token securely.
atoi login [--host-token <token> | --stdin] [--non-interactive] [--convex-site-url <url>] [--computer-id <id>] [--host-id <id>] [--identity-source <source>] [--legacy-host-id <id>] [--platform <platform>] [--label <label>]
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--host-token | string | Use a host token instead of prompting. | ||
--stdin | boolean | Read the host token from stdin. | ||
--non-interactive | boolean | Return pairing instructions instead of prompting. | ||
--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. | ||
--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 login
printf "%s" "$ATOI_HOST_TOKEN" | atoi login --stdin --label "Studio Mac" --json
Was this useful?