コンテンツにスキップ
PaneflowPaneflow

paneflow.json スキーマリファレンス

paneflow.json のすべてのキー、型、デフォルト、適用タイミング、runtime notes。

paneflow.json はユーザー単位の JSON ファイルです。すべてのキーは 省略可能で、{} も有効な設定です。挙動のソースは Rust の config loader と runtime resolver です。公開 JSON Schema は、エディタの validation と autocomplete 用に公開キーを反映します。

未知の top-level key は runtime では無視されますが、エディタでは schema によって検出されます。有効な保存は config watcher によって reload されます。 Hot reload 中に JSON が壊れている場合、defaults を配信せず直前の有効な config を維持します。起動時にファイルが無効な場合は defaults に戻り、 warning をログします。

File locations

PlatformPath
Linux と macOS~/.paneflow/paneflow.json
Windows%USERPROFILE%\.paneflow\paneflow.json

PANEFLOW_HOME はディレクトリ全体(設定、セッション、worktree、キャッシュ、 補助バイナリ)を移動します。以前の場所(~/.config/paneflow、 ~/Library/Application Support/paneflow、%APPDATA%\paneflow)にある設定は、 初回起動時に ~/.paneflow へコピーされます。

Editor schema

Add this at the top of the file for autocomplete in VS Code, Zed, JetBrains IDEs, Helix, and other JSON Schema-aware editors:

paneflow.json
{
"$schema": "https://github.com/arthjean/paneflow/raw/main/schemas/paneflow.schema.json",
"$schemaVersion": "1.0.0"
}

Top-level keys

