Back to Pi Mono

Settings

packages/coding-agent/docs/settings.md

0.73.09.7 KB
Original Source

Settings

Pi uses JSON settings files with project settings overriding global settings.

LocationScope
~/.pi/agent/settings.jsonGlobal (all projects)
.pi/settings.jsonProject (current directory)

Edit directly or use /settings for common options.

All Settings

Model & Thinking

SettingTypeDefaultDescription
defaultProviderstring-Default provider (e.g., "anthropic", "openai")
defaultModelstring-Default model ID
defaultThinkingLevelstring-"off", "minimal", "low", "medium", "high", "xhigh"
hideThinkingBlockbooleanfalseHide thinking blocks in output
thinkingBudgetsobject-Custom token budgets per thinking level

thinkingBudgets

json
{
  "thinkingBudgets": {
    "minimal": 1024,
    "low": 4096,
    "medium": 10240,
    "high": 32768
  }
}

UI & Display

SettingTypeDefaultDescription
themestring"dark"Theme name ("dark", "light", or custom)
quietStartupbooleanfalseHide startup header
collapseChangelogbooleanfalseShow condensed changelog after updates
enableInstallTelemetrybooleantrueSend an anonymous install/update version ping after first install or changelog-detected updates. This does not control update checks
doubleEscapeActionstring"tree"Action for double-escape: "tree", "fork", or "none"
treeFilterModestring"default"Default filter for /tree: "default", "no-tools", "user-only", "labeled-only", "all"
editorPaddingXnumber0Horizontal padding for input editor (0-3)
autocompleteMaxVisiblenumber5Max visible items in autocomplete dropdown (3-20)
showHardwareCursorbooleanfalseShow terminal cursor

Telemetry and update checks

enableInstallTelemetry only controls the anonymous install/update ping to https://pi.dev/api/report-install. Opting out of telemetry does not disable update checks; Pi can still fetch https://pi.dev/api/latest-version to look for the latest version.

Set PI_SKIP_VERSION_CHECK=1 to disable the Pi version update check. Use --offline or PI_OFFLINE=1 to disable all startup network operations described here, including update checks, package update checks, and install/update telemetry.

Warnings

SettingTypeDefaultDescription
warnings.anthropicExtraUsagebooleantrueShow a warning when Anthropic subscription auth may use paid extra usage
json
{
  "warnings": {
    "anthropicExtraUsage": false
  }
}

Compaction

SettingTypeDefaultDescription
compaction.enabledbooleantrueEnable auto-compaction
compaction.reserveTokensnumber16384Tokens reserved for LLM response
compaction.keepRecentTokensnumber20000Recent tokens to keep (not summarized)
json
{
  "compaction": {
    "enabled": true,
    "reserveTokens": 16384,
    "keepRecentTokens": 20000
  }
}

Branch Summary

SettingTypeDefaultDescription
branchSummary.reserveTokensnumber16384Tokens reserved for branch summarization
branchSummary.skipPromptbooleanfalseSkip "Summarize branch?" prompt on /tree navigation (defaults to no summary)

Retry

SettingTypeDefaultDescription
retry.enabledbooleantrueEnable automatic agent-level retry on transient errors
retry.maxRetriesnumber3Maximum agent-level retry attempts
retry.baseDelayMsnumber2000Base delay for agent-level exponential backoff (2s, 4s, 8s)
retry.provider.timeoutMsnumberSDK defaultProvider/SDK request timeout in milliseconds
retry.provider.maxRetriesnumberSDK defaultProvider/SDK retry attempts
retry.provider.maxRetryDelayMsnumber60000Max server-requested delay before failing (60s)

