DevelopersTerminal
Settings CLI reference
List, inspect, and change settings through the shared registry contract.
On this page
Use this page to inspect every public atoi settings command, its accepted flags, and one runnable example. Return to the CLI reference index to choose another command group.
atoi settingsList, inspect, and change settings through the shared registry contract.
| Command | What it does |
|---|---|
atoi settings list | List settings from the shared registry. |
atoi settings get | Read one setting from its account or device tier. |
atoi settings set | Set a registry entry that is marked scriptable. |
atoi settings schema | Read the full registry schema or one setting definition. |
#settings list
List settings from the shared registry.
atoi settings list [--client <client>] [--tier <tier>] [--scriptable]
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--client | string | web, ios, macos, tui, cli | Filter by client surface. | |
--tier | string | account, device | Filter by storage tier. | |
--scriptable | boolean | Return only settings that the CLI may change. | ||
--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 settings list
atoi settings list --client cli --scriptable --json
#settings get
Read one setting from its account or device tier.
atoi settings get <key> [--convex-site-url <url>]
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--convex-site-url | string | Override the Atoi HTTP endpoint for account settings. | ||
--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 settings get
atoi settings get appearance.theme --json
#settings set
Set a registry entry that is marked scriptable.
atoi settings set <key> <value> [--convex-site-url <url>]
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--convex-site-url | string | Override the Atoi HTTP endpoint for account settings. | ||
--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 settings set
atoi settings set appearance.theme system --json
#settings schema
Read the full registry schema or one setting definition.
atoi settings schema [key]
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--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 settings schema
atoi settings schema appearance.theme --json
Was this useful?