Griddler docs

Settings reference

Every Settings card and control, what it does, its default, and the config key behind it.

Where: Top bar→Settings

Settings is the gear icon at the right end of the top bar. It opens one scrolling window of cards in two columns. Type in Search settings at the top to filter the rows in place; the count beside it says how many match, or nothing matches.

The header also shows your version number, Check for updates, and, when a new version is downloaded, Restart & update. See Install and update.

Settings are saved to ~/.griddler/config.json as you change them. The Key column below names each control's entry in that file.

Left column

Appearance

ControlWhat it doesDefaultKey
Theme + 🎨 PickerColors the terminals and the whole window. See Themes and fonts.Tokyo Nighttheme
Terminal fontFont for new panes.Default (Menlo / Consolas / DejaVu Sans Mono)termFontFamily
Terminal font size8–24, for new panes.12termFontSize
Terminal rendererAuto — GPU when available, GPU (WebGL), or DOM (compatibility). Applies to open panes.AutotermRenderer
Topbar mascotRoaming — walks, dances and sits, Sitting — drag him where you want him, or Hidden.RoamingdancerMode
Desktop petArchimedes, or your character, on your desktop with your new mail. See Desktop pet. His right-click menu sets petLook (owl or me), petSize (pixels) and petMotion (full = Animate); dragging him sets petSpot.OffdesktopPet
Hide the menu barHides the menu bar; Alt shows it. Windows and Linux.OffhideMenuBar

Today

Needs sign-in
ControlWhat it doesDefaultKey
Today panelAdds the 📅 Today button to the top bar. Takes effect right away.OffdayPanel
Opens itself atThe hour Today opens on its own each day, or never.8 amdayOpenAt
Calls in Meetingsrecorded only, all calls, or off.recorded onlydayCalls

What the panel shows is on Today.

Panes & startup

ControlWhat it doesDefaultKey
Default agentThe agent the launcher opens on.ClaudepaneDefaults.agent
ClaudeDefault model and effort for new Claude Code panes.default / defaultpaneDefaults.claude
CodexDefault model and effort for new Codex panes. Hidden when Codex is hidden.default / defaultpaneDefaults.codex
Bypass permissions by default (dangerous)New panes start without asking before each command or edit. Also sets the launcher's permission box for sessions on a Griddler Agent. See the launcher.OffpaneDefaults.bypass
Relaunch every session at startupOn: every tab's panes start when Griddler opens. Off: background tabs wait as one-click placeholders.OffrestoreAllTabs
Clipboard & keysModern or Classic. Classic sends a raw Ctrl+C, has no copy-on-select, and Shift+Enter submits. See Copy and paste.ModerntermClipboard

claude-mail

An older mail setup. If you're signed in, mail needs none of this; leave the card blank.

ControlWhat it doesDefaultKey
KB folder + Browse…The folder of your knowledge archive checkout that holds the old mail tools.Your workspace's archivemailDir
Find itLooks for the mail tools in the usual places.
ValidateChecks the folder and says Connected. or what's missing.
Notify me of new claude-mailShows once the old setup is found. Turns checking for mail through it on or off.

Right column

Account

ControlWhat it doesDefaultKey
StatusSigned in as your email, or Signed out.
AdminOpen admin portal ↗. Admins only; see Admin portal.
AliasYour name in the Tavern, up to 24 characters. Blank uses your handle.Blankalias
Set up…Opens the Welcome page again. See First run.
Add a line of work…Adds ready-made tabs for your work. See First run.
Sign in / Sign outYour River Logic account. See Griddler Social.
Auto-refresh usage gaugesKeeps the usage strip current in the background. See Accounts and usage.OnusageAutoRefresh

Notifications

Desktop notifications, one checkbox per kind. Mute all turns every kind off; Turn all back on reverses it.

ControlKey
New claude-mailnotifications.mail
Pane waiting on younotifications.attention
New task in Triagenotifications.triage
Tagged on a work itemnotifications.mention
New story chapternotifications.stories
Standup draft readynotifications.standup
Agent failed to startnotifications.launchFail
Co-op invitenotifications.coop
Watch-my-work requestnotifications.peek
Today panel at its hournotifications.day
…and show new triage work top-righttriageModal

All are on by default. …and show new triage work top-right adds a corner toast to the triage notification.

Play & music

⚔ Play opens (combatMode) and ☠ Death tax — a lost first battle can claim a real bug (asks first) (deathTax, on by default) are covered on Battles and raids. YouTube Music controls (ytMusic) and the player you pick in the panel (musicProvider) are covered on the game.

Posting voice

Voice, Learn mine, and your own voice text. Covered on Standup, posts and stories.

Support

ControlWhat it does
What's going wrong?A note that travels with the Trace.
Submit Griddler TraceRuns the Doctor's checks, then sends a Trace and shows a Trace ID to quote to support.
Copy insteadBuilds the same Trace and copies it to the clipboard. Nothing is sent.

What a Trace holds is on Troubleshooting.

Keys with no control

No UI for these. Edit ~/.griddler/config.json to change them.

KeyWhat it doesDefault
workspaceRootYour knowledge workspace folder. The Welcome page sets it.Found automatically
cloneRootThe folder Create suggests making RLI.KW in.Blank: C:\RLI.KW on Windows, ~/RLI.KW elsewhere
standupMaxSessionsHow many recent sessions one standup draft reads.40
protocolAsksdock shows peek, co-op, and raid requests as cards in the mail dock; modal shows them as dialogs.dock
guildhall.deliveryHow messages from the hall and other panes reach a pane: attention lights it, auto types them in, off stops them.attention
coopBudgetPauses a co-op campaign after this many incoming messages. 0 never pauses.0
deathTaxEmailThe Azure DevOps email the game uses for commit boxes and the death tax, when it isn't your River Logic account.Your River Logic account, then your global git email
openaiKeyAn OpenAI API key, so 🎨 Generate Character can paint while you're signed out. Griddler encrypts it the first time it reads it.Blank
agentReposDirThe folder a Griddler Agent on this machine's Docker Desktop mounts, so its sessions can work in your checkouts.The folder most of your repositories share
agentImageWhere a deployed agent's image comes from: pull downloads the published one, build builds it from a Griddler source checkout.pull in an installed Griddler
agentsWritten by Griddler: each agent you deployed from here and the machine it runs on, so Re-sync and Remove don't ask again. Don't edit it.Blank
azureOpenAIThe same through Azure OpenAI: { "endpoint": …, "apiKey": …, "deployment": … }. Used before openaiKey.Blank
docsUrlWhere the top bar's open-book button and every ? and docs link go.Blank: the team server's /docs, https://griddler.eode.app/docs

On this page