When a provider requests a retry delay longer than retry.provider.maxRetryDelayMs (e.g., Google's "quota will reset after 5h"), the request fails immediately with an informative error instead of waiting silently. Set to 0 to disable the cap.

json
{
  "retry": {
    "enabled": true,
    "maxRetries": 3,
    "baseDelayMs": 2000,
    "provider": {
      "timeoutMs": 3600000,
      "maxRetries": 0,
      "maxRetryDelayMs": 60000
    }
  }
}

Message Delivery

SettingTypeDefaultDescription
steeringModestring"one-at-a-time"How steering messages are sent: "all" or "one-at-a-time"
followUpModestring"one-at-a-time"How follow-up messages are sent: "all" or "one-at-a-time"
transportstring"sse"Preferred transport for providers that support multiple transports: "sse", "websocket", or "auto"

Terminal & Images

SettingTypeDefaultDescription
terminal.showImagesbooleantrueShow images in terminal (if supported)
terminal.imageWidthCellsnumber60Preferred inline image width in terminal cells
terminal.clearOnShrinkbooleanfalseClear empty rows when content shrinks (can cause flicker)
images.autoResizebooleantrueResize images to 2000x2000 max
images.blockImagesbooleanfalseBlock all images from being sent to LLM

Shell

SettingTypeDefaultDescription
shellPathstring-Custom shell path (e.g., for Cygwin on Windows)
shellCommandPrefixstring-Prefix for every bash command (e.g., "shopt -s expand_aliases")
npmCommandstring[]-Command argv used for npm package lookup/install operations (e.g., ["mise", "exec", "node@20", "--", "npm"])
json
{
  "npmCommand": ["mise", "exec", "node@20", "--", "npm"]
}

npmCommand is used for all npm package-manager operations, including installs, uninstalls, and dependency installs inside git packages. Use argv-style entries exactly as the process should be launched. When npmCommand is configured, git package dependency installs use plain install to avoid npm-specific flags in wrappers or alternate package managers.

Normally the package manager's global modules location is queried using root -g. As a special case, if the first element of npmCommand is "bun", the modules location will instead be queried with pm bin -g.

Sessions

SettingTypeDefaultDescription
sessionDirstring-Directory where session files are stored. Accepts absolute or relative paths, plus ~.
json
{ "sessionDir": ".pi/sessions" }

When multiple sources specify a session directory, precedence is --session-dir, PI_CODING_AGENT_SESSION_DIR, then sessionDir in settings.json.

Model Cycling

SettingTypeDefaultDescription
enabledModelsstring[]-Model patterns for Ctrl+P cycling (same format as --models CLI flag)
json
{
  "enabledModels": ["claude-*", "gpt-4o", "gemini-2*"]
}

Markdown

SettingTypeDefaultDescription
markdown.codeBlockIndentstring" "Indentation for code blocks

Resources

These settings define where to load extensions, skills, prompts, and themes from.

Paths in ~/.pi/agent/settings.json resolve relative to ~/.pi/agent. Paths in .pi/settings.json resolve relative to .pi. Absolute paths and ~ are supported.

SettingTypeDefaultDescription
packagesarray[]npm/git packages to load resources from
extensionsstring[][]Local extension file paths or directories
skillsstring[][]Local skill file paths or directories
promptsstring[][]Local prompt template paths or directories
themesstring[][]Local theme file paths or directories
enableSkillCommandsbooleantrueRegister skills as /skill:name commands

Arrays support glob patterns and exclusions. Use !pattern to exclude. Use +path to force-include an exact path and -path to force-exclude an exact path.

packages

String form loads all resources from a package:

json
{
  "packages": ["pi-skills", "@org/my-extension"]
}

Object form filters which resources to load:

json
{
  "packages": [
    {
      "source": "pi-skills",
      "skills": ["brave-search", "transcribe"],
      "extensions": []
    }
  ]
}

See packages.md for package management details.

Example

json
{
  "defaultProvider": "anthropic",
  "defaultModel": "claude-sonnet-4-20250514",
  "defaultThinkingLevel": "medium",
  "theme": "dark",
  "compaction": {
    "enabled": true,
    "reserveTokens": 16384,
    "keepRecentTokens": 20000
  },
  "retry": {
    "enabled": true,
    "maxRetries": 3
  },
  "enabledModels": ["claude-*", "gpt-4o"],
  "warnings": {
    "anthropicExtraUsage": true
  },
  "packages": ["pi-skills"]
}

Project Overrides

Project settings (.pi/settings.json) override global settings. Nested objects are merged:

json
// ~/.pi/agent/settings.json (global)
{
  "theme": "dark",
  "compaction": { "enabled": true, "reserveTokens": 16384 }
}

// .pi/settings.json (project)
{
  "compaction": { "reserveTokens": 8192 }
}

// Result
{
  "theme": "dark",
  "compaction": { "enabled": true, "reserveTokens": 8192 }
}