Skip to content

Login CLI reference


Pair the local Computer with Atoi.

Use this page to inspect every public atoi login command, its accepted flags, and one runnable example.

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>]

FlagTypeDefaultValuesWhat it does
--host-tokenstringUse a host token instead of prompting.
--stdinbooleanRead the host token from stdin.
--non-interactivebooleanReturn pairing instructions instead of prompting.
--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.
--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 login

bash
printf "%s" "$ATOI_HOST_TOKEN" | atoi login --stdin --label "Studio Mac" --json

Read Set up the CLI for the rest of this group, or the CLI reference index for every command.

Was this useful?