Files
pi/packages/coding-agent/docs/windows.md
T
Armin Ronacher 30a1d1849d feat(coding-agent): support +name/-name in defaultTools
Entries of only +name/-name modify the inherited tool selection, so
"defaultTools": ["+codemode"] enables codemode without repeating the
defaults. Project entries layer on top of user settings. Document how to
enable codemode without MCP and how to use classifier models from it.
2026-09-29 14:02:57 +02:00

3.1 KiB

Run Pi on Windows

Run Pi either as a native Windows process or inside Windows Subsystem for Linux (WSL). Native Windows uses Git Bash by default for Bash commands and can optionally expose PowerShell to the model. Pi inside WSL uses the Linux environment and its Bash installation.

Follow the main Quickstart to install and authenticate Pi. Use this page to choose and configure its command environment.

Choose native Windows or WSL

Environment Command environment Use it when
Native Windows with Git Bash Git Bash for the built-in bash tool and ! commands Your files and development tools primarily live on Windows
Native Windows with the powershell tool PowerShell for model tool calls; Bash remains available for ! commands The task depends on PowerShell modules or Windows-native commands
WSL Linux Bash and tools inside the selected WSL distribution Your files and toolchain already live in Linux or WSL

Use Git Bash on native Windows

For most native Windows users, installing Git for Windows is sufficient.

Pi resolves Bash in this order:

  1. shellPath from ~/.pi/agent/settings.json
  2. Git Bash under Program Files or Program Files (x86)
  3. bash.exe on PATH, including Cygwin, MSYS2, or legacy WSL Bash

Start Pi and enter this command to verify the shell:

!printf 'Bash is working\n'

If Pi cannot find Bash, it reports the locations it checked. Install Git for Windows, put another Bash executable on PATH, or configure shellPath.

Let the model use PowerShell

The optional powershell tool runs commands through pwsh.exe when available, then falls back to Windows PowerShell. It starts PowerShell with -NoProfile -NonInteractive -ExecutionPolicy Bypass. Administrator-enforced execution policies can still take precedence.

To replace the model-facing bash tool with powershell, add this to ~/.pi/agent/settings.json:

{
  "defaultTools": ["read", "powershell", "edit", "write"]
}

["-bash", "+powershell"] does the same while keeping any other default tools you configured.

Restart Pi, then ask it to run a harmless PowerShell command. The ! and !! editor commands continue to use Bash. The powershell tool is available only when Pi runs as a native Windows process.

See Settings for other tool combinations.

Use a custom Bash executable

Set shellPath when Bash is installed somewhere Pi does not discover automatically:

{
  "shellPath": "C:\\cygwin64\\bin\\bash.exe"
}

JSON uses backslashes for escape sequences. When you write a Windows path with backslashes, write each backslash twice, as shown above.

See Configure shell commands for command prefixes, aliases, and the complete shell-resolution behavior.

Configure Windows Terminal

Windows Terminal reserves or rewrites some modified keys. See Windows Terminal to configure Shift+Enter and Alt+Enter, and Keybindings for Pi's Windows and WSL shortcut defaults.