--- name: Superset Settings slug: superset-settings category: Automation description: "Superset Settings reads and updates the Superset desktop app's user settings via the superset CLI, including creating, importing, and switching custom themes from JSON. Use it to change app behavior, terminal appearance, git preferences, and notifications without opening the settings UI." github: "https://github.com/superset-sh/superset/tree/main/.agents/skills/superset-settings" language: TypeScript stars: 12897 forks: 1190 install: "npx degit https://github.com/superset-sh/superset/tree/main/.agents/skills/superset-settings ~/.claude/skills/superset-settings" installs_to: ~/.claude/skills/superset-settings source_path: .agents/skills/superset-settings/SKILL.md collection_size: 14 category_size: 1523 collection_url: "https://dirskills.com/collections/superset-sh/superset" added: 2026-08-14T07:13:24.901Z last_synced: 2026-08-14T07:13:24.901Z canonical_url: "https://dirskills.com/skills/superset-settings" --- # Superset Settings Superset Settings reads and updates the Superset desktop app's user settings via the superset CLI, including creating, importing, and switching custom themes from JSON. Use it to change app behavior, terminal appearance, git preferences, and notifications without opening the settings UI. **Install:** ```bash npx degit https://github.com/superset-sh/superset/tree/main/.agents/skills/superset-settings ~/.claude/skills/superset-settings ``` ## README # Superset settings via CLI Change the desktop app's user settings from the command line with `superset settings`. Works offline, no login required; everything is local to this machine. ## Commands ```bash superset settings list # every key: value, default, allowed values superset settings get # effective value (default if unset) superset settings set # validated write superset settings reset # back to the app default superset settings theme list # system + built-ins + imported custom themes superset settings theme get superset settings theme set # e.g. dark | light | monokai | system | superset settings theme set system --system-light light --system-dark monokai superset settings theme export [--out ] # dump full theme JSON (starter) superset settings theme import # add/replace custom themes (validated) superset settings theme remove # delete a custom theme ``` Prefer `--json` (auto-on in agent environments; parse it rather than matching the human sentences) and `superset settings list` to discover keys and allowed values instead of guessing. In Superset terminals `superset` is already on PATH. `SUPERSET_HOME_DIR` overrides the target profile (`~/.superset` by default); useful for testing against a sandbox copy. ## Creating custom themes Two paths; both end with import → set (a running app restyles live). **From scratch**: a minimal file is enough. Every color you omit is filled in from the built-in base theme for your declared `type`, so start small and override only what you care about: ```json { "name": "Midnight Ocean", "type": "dark", "ui": { "background": "#071A2E", "sidebar": "#061426", "primary": "#38BDF8" }, "terminal": { "background": "#071A2E", "cursor": "#38BDF8" } } ``` ```bash superset settings theme import ocean.json # -> Imported 1 theme: midnight-ocean superset settings theme set midnight-ocean # a running app applies it live ``` **From a starter**: export any theme's complete definition (all ~38 ui + 21 terminal colors) and edit it. Best when restyling everything: ```bash superset settings theme export dark --out my-theme.json # edit, then: superset settings theme import my-theme.json && superset settings theme set my-theme ``` ### Theme file anatomy | Field | Notes | | --- | --- | | `name` / `id` | either works; the id is slugified (`"Midnight Ocean"` → `midnight-ocean`). Reserved: `dark`, `light`, `monokai`, `system` | | `type` | `"dark"` or `"light"` (defaults to dark); picks the base theme that fills omitted colors | | `ui` | app chrome. Highest-impact keys: `background`, `foreground`, `sidebar`, `card`, `popover`, `primary`, `accent`, `muted`, `border`, `input`, `ring`, plus `sidebar*` variants | | `terminal` | xterm colors: `background`, `foreground`, `cursor`, `selectionBackground`, and the 16 ANSI names (`red`, `brightRed`, ...) | | `editor` | optional `{ "colors": {...}, "syntax": {...} }` for the file editor; generated from `ui`/`type` when omitted | | `author`, `version`, `description` | optional metadata | Rules (same parser as the app's Appearance → Import): all colors are CSS color strings; missing colors inherit from the base; a file can hold one theme, an array, or a pack `{ "themes": [...] }`; max 256 KB; re-importing an id replaces that theme; import never activates; `theme set` does. ### Verify and iterate ```bash superset settings theme list # SOURCE column shows custom; * marks active superset settings theme get # active theme id superset settings theme export midnight-ocean # round-trip the stored result superset settings theme remove midnight-ocean # active falls back to dark ``` Iterating on colors: each `import` replaces the theme, and a running app applies it live; the loop is edit → import → `theme set ` (re-set to re-apply the active theme after edits). ## How changes take effect After every write the CLI nudges the running desktop app (`POST /settings-changed` on its local server) and the app refreshes immediately, themes included, no restart. The command output tells you which happened: "refreshed immediately" / "Applied to the running desktop app" means the nudge landed. The notes below are the fallback behavior when no app acknowledged (app not running, or an older app version): - **Regular settings** (most of `settings set`): written to `~/.superset/local.db`. A running older app picks them up the next time its window regains focus; no restart needed. - **Git settings** (`branchPrefixMode`, `branchPrefixCustom`, `worktreeBaseDir`): host-wide values written through the local host service (auth via its manifest, no login needed). Requires the desktop app or `superset start` to be running; also refreshed on window focus. - **Ringtone caveat**: `selectedRingtoneId` changes what sound plays immediately, but the checkmark in Settings → Notifications only updates after an app restart. - **Theme** (`settings theme set`): applies live when the nudge lands. If the output shows the restart fallback instead: quit the app cleanly first, then set, then relaunch; a running older app overwrites the file on its own writes. If you are an agent running inside a Superset terminal, never kill the app yourself (that kills your own session); ask the user to restart instead. - Both stores are created by the desktop app. On a machine that never ran the app, `set` commands fail with a hint to launch it once. ## Key reference (by section) Booleans accept `true/false/on/off/1/0/yes/no`. | Section | Keys | | --- | --- | | behavior | `confirmOnQuit`, `fileOpenMode` (`split-pane\|new-tab`), `showResourceMonitor`, `openLinksInApp`, `defaultEditor` (vscode, cursor, zed, ...) | | git | `branchPrefixMode` (`none\|github\|author\|custom`), `branchPrefixCustom`, `worktreeBaseDir`; host-wide, written through the local host service, so the app (or `superset start`) must be running | | notifications | `selectedRingtoneId` (shamisen, arcade, ping, quick, doowap, woman, african, afrobeat, edm, comeback, shabala), `notificationSoundsMuted`, `notificationVolume` (0-100) | | terminal | `terminalLinkBehavior` (`external-editor\|file-viewer`), `terminalParkedRuntimeCap` (2-64), `showPresetsBar`, `useCompactTerminalAddButton`, `autoApplyDefaultPreset`, `waitForSetupBeforeAgent` | | terminal appearance | `terminalFontFamily`, `terminalFontSize` (10-24, 0.5 steps), `terminalLineHeight` (1-2.5), `terminalLetterSpacing` (-2-4), `terminalFontWeight` (100-900), `terminalLigatures`, `terminalMinimumContrast` (1\|3\|4.5\|7), `terminalCursorStyle` (`block\|bar\|underline`), `terminalCursorBlink` | | editor appearance | `editorFontFamily`, `editorFontSize`, `editorLineHeight`, `editorLetterSpacing`, `editorFontWeight`, `editorLigatures` | ## Not settable here (by design) - `exposeHostServiceViaRelay`: security-sensitive; the app gates it behind a plan check and an explicit confirmation dialog. Point the user to Settings → Security. - Structured settings (terminal presets, agent preset overrides/custom agents, disabled agent hooks); use `superset agents ...` or the app UI. - `deleteLocalBranch` and other renderer-only prefs stored in the app's localStorage (diff view, chat model, hotkey rebinds) are not reachable from outside the renderer. ## Examples ```bash # Dark theme with bigger terminal text superset settings theme set dark superset settings set terminalFontSize 16 superset settings set terminalLineHeight 1.4 # Quieter notifications superset settings set notificationVolume 40 superset settings set selectedRingtoneId ping # Git hygiene (host service must be running) superset settings set branchPrefixMode custom superset settings set branchPrefixCustom kiet/ ```