Skip to content
AtoiDocumentation
Use Atoi

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.

CommandWhat it does
atoi settings listList settings from the shared registry.
atoi settings getRead one setting from its account or device tier, or list every setting the operator can reach when the key is left off.
atoi settings setSet a registry entry that is marked scriptable.
atoi settings unsetReturn one setting to the default it came from.
atoi settings schemaRead the full registry schema or one setting definition.

#settings list

List settings from the shared registry.

atoi settings list [--client <client>] [--tier <tier>] [--scriptable]

FlagTypeDefaultValuesWhat it does
--clientstringweb, ios, macos, android, tui, cliFilter by client surface.
--tierstringaccount, deviceFilter by storage tier.
--scriptablebooleanReturn only settings that the CLI may change.
--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 settings list

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

#settings get

Read one setting from its account or device tier.

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

FlagTypeDefaultValuesWhat it does
--clientstringweb, ios, macos, android, tui, cli, allRead the value a single client sees.
--convex-site-urlstringOverride the Atoi HTTP endpoint for account settings.
--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 settings get

bash
atoi settings get theme --json

#settings set

Set a registry entry that is marked scriptable.

atoi settings set <key> <value> [--convex-site-url <url>]

FlagTypeDefaultValuesWhat it does
--convex-site-urlstringOverride the Atoi HTTP endpoint for account settings.
--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 settings set

bash
atoi settings set defaultModelId "openai/gpt-5.6" --json

#settings unset

Return one setting to the default it came from. Use it when you set a value in the terminal and want the product's own default back, because settings set has no empty value.

atoi settings unset <key>

FlagTypeDefaultValuesWhat it does
--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 settings unset

bash
atoi settings unset defaultModelId --json

The answer says whether anything was cleared. A key that was already the default answers cleared: false rather than failing, so the command is safe to run twice.

#settings schema

Read the full registry schema or one setting definition.

atoi settings schema [key]

FlagTypeDefaultValuesWhat it does
--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 settings schema

bash
atoi settings schema theme --json

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

Was this useful?