KeyTypeDefaultAppliedNotes
$schemastringnoneEditor onlyPoints editors to the published schema. Ignored by Paneflow.
$schemaVersionstring1.0.0Startup/reloadUnknown versions warn but do not block loading.
default_shellstring/nullPlatform shell fallbackNew terminalUnix: configured -> $SHELL -> /bin/sh. Windows: configured -> pwsh.exe -> powershell.exe -> %ComSpec% -> C:\Windows\System32\cmd.exe -> cmd.exe.
themestring/nullPaneflow DarkHot reloadThe light or dark variant of one preset: Paneflow, Vercel, Claude, Cursor, Tailwind. Pre-preset names (One Dark, PaneFlow Light, Vercel, Claude, Cursor) still resolve. Runtime lookup is case-insensitive.
theme_modestring/nulldarkHot reloadlight and dark force the matching bundled theme; system follows the OS window appearance.
font_familystring/nullbundled JetBrainsMono Nerd FontHot reload cacheAccepts .PaneflowMono, JetBrainsMono NF, JetBrainsMono NFM, .PaneflowSans, embedded font names, or installed monospace families.
font_fallbacksstring array/nullGPUI fallback stackHot reload cacheOrdered extra fallback families for glyphs missing from font_family.
font_sizenumber/null13.0Hot reload cachePoints, valid range 8.0 to 32.0; invalid values fall back to 13.0.
font_weightstring/nullnormalHot reload cacheOne of thin, extra_light, light, semi_light, normal, medium, semi_bold, bold, extra_bold, black, extra_black.
line_heightnumber/null1.0Hot reload cacheMultiplier of the font's own line height (ascent, descent, and line gap), valid range 0.8 to 2.5. The cell is rounded to whole device pixels.
cell_widthnumber/null1.0Hot reload cacheMultiplier of the font's advance, valid range 0.8 to 2.0. The cell is rounded to whole device pixels.
unfocused_pane_opacitynumber/null1.0Hot reloadOpacity of panes that do not hold focus, when a workspace has more than one pane. Range 0.15 to 1.0; 1.0 disables the dim.
reduce_motionboolean/nullfalseHot reloadMinimizes non-essential interface motion: hover transitions settle instantly and decorative animations render a static frame. Trackpad scrolling in a terminal moves by whole lines instead of following the gesture by the pixel.
sidebar_showobject/nullall offHot reloadWhat a session tab row shows beyond its name: branch adds its git branch, diffstat adds its insertion and deletion counts, pr turns the branch icon into a pull-request glyph colored by the request's state when one exists, indent_guide draws a hairline under a workspace's folder icon down its tab rows. The first two read the tab's bound worktree, or its workspace's checkout when the tab is unbound; pr needs the gh CLI and answers for GitHub remotes only. Toggled from the rail's Customize Sidebar menu.
worktreesobject/null後述ホットリロードPaneflow がブランチ用に作る git worktree の保存先と後始末: dir、auto_remove、keep_limit、for_new_branches。Settings > Worktrees でも同じキーを編集できます。
window_decorationsstring/nullclientStartupclient draws Paneflow chrome; server delegates to the OS compositor.
window_backdropstring/nullautoStartupauto, mica, blurred, acrylic, transparent, opaque, or off. On Windows, blurred and acrylic set in the config resolve to auto; only PANEFLOW_WINDOW_BACKDROP applies blur there. PANEFLOW_WINDOW_BACKDROP overrides for one launch.
windows_terminal_materialboolean/nullfalseWindow/terminal renderWindows-only terminal background material toggle. The Blended interface style sets it to true, Themed to false. Ignored on other platforms.
windows_chrome_materialboolean/nullfalseWindow/chrome renderWindows-only native material in the primary navigation card. The Blended interface style sets it to true, Themed to false. Ignored on other platforms.
macos_chrome_materialboolean/nullfalseWindow/chrome rendermacOS-only native Sidebar material in the primary navigation card. The Blended interface style sets it to true, Themed to false. Ignored on other platforms.
linux_terminal_materialboolean/nullfalseWindow/terminal renderLinux-only translucent terminal card over the window veil, so a compositor blur shows through. The Blended interface style sets it to true, Themed to false. Ignored on other platforms.
linux_chrome_materialboolean/nullfalseWindow/chrome renderLinux-only translucent veil behind the sidebar and the title bar, so a compositor blur shows through. The Blended interface style sets it to true, Themed to false. Ignored on other platforms.
option_as_metaboolean/nulltrue on Linux and Windows, false on macOSHot reloadSends Alt/Option as ESC-prefix Meta. On macOS, true makes Option plus a letter send Meta instead of composing a character; keep false when Option should type Unicode characters. A config reload applies it to open terminals.
shell_integrationboolean/nulltrueNew terminalEnables Paneflow shell snippets for OSC 7 CWD and OSC 133 command marks.
editorobject/nullminimap オフ、scrollbar オンホットリロードコード エディタがテキストの脇に描くもの: minimap は右端にミニマップを追加し、scrollbar は縦スクロールバーを残します。エディタのコントロール メニューから切り替え、選択はすべての開いているファイルに適用されます。
automationobject/nullすべてオフホットリロードエージェントのターン後に走るバックグラウンド処理: tab_auto_naming はセッションの直近のやり取りを、エージェント自身の CLI (claude -p、codex exec、opencode run、pi --print) をツールなしで使って 2 から 5 語のタブ名に要約します。セッションごとに三分に一度まで、会話が増えたときのみ実行されます。入力した名前が置き換えられることはなく、"Reset name" でその名前にタブを戻します。
submit_paste_delay_msinteger/null70IPC sendFloor delay between bracketed paste and Enter for paneflow send --submit. Range 10 to 5000.
external_editorstring/nullautoNext open actionEditor that opens file links, including terminal file links: auto, system, zed, cursor, windsurf, code, or visual_studio. auto uses $VISUAL, then $EDITOR, then the first known editor on PATH; system always uses the OS opener. A named editor that is not on PATH falls back to auto.
shortcutsobject{}Hot reloadMaps keystrokes to action names. See shortcuts and actions.
terminalobject/nulldefaults belowMixedNamespaced terminal renderer and PTY settings.
commandsarray[]Settings/RunCommand palette entries and workspace templates.
agent_profilesarray[]ホットリロード組み込みエージェントを追加の環境変数と引数つきで起動するカスタム launcher エントリ。例えば CLAUDE_CONFIG_DIR による 2 つ目の Claude Code アカウント。Settings > Agents > Profiles でも同じリストを編集できます。
claude_code_bypass_permissionsboolean/nullfalseNext Claude launchAdds --permission-mode bypassPermissions to the Claude Code launcher. High-risk opt-in.
ai_unrestrictedboolean/nullfalsePer IPC callAllows trusted conductors to submit to peer panes without PANEFLOW_IPC_SCRIPTING.
ai_injection_fenceboolean/nulltruePer read callWraps surface.read output in an untrusted-output fence by default.
on_quitask, keep, stop, nullaskAt quitWhat quitting does while hosted sessions run: ask opens the quit dialog, keep leaves every session running, stop stops them all and shuts the host down. With no live session the app exits and shuts the idle host down.
sidebar_ended_sessions0, 3, 5, 10, null5Next sidebar renderHow many ended sessions a workspace previews in the sidebar before the rest collapse under one "N more ended sessions" row. Nothing is pruned; the cap only controls the preview.
agent_panelobject/nulldefaults belowAgents UIAgents-view notification preferences.
agentsobject/nulldefaults belowRestore and next launchAgent conversation restore and Claude Code session-id preassignment.
telemetryobject/null{ "enabled": null }Startup/consentDesktop telemetry consent. PANEFLOW_NO_TELEMETRY=1 overrides it.

