Settings CLI reference

List, inspect, and change settings through the shared registry contract.

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

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, or list every setting the operator can reach when the key is left off.
`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.

atoi settings list --client cli --scriptable --json

Read one setting from its account or device tier.

atoi settings get [key] [--client <client>] [--convex-site-url <url>]

Flag	Type	Default	Values	What it does
`--client`	`string`		`web`, `ios`, `macos`, `tui`, `cli`, `all`	Read the value a single client sees.
`--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.

atoi settings get appearance.theme --json

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.

atoi settings set appearance.theme system --json

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.

atoi settings schema appearance.theme --json

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

Was this useful?