PiG Documentation

Guides and references for configuring, using, and extending PiG.

Windows setup

PiG supports source builds on Windows. Do not treat Windows as release-supported until native release verification passes for the published artifact.

Build from source

Install Git and Go 1.27.1. Then run:

git clone git@github.com:MichaelKinsy/PiG.git
Set-Location PiG
go build -o bin\pig.exe .\cmd\pig
.\bin\pig.exe --version

No public PiG release artifact is available yet.

Configuration paths

PiG stores configuration below the user profile by default:

%USERPROFILE%\.pig
%USERPROFILE%\.pig\agent

Set PIG_HOME to use an isolated configuration root. Set PIG_CODING_AGENT_DIR only when you need to override the agent directory.

Terminal

Use Windows Terminal or another terminal that supports the required input and ANSI behavior.

Ctrl+Enter can provide multiline input where Shift+Enter is intercepted by the terminal. See Terminal setup.

External editor

PiG selects an editor in this order:

  1. externalEditor in ~/.pig/agent/settings.json;
  2. VISUAL;
  3. EDITOR;
  4. Notepad on Windows.

Use Ctrl+G to open the current editor buffer.

Extensions

A source extension requires its implementation toolchain. A Go extension needs Go. A Rust extension needs Cargo and Rust. A Python extension needs Python. A Node extension needs Node.

Use a prebuilt Piglet Binary when you do not want a target-side Go or Rust build. Interpreted components still need their recorded runtime.

Verification

Run the Windows-native unit and integration gates before claiming support for an artifact. A Linux cross-build alone does not prove Windows terminal, process, filesystem, update, or extension behavior.

Upstream Pi

See upstream Pi's Windows documentation when you need the TypeScript reference implementation.

Adapted from upstream Pi documentation · Upstream documentation ↗ · MIT License