Skip to content
STYXDocs
Download

Docs / Reference

Settings

Every setting on the Settings screen, what it does, its default, and whether it is saved on this machine or in the project.

Settings has two groups. App settings are yours and stay on this machine; open them with Settings in the rail. Project settings (Targets, Agent defaults, Env & secrets) belong to one project and are opened from that project's nav. A few rows in the App sections apply to the current project; they're marked below.

Where a value is kept:

  • This machine: Styx's local database. Not shared with anyone.
  • project.json: the project's .styx/project.json, which you commit, so everyone on the project gets it. Secrets never go there. See project.json.
  • Keychain: the macOS Keychain, Windows Credential Manager or the system keyring on Linux.

In Agent defaults and Env & secrets, a Reset button appears next to a value the project has set; it puts the default back.

App

General

SettingWhat it doesDefaultKept
ThemeSystem, Dark or Light. ⌘⇧T (CtrlShiftT on Windows and Linux) switches between light and dark.SystemThis machine
Notify when an agent needs meBadge + sound, Badge or Off: how Styx tells you a task is waiting for you.Badge + soundThis machine
Launch at loginStart Styx when you log in (installed app only).OnThis machine
UpdatesShows the running version and what the updater is doing. Check now looks for an update; Restart to update installs one that has downloaded.——
WalkthroughWhether you've seen the walkthrough. Show the walkthrough plays it again.Not seen yetThis machine

Account

Signing in to Styx with GitHub or Google, your plan, Refresh and Sign out.

SettingWhat it doesDefaultKept
Send usage countsSends counts of which features get used: tied to your account when signed in, under a random install id when not. Never your code, projects, paths or prompts.OnThis machine

Editor

SettingWhat it doesDefaultKept
EngineThe built-in editor: Monaco (embedded). Not changeable.Monaco (embedded)—
Open files inStyx or Fallback editor. Not applied yet.StyxThis machine
Fallback editorThe editor Open in… uses, chosen from the editors Styx found on this machine.The detected fallback, else NoneThis machine
Line endingsCurrent project. Per repo, LF or CRLF. Not applied yet.Per repoproject.json
Screen reader modeTurns on the editor's screen reader mode and the terminal's accessibility tree.OffThis machine
Track agent edits (diff review)Watches agents' worktrees so their edits show as changes in the editor, the change bar and diff review. Off because it slows Styx down on large changes.OffThis machine

Agents

The table of agents (Claude Code, Codex, Gemini CLI, Cursor's agent, shell) with Connect, Sign in, Verify, Locate binary and Rescan. See Connect your agents. Under Preferences:

SettingWhat it doesDefaultKept
Default agentCurrent project. The agent a new task starts with.Claude Codeproject.json
Auto-create worktree per agentNot applied yet: in a git project every new task gets its own worktree and branch.OnThis machine
Shell (Windows)Current project. PowerShell or WSL. Not applied yet; set STYX_WIN_SHELL=wsl instead (see Environment variables).PowerShellproject.json
Detected CLIsThe agent CLIs Styx found, with version and where they come from. Read-only.——
Agent binaryShown when an agent has more than one runnable copy (for example on PATH and inside an editor extension), or one you located by hand. Picks which one Styx runs; Detected automatically undoes a manual pick.The detected binaryThis machine

Skills

The skills installed for your agents and a catalogue to install from, with Install, Read and Remove. Project skills are committed with the repo. No settings rows.

Keychain & secrets

SettingWhat it doesDefaultKept
StoreWhere credentials are kept: macOS Keychain, Windows Credential Manager or the system keyring. Read-only.——
MFA for prod writeWhat confirms prod write, deploy and delete: Touch ID, Windows Hello or your system password. Read-only.——
Inject asScoped token, else env or Env. Not applied yet.Scoped token, else envThis machine

Policies

SettingWhat it doesDefaultKept
Auto-approve staging readsTurns the built-in rule that grants read access to staging and preview targets for 1 hour without asking on or off.OnThis machine
Grant idle expiryA grant ends after 1 hour without use. Read-only.1 hour—
ExportThe audit log export format. Read-only.JSON—

All policies, including your own rules, are on the Approvals screen. See Policies.

Shortcuts

Read-only: Palette (⌘K (CtrlK on Windows and Linux)), Switch project (⌘P (CtrlP on Windows and Linux)), Focus agent 1–4 (⌘1 (Ctrl1 on Windows and Linux) to ⌘4 (Ctrl4 on Windows and Linux)) and Approve / deny (⌘⏎ (CtrlEnter on Windows and Linux) / ⌘⌫ (CtrlBackspace on Windows and Linux)). The full list is in Keyboard shortcuts.

Project

Targets

A table of the project's deploy and server targets: Target, Env, Policy, State. Credentials stay in the keychain on this machine. Targets listed in .styx/project.json show up here as unconnected until you connect them.

SettingWhat it doesDefaultKept
PolicyPer target. Ask · MFA (ask, then Touch ID, Windows Hello or system password), Ask each time, or Always allow.Ask · MFA for prod, Always allow for scm, Ask each time otherwiseThis machine

Row actions: Refresh (targets that use a provider CLI login), Revoke (end the open grant), Edit or Connect, and Remove, which needs a second press (Remove?) because it deletes the credential and ends the target's grants. Under the table: + Connect target · OAuth / key / SSH and Deploy commands…. When the project file sets target policies or rules this machine hasn't accepted, Accept project policies appears. See Connect a target.

Agent defaults

What a new task in this project starts with. Each one can also be changed per task.

SettingWhat it doesDefaultKept
Default agentThe agent a new task starts with.Claude Codeproject.json
ModelThe model, from the default agent's list. Default leaves it to the agent.Defaultproject.json
Auto-approve editsWhether a new task starts with Auto-approve edits on.Offproject.json
Permission modeAsk each time, Accept edits, Plan mode, Bypass permissions, Don't ask or Auto.Autoproject.json
Styx tasks · Run locally, Deploy, Tech debt audit, mergesThe permission mode for the tasks Styx starts itself. Same six options.Bypass permissionsproject.json
EffortHow hard the agent thinks, from the agent's own list. Shown only for agents that take an effort.Defaultproject.json
Fetch before cutting a laneFetch from the remote before a new task's branch is created, so it starts from the latest code.OnThis machine
Bring in the base branch before publishingMerge the base branch into a lane before it is pushed or opened as a pull request.OnThis machine
Bring in the base branchAfter every turn, Before publishing or Only when I ask: when Styx merges the base branch into a lane by itself.After every turnThis machine
MergingKeep my project up to date for me (Styx resolves conflicts with the agent, checks and commits) or I review and merge myself.Keep my project up to date for meThis machine
Land on its own when the agent goes quiet and the checks passA finished lane lands in the base branch by itself.OffThis machine
Checks before landingThe command Land runs in the lane first (and Styx after a merge it resolved). Typed; blank clears it. Learned by the agent at the first landing.Not known yetproject.json

Env & secrets

SettingWhat it doesDefaultKept
.env sourceSecrets come from the keychain. Read-only.Keychain—
Share with agentsPer grant, Always or Never. Not applied yet.Per grantproject.json
Committed fileThe project settings file: .styx/project.json. Read-only.——