Agent launcher buttons

Each button key is boolean/null. null or omission auto-detects the CLI binary. false hides the button. true forces it visible.

On Windows, the pane palette, the New pane menu, and the welcome screen offer only Claude Code, Codex, Amp, Gemini, and Copilot, the runtimes that declare Windows support, and hide agent_profiles entries based on the others. Linux and macOS keep every agent below.

KeyAgent
claude_code_button_visibleClaude Code
codex_button_visibleCodex
opencode_button_visibleOpenCode
pi_button_visiblePi
hermes_agent_button_visibleHermes Agent
grok_button_visibleGrok
amp_button_visibleAmp
gemini_button_visibleGemini
copilot_button_visibleCopilot
factory_button_visibleFactory
openclaw_button_visibleOpenClaw
muse_button_visibleMuse Code
fx_button_visiblefx (Linux and macOS)

terminal

KeyTypeDefaultAppliedNotes
terminal.ligaturesboolean/nulltrueHot reload cacheEnables programming ligatures when the active font supports them.
terminal.integrated_glyphsboolean/nulltrueHot reloadDraws built-in block glyphs as filled quads.
terminal.color_emojiboolean/nulltrueHot reloadUses the platform color-emoji path.
terminal.cursor_colorstring/nulltheme cursorHot reload/new terminal#RRGGBB, RRGGBB, #RGB, or RGB.
terminal.scrollbarboolean/nulltrueNew terminal viewOverlay scrollbar shown while scrolling or hovering the right edge of a pane.
terminal.scrollback_linesinteger/null10000New terminalRange 100 to 100000. Cached terminals cap at 1000.
terminal.cursor_shapestring/nullblockNew terminalvintage, block, beam, underline, double_underline, or hollow.
terminal.osc52_clipboardstring/nullcopyターミナルビューの作成時v0.17.5 以降で利用できます。 copy はフォーカス中のターミナルから OSC 52 経由でシステムクリップボードに書き込むことを許可し、off はすべての OSC 52 書き込みを拒否します。OSC 52 によるクリップボードの読み取りは常に拒否されます。既存のターミナルビューでは、再作成するまで設定が変わりません。
terminal.xt_checksum_reportboolean/nullfalseセッションの開始時v0.17.7 以降で利用できます。 DECRQCRA のチェックサム要求 (CSI Pi ; Pg ; Pt ; Pl ; Pb ; Pr * y) に応答します。vttest や esctest などの適合性テストはこの応答を必要とします。実行中のプログラムが画面のチェックサムを 1 セルずつ計算し、ほかのプログラムの出力も含めて画面の内容をすべて読み取れてしまうため、既定では無効です。無効の間は XTCHECKSUM (CSI Ps # y) も無視されます。セッションホストはセッションを開始するたびにこの値を読み込みます。
terminal.xt_checksum_extensioninteger/null0セッションの開始時v0.17.7 以降で利用できます。 DECRQCRA チェックサムの計算方法です。XTCHECKSUM と xterm の checksumExtension のビットを使います。1 は結果を正の値に保ち、2 はセルの表示属性を除外し、4 は空白を数え、8 は一度も書き込まれていないセルを空白として数え、16 は DEC の 8 ビット値の代わりに完全なコードポイントを使います。0 は実際の DEC 端末と同じ計算です。範囲は 0 から 31 です。32、-1、1.5、"4" のような範囲外の値はこのキーだけを無効にし、キー名と範囲を示す警告を出して 0 に戻ります。起動時も再読み込み時も、ファイルのほかの設定はそのまま適用されます。フルリセット (ESC c) を行うとこの値に戻ります。
terminal.cursor_blinkstring/nullterminal_controlledNew terminalon, off, or terminal_controlled.
terminal.envobject/nullnoneNew terminalEnvironment variables injected into every new terminal. Per-surface env wins. Values are passed through verbatim: no ~ and no $NAME expansion, unlike agent_profiles.*.env. Keys Paneflow sets for every terminal, such as TERM, ZDOTDIR, and the PANEFLOW_* variables, are ignored and logged once. LANG defaults to en_US.UTF-8 only when LANG, LC_ALL, and LC_CTYPE are all unset.
terminal.scroll_multipliernumber/null1.0New terminal viewRange 0.1 to 10.0. Ignored in mouse-reporting and alternate-screen scroll paths.
terminal.minimum_contrastnumber/nullAuto (60)Hot reloadMinimum APCA lightness contrast (Lc) enforced between text and its cell background, on the colors a program chose (truecolor and palette indices 16 to 255). The theme's sixteen ANSI colors, foreground, and background are never corrected. Unset means Auto, which is 60 on every theme; 0 turns the correction off; a negative or non-numeric value means Auto. Range 0 to 90.

agent_panel

KeyTypeDefaultNotes
agent_panel.notify_when_agent_waitingstring/nullNeverPrimaryScreen, AllScreens, or Never. Also governs desktop notifications that terminal programs send with OSC 9 or OSC 777.

agents

KeyTypeDefaultNotes
agents.restore_conversationsboolean/nulltrueWhen a pane's hosted session did not survive, for instance after a reboot, Paneflow opens a shell in the recorded folder and types the runtime's resume command for the conversation last started in that pane. Set to false to only reopen the shell.
agents.claude_preassign_session_idboolean/nullfalseThe Claude Code shim adds --session-id <uuid> to a fresh interactive claude launch, so Paneflow knows the conversation before any hook arrives. Read by panes started after the change.

worktrees

Paneflow は「New pane」パレット、タブのコンテキストメニュー、paneflow up からブランチを開くと git worktree を作ります。チェックアウトの中には何も書きません。所有マーカーは worktree 自身の git dir(メインリポジトリの .git/worktrees/<name>/)にあり、 git status はきれいなままで、マーカーは worktree と一緒に消えます。 Settings > Worktrees で同じキーを編集でき、Paneflow が管理する worktree を一覧できます。

パレットでブランチ名を空のままにすると、選んだベースで detached なチェックアウトが <base>-<sha7> という名前で作られます。タブのコンテキストメニューの 「Create branch here…」で後からブランチにでき、未コミットの変更は保持されます。

リポジトリのルートに置いた .worktreeinclude は、新しい worktree にコピーする git-ignored なファイルやディレクトリを 1 行 1 パス(ルートからの相対パス)で 列挙します。# はコメント、ディレクトリの末尾 / は省略可能です。ファイルが ない場合、Paneflow は最上位の .env* と AGENTS.override.md(存在すれば)を コピーします。worktree に既にあるファイルは上書きしません。

管理対象 worktree を削除する前に、自動でも手動でも、Paneflow は未コミットの 変更をメインリポジトリの refs/paneflow/snapshots/ 配下にスナップショット コミットとして保存します。追跡ファイルの編集、新規ファイル、当時のブランチが 対象です。Settings > Worktrees にスナップショットが並び、Restore は同じ ブランチ上にその変更を未コミットのまま worktree を作り直し、Delete は ref を 捨てます。きれいな worktree はスナップショットを残しません。

キー型デフォルト補足
worktrees.dirstring/null~/.paneflow/worktrees管理対象 worktree のルートディレクトリ。リポジトリごとに <repo>-<hash> のサブディレクトリ、その下にブランチごとのディレクトリができます。デフォルトはすべてのプラットフォームで ~/.paneflow/worktrees(Windows では %USERPROFILE%\.paneflow\worktrees)。~ はホームディレクトリに展開されます。以前のルート(旧来の隣接 <repo>.worktrees/ を含む)に作られた worktree はそのまま動き続けます。
worktrees.auto_removeboolean/nulltrueworkspace を閉じたときに管理対象 worktree を削除し、keep_limit を超えた古いものから整理します。未コミットの変更は先にスナップショットとして保存され、ブランチは削除しません。false なら Settings > Worktrees やタブのメニューから削除するまで残します。
worktrees.keep_limitinteger/null15保持する管理対象 worktree の数。これを超えると、開いているタブが使っていない古いものから削除されます。0 から 200。
worktrees.for_new_branchesboolean/nulltrueNew branch フォームの Worktree トグルの初期状態。true はブランチ用の worktree を作り、false は代わりに workspace のチェックアウトをそのブランチに切り替え、pane はリポジトリのルートで開きます。トグルはこのキーを書き換え、そのチェックアウトでエージェントが作業中の間は切り替えを拒否します。
{
  "worktrees": {
    "dir": "~/worktrees",
    "auto_remove": true,
    "keep_limit": 15
  }
}

agent_profiles

agent_profiles はリストです。各エントリは、組み込みエージェントのいずれかを 追加の環境変数と引数つきで起動する launcher 項目を追加します。プロファイルは pane パレットに組み込みエージェントと並んで表示され、ベースの エージェントのステータス追跡、hooks、セッションをそのまま使います。 Settings > Agents > Profiles でも同じリストを編集できます。

キー型デフォルト補足
agent_profiles.*.namestring必須launcher に表示されるラベル。
agent_profiles.*.agentstring必須ベースエージェントのタグ: claude_code、codex、opencode、pi、hermes、grok、amp、gemini、copilot、factory、openclaw。
agent_profiles.*.envobject{}エージェントのプロセスに設定する環境変数。先頭の ~ はホームディレクトリに展開され、値の任意の位置にある $NAME、${NAME}、%NAME% は Paneflow 自身の環境からその変数を取り込みます。何も指さない $ や % はそのまま残ります。環境で定義されていない名前は Settings のエディターでは拒否され、手書きの設定では値全体がそのまま残り、ログに警告が出ます。
agent_profiles.*.argsstring array[]ベースエージェント自身のフラグの後に付け足す引数。各トークンは英数字、-、_、.、= だけの単語である必要があります。

未知のエージェントタグ、空の名前、安全でないトークンを含むエントリは警告つきで スキップされ、他のプロファイルは読み込まれます。

{
  "agent_profiles": [
    {
      "name": "Claude perso",
      "agent": "claude_code",
      "env": { "CLAUDE_CONFIG_DIR": "~/.claude-perso" },
      "args": ["--model", "opus"]
    }
  ]
}

commands

commands entries back both simple shell commands and Settings > Workspaces templates. A command entry must have name; workspace and command are mutually exclusive.

KeyTypeDefaultNotes
commands[].namestringrequiredDisplay name. Must not be blank.
commands[].descriptionstring/nullnoneHuman-readable description.
commands[].keywordsstring array[]Fuzzy-search keywords.
commands[].workspaceobject/nullnoneWorkspace template.
commands[].commandstring/nullnoneSimple shell command string.

Workspace template keys:

KeyTypeDefaultNotes
commands[].workspace.namestring/nullcommand nameWorkspace display name.
commands[].workspace.cwdstring/nullcurrent cwdDefault workspace directory.
commands[].workspace.layout_presetstring/nullnoneeven_h, even_v, main_vertical, or tiled.
commands[].workspace.colorstring/nullnoneSix-digit hex accent color, no leading #.
commands[].workspace.layoutobject/nullpreset layoutLayout tree root.

Layout keys:

KeyTypeNotes
commands[].workspace.layout.typestringpane or split.
commands[].workspace.layout.surfacesarrayRequired for pane nodes.
commands[].workspace.layout.directionstringRequired for split: horizontal or vertical.
commands[].workspace.layout.rationumber/nullLegacy binary split ratio, range 0.1 to 0.9. Ignored when ratios exists.
commands[].workspace.layout.ratiosnumber array/nullPer-child ratios for N-ary layouts. Must match child count and sum near 1.0.
commands[].workspace.layout.childrenarrayRequired for split; minimum two layout nodes.

Surface keys inside a pane:

KeyTypeDefaultNotes
commands[].workspace.layout.surfaces[].surface_typestring/nullterminalCurrently only terminal surfaces render.
commands[].workspace.layout.surfaces[].namestring/nullderivedSurface tab name.
commands[].workspace.layout.surfaces[].custom_namestring/nullnoneUser-assigned name that survives restart.
commands[].workspace.layout.surfaces[].commandstring/nullshellCommand to run when the surface is created.
commands[].workspace.layout.surfaces[].promptstring/nullnonePrompt to prefill after launching an agent command.
commands[].workspace.layout.surfaces[].cwdstring/nullworkspace cwdPer-surface working directory. Relative paths resolve against workspace cwd.
commands[].workspace.layout.surfaces[].pathstring/nullnoneFile opened by a markdown surface. Ignored by terminal surfaces.
commands[].workspace.layout.surfaces[].envobject/nullnoneExtra environment variables. Wins over terminal.env on collision.
commands[].workspace.layout.surfaces[].focusboolean/nullfalseGives this surface initial focus.
commands[].workspace.layout.surfaces[].scrollbackstring/nullnoneSaved plain-text scrollback restored with the surface.
commands[].workspace.layout.surfaces[].agentstring/nullnoneStable tag of the agent CLI last detected in the surface.
commands[].workspace.layout.surfaces[].font_sizenumber/nullglobal font_sizePer-surface font-size override, range 8.0 to 32.0.
commands[].workspace.layout.surfaces[].sessionstring/nullnoneUUID of the persistent host session the terminal reattaches to on restore. Written by Paneflow.
commands[].workspace.layout.surfaces[].agent_sessionobject/nullnoneAgent conversation last started in the surface: runtime (catalog id), id (provider session id), and cwd. Paneflow reopens it when the host session did not survive. Written by Paneflow.

telemetry

KeyTypeDefaultNotes
telemetry.enabledboolean/nullnullnull means unanswered, true means opted in, false means opted out.

Complete example

paneflow.json
{
"$schema": "https://github.com/arthjean/paneflow/raw/main/schemas/paneflow.schema.json",
"$schemaVersion": "1.0.0",
"theme": "One Dark",
"font_family": "JetBrainsMono Nerd Font",
"font_size": 13,
"line_height": 1.0,
"cell_width": 1.0,
"windows_chrome_material": false,
"macos_chrome_material": false,
"terminal": {
  "ligatures": true,
  "scrollback_lines": 10000,
  "cursor_shape": "block"
},
"agent_panel": {
  "notify_when_agent_waiting": "PrimaryScreen"
},
"commands": [
  {
    "name": "API + Claude",
    "description": "Open the API project with Claude and tests",
    "workspace": {
      "name": "API",
      "cwd": "~/projects/api",
      "layout_preset": "even_h",
      "layout": {
        "type": "pane",
        "surfaces": [
          {
            "name": "Claude",
            "agent": "claude_code",
            "command": "claude",
            "prompt": "Review the API changes"
          }
        ]
      }
    }
  }
]
}
Paneflowの作者 Arthur Jean によって執筆されました。