cockpit settings
Generated reference for cockpit settings, including its syntax, options, results, and constraints from the canonical cockpit CLI source.
This reference is generated from the same canonical source distributed as cockpit CLI help. See Cockpit CLI for concepts and safe operating guidance.
Read and change allowlisted user-facing Settings. Every command returns JSON, changes one exact key at a time, and is local-only. Remote Access configuration belongs to cockpit remote-access.
cockpit settings list [--section <section>] [--changed]
cockpit settings get <key>
cockpit settings describe [<key>] [--section <section>]
cockpit settings set <key> <value>
cockpit settings reset <key>
Sections are appearance, notifications, shortcuts, agents, taskList, and onboarding. list returns effective values; --changed returns non-default values. describe includes value types, allowed values, defaults, access, and dynamic <model-id> patterns. reset affects only one key. Use none to unbind a shortcut.
set and reset return the key re-read after the write, so the reported value is what was persisted. Booleans accept only true or false. Integer keys clamp to their documented range instead of failing — appearance.chatFontSizePx to 11–18 and taskList.widthPx to 220–520 — so check the returned value rather than assuming the requested one. shortcuts.chatSendKey accepts enter or modEnter. A shortcut that collides with another binding is rejected with shortcut_conflict, and a Quick Task accelerator the operating system refuses is rolled back with shortcut_registration_failed.
Writable appearance keys include appearance.language, appearance.mode, appearance.zoomPercent, appearance.chatFontSizePx, and terminal themes for Claude, Codex, Antigravity, Cursor, Qoder, and Grok. Dark mode is cockpit settings set appearance.mode dark.
Writable agent keys include the default agent, agent commands, approval modes, supported UI modes, discovered models, reasoning effort by model, Codex service tier by model, system-prompt presets, Claude visual authentication mode, and agents.cockpit.lmStudioBaseUrl. Approval modes accept supervised, accept-edits, and full-access. An Antigravity visual session runs the CLI headlessly and cannot ask for approval, so supervised makes it read-only: it auto-denies file edits and commands until the task uses accept-edits or full-access. LM Studio accepts any HTTP or HTTPS base URL, including remote hosts. Cockpit provider is derived from its model and read-only. A model write fails with validation_unavailable whenever live discovery returns nothing for that agent, which is how Cursor, Qoder, and Cockpit behave when their backend is unreachable; Claude, Codex, Grok, and Antigravity always fall back to their built-in lists.
Credential entries carry key, isDefault, value:null, redacted:true, and isSet. Secret values, resume commands, migration flags, Remote Access storage, workspace and pin fields, and renderer-local state are not exposed.
Existing settings-related commands
cockpit workspaces [list|add|remove|pin|unpin]
cockpit defaultAgent [get|set <agent>]
cockpit templates [list|get|delete]
cockpit templates create --name <name> --instruction <instruction> [--variable key:label:type:required:defaultValue]
cockpit templates update <id> [--name <name>] [--instruction <instruction>] [--variable key:label:type:required:defaultValue]
cockpit devices [list|all|resolve|alias-set|alias-remove]
cockpit usage
cockpit workspaces returns path and isPinned, and includes Creative Studio workspaces tagged with kind and a display name. After saving a device alias with cockpit devices alias-set <alias> <host>, pass --host <alias> to cockpit task and cockpit autorun to operate a remote host; the local-only families above never accept --host.
Browser Identities remain under cockpit browser identity. Agent account profiles can be listed, created, removed, and signed in with cockpit accounts, and switched per task with cockpit task account <id> <account>. See cockpit help browser and cockpit help accounts.