Authoritative reference for Pi (@earendil-works/pi-coding-agent): install, configure, run, and extend it. Use for the CLI and configuration, providers and models, extensions, skills, MCP, codemode, the SDK/RPC, security and trust, design philosophy, and the pi repository's internals and contribution rules.
npx skills add https://github.com/Agents365-ai/365-skills --skill pi-dev-rules
Pi is a minimal terminal coding harness: lightweight core, extended through TypeScript
customizations. Package: @earendil-works/pi-coding-agent. Maintained by Earendil Inc. (MIT).
This skill mirrors the official docs at <https://pi.dev/docs/latest> so you can answer Pi questions
and build Pi customizations without re-fetching. Five further bundles describe material the pi.dev
docs site does not hold: the internal monorepo architecture (the Chord typed host runtime, the
durable agent harness with its Pico5 specification, the agent core, telemetry), a **Pi Durable
overview** curated from the 2026-10-01 Earendil blog post (what the experimental harness is, its
version timeline, and which blog demos were removed in 1.2.0), and the repository's own
development/contribution rules.
models.json), or proxies.settings.json, keybindings, themes; understanding sessions & compaction.enabling codemode or writing its scripts.
tools, YOLO by default; the 2025-11-30 manifesto lists MCP, plan mode, to-dos, and sub-agents as
deliberate non-features, and built-in MCP landed later, on 2026-09-29) and how to configure or
extend Pi along those lines instead of against them.
@earendil-works/chord typed host runtime (contracts,hosts and links, hot reload, delta/replicated state), the durable harness
(@earendil-works/pi-durable, Pico5), the agent core, and telemetry. The experimental
server/client/protocol packages were removed in 1.2.0.
@earendil-works/pi-durable): what the harness is, whichversion shipped what, where the runnable examples live, or why a blog-post demo path no longer exists.
| File | Covers |
| ------ | -------- |
| references/cli-and-usage.md | Install, auth, launching, how Pi works (agent loop, context assembly, session tree), the full CLI reference (commands, flags, modes), slash commands, message queue, context files, environment variables (incl. bash-tool PI_SESSION_*/PI_MODEL), sessions, keybindings |
| references/providers-and-models.md | Subscription & API-key providers (30+), llama.cpp local router, NVIDIA RTX recipe presets, auth.json (+ scoped env), cloud providers (Azure/Bedrock/Vertex/Cloudflare), custom models in models.json, the generated field reference for every provider, model and compat key, custom-provider extensions |
| references/settings-and-compaction.md | Configuration layout (agent directory vs project .pi/, context files), settings.json schema + example, trust/analytics/retry/transport keys, compaction (auto/manual) and branch summarization |
| references/extending-pi.md | Extension API (events, tools, commands, UI), tool parameter validation with @earendil-works/pi-schema and the TypeBox features it ignores, Skills (SKILL.md), Prompt Templates, Themes, Packages, virtual models (pi.registerVirtualModel) |
| references/mcp.md | Built-in MCP support (2026-09-29): mcp.json global and project servers, stdio vs streamable HTTP, pi mcp add/remove/list, OAuth sign-in, exposure modes (codemode, codemode-deferred, deferred, direct, hidden) with toolExposure, codemode/tool_search tools, resources, permissions, servers from extensions, SDK wiring, and the --no-mcp / mcp__* tool patterns |
| references/codemode.md | The codemode tool: script input and the // @options: line, globals (tools.<name>(), text(), image(), console.log(), store()/load(), searchTools(), describeTool()), what tool calls resolve to, classifier and image models, namespaces and the inline budget, limits |
| references/tui-components.md | TUI component system for custom extension/tool UIs (components, overlays, theming, custom editor) |
| references/security-and-containerization.md | Project-trust model (trust.json, defaultProjectTrust), no built-in sandbox, Gondolin micro-VM, Docker, OpenShell, Docker Sandboxes |
| references/session-format.md | Session JSONL schema: versions, content blocks, entry types, tree/context building, SessionManager API, plus the model-facing message types |
| references/programmatic.md | SDK, CLI integration (interactive/print/JSON/RPC mode choice, RpcClient, fork-and-rebrand), JSON event-stream mode, RPC protocol, RPC command reference, RPC extension UI |
| references/platform-setup.md | Windows, Termux, tmux, per-terminal modified-Enter setup, shell aliases |
| references/development.md | Monorepo package list, build-from-source and standalone-binary builds, supply-chain rules, AGENTS.md development rules, the CONTRIBUTING.md gate |
| references/philosophy-and-design.md | Creator Mario Zechner's design manifesto (blog, 2025-11-30; manually curated, not auto-built): minimal prompt <1000 tokens, 4 tools, YOLO by default, the non-features it lists (MCP/plan mode/to-dos/sub-agents/background bash) with their intended alternatives and the MCP entry annotated as superseded since 2026-09-29, multi-provider architecture, Terminal-Bench 2.0 results |
| references/chord.md | @earendil-works/chord: the typed host runtime (contracts, declarations, registries, principals, handles, hot reload), hosts and links (memoryLinkPair, ipcLink, webSocketLink), and chord/delta replicated latest-value state with the fold-while-watching watches. Built from packages/chord/{README.md,docs/{guide,spec,tutorial}.md,src/delta/README.md}; Pi Durable uses Chord, but the Pi coding agent does not; the spec describes the 1.x runtime, now schema-checked with @earendil-works/pi-schema. A second-generation runtime (v2) lives in packages/chord/src/next with its design in packages/chord/docs/next and an experimental @earendil-works/chord/next export; it is not bundled here |
| references/durable.md | Pi Durable overview, curated from the 2026-10-01 Earendil blog post and the v1.5.0 tree: the harness/conversation/agent/task/execution-environment vocabulary, the positioning (a harness for building agentic applications, not the Pi CLI), the version timeline (1.0.0 with Pi 1.0 → 1.5.0, lockstep versions, breaking changes), install and code shape, the package layout and its 38 runnable examples, and the blog demos deleted in 1.2.0. Start here for status and routing |
| references/agent-harness.md | Internal runtime packages: @earendil-works/pi-durable (durable conversation/task/document harness, experimental API, stored before shown), @earendil-works/pi-agent-core (tool calling and state), @earendil-works/pi-telemetry (vendor-neutral telemetry contracts, adapters, typed schemas). Built from the three package READMEs; not user docs, and durable.md is the entry point |
| references/durable-spec.md | The normative Pico5 specification behind pi-durable (6531 lines): records and lifetimes, documents and mutation ownership, tasks and the effect sandwich, submissions and inbox, extensions/hooks/tools, telemetry. A design document for an experimental package, not a frozen API; the bundled text is the v1.5.0 spec |
| references/changelog.md | Release history: the last 25 versions with their headline change, extracted from packages/coding-agent/CHANGELOG.md (291 release sections; read the file in the checkout for the full text) |
models.json field now has a generated reference (docs/models-configuration.md), bundledin providers-and-models.md.
@earendil-works/pi-schema; TypeBox schemas stillwork, but Type.Refine, Type.BigInt, Type.Undefined, codecs and Format.Set formats do not
apply to them, and plain JSON Schema tools get the same coercion.
pi.changelogPath or the package'sCHANGELOG.md; collapseChangelog condenses it).
pi update accepts a custom command: PI_SELF_UPDATE_COMMAND or the selfUpdateCommand setting,with {packageName}, {version} and {installSpec} filled in.
a supported terminal (OSC 8, truecolor, inline images).
gpt-6.1-sol (also after ChatGPT sign-in); GPT-6.1 Terra is availablethrough OpenAI, Azure and Codex; the catalog moved to models.dev v2.
models.classify() accepts images; scripts wait up to 60 s for a free worker andPI_CODEMODE_MAX_WORKERS raises the two-worker limit.
reserveTokens no longer capsthem; it only decides when compaction starts.
oauth.clientRegistration: "auto");"dcr" always registers dynamically, and pi mcp add --oauth-client-registration selects it.
AGENTS.md.
documentState/viewState/watchEvents surface with windowed conversation views and Chord
watches, and Storage.commit() stores a group of commits; chord exports the experimental v2
runtime as @earendil-works/chord/next.
Every Pi user should install these three (same author, battle-tested):
pi install npm:pi-subagents # subagents / loop / chain / parallel
pi install npm:pi-lens # real-time LSP diagnostics
pi install npm:pi-web-access # web search, URL fetch, YouTube, PDF
Then pi list to verify, restart Pi. MCP needs no package: it is built in since 2026-09-29 (see
references/mcp.md). An extension that registers /mcp, such as pi-mcp-adapter, replaces the
built-in support instead of adding to it.
curl -fsSL https://pi.dev/install.sh | sh # install (pins dependencies)
npm install -g --ignore-scripts @earendil-works/pi-coding-agent # npm alternative (no pinned transitive deps)
export ANTHROPIC_API_KEY=sk-ant-... # or run /login in-session
cd /path/to/project && pi # start interactive (may prompt to trust the project)
pi update # update Pi itself (pi update self / pi update --self are aliases)
pi list # list installed packages
pi -c # continue most recent session
pi -r # browse/resume sessions
pi --session <path|id> # open specific session
pi --fork <path|id> # fork a session
pi --no-session # ephemeral (no save)
pi -a / -na # trust / don't trust project-local files for this run
pi -p "Summarize this codebase" # print mode (non-interactive)
pi @README.md "Summarize this" # attach files/images with @
cat file | pi -p "..." # pipe stdin
pi --provider openai --model gpt-4o "..." # pick provider/model
pi --model sonnet:high "..." # model:thinkingLevel
pi --tools read,grep,find,ls -p "..." # allowlist tools (-xt excludes; +name/-name adjusts defaults)
pi --mode json "..." | jq -c 'select(.type=="message_end")' # JSON stream
pi --mode rpc # JSON-RPC over stdin/stdout
# In-editor: @file (fuzzy), !cmd (run+send), !!cmd (run, hidden), /command, Ctrl+L model, Shift+Tab thinking, Ctrl+X copy
# While the agent runs: Enter queues a steering msg, Alt+Enter a follow-up, Esc aborts + restores
Key locations (global ~/.pi/agent/, project .pi/):
settings.json, auth.json, models.json, keybindings.json, trust.json, AGENTS.md,
SYSTEM.md, extensions/, skills/, prompts/, themes/, sessions/.
@earendil-works/pi-coding-agent. The pi.dev installer(curl -fsSL https://pi.dev/install.sh | sh) pins dependencies and is the documented install
path; a global npm install needs --ignore-scripts and pins nothing.
AGENTS.md (Pi also reads CLAUDE.md); put it in the project root.ops (rm, sudo, sensitive paths) with ctx.ui.confirm or a tool_call block handler.
is "trusted" only to decide whether to load its .pi/ resources (settings/extensions/skills/
prompts/themes); decisions live in ~/.pi/agent/trust.json, governed by defaultProjectTrust
(ask/always/never), overridable per run with --approve/--no-approve. For untrusted repos
or unattended runs, isolate with a container/VM (Gondolin/Docker/OpenShell); don't mount host
~/.pi/agent unless the sandbox should see host credentials.
~/.pi/agent/mcp.json or a project `.pi/mcp.json`; the project file is read only after the project is trusted, because stdio servers run
commands. MCP calls go through the tool pipeline, so tool_call handlers and permission gates
apply (codemode calls carry parentToolCallId). Installing an extension that registers /mcp
(pi-mcp-adapter) disables the built-in support; disable it deliberately with `"extensions":
["-builtin:mcp"], pi config, or --no-mcp` for one run.
into an error tool result (isError: true); the docs defer to ToolDefinition in
packages/coding-agent/src/core/extensions/types.ts for the exact contract. Limit tool output to
~50KB / 2000 lines (DEFAULT_MAX_BYTES = 50 * 1024). Use StringEnum (from
@earendil-works/pi-ai) for LLM-facing enums.
parameters are any JSON Schema; Pi validates them with @earendil-works/pi-schema.TypeBox schemas are JSON Schema and still work, but refinements, BigInt, Undefined, codecs and
Format.Set formats do not apply to tool arguments (check those in execute()), and plain JSON
Schema tools, including MCP tools, get the same coercion as TypeBox tools.
name: 1–64 chars, lowercase a-z 0-9 -, no leading/trailing or consecutive hyphens;description ≤1024 chars and must say *when* to load it (a skill with no description won't load).
chord.md, durable.md, agent-harness.md, and durable-spec.md describe internals, not astable contract.** Chord is application-neutral and used by Pi Durable, not by the Pi CLI.
pi-durable is experimental (1.0.0 on 2026-10-01 with Pi 1.0, 1.5.0 on 2026-11-02).
Versions follow the monorepo, and earlier releases include breaking changes. The Pico5 spec is
a design document. Quote the source tree state (pi@f9a263655), not a promised API.
(packages/coding-agent/src/experimental/{durable,vacation}/) were deleted in 1.2.0 by commit
7472cda0d; the durable harness itself is unaffected. Run examples from
packages/durable/test/examples/ (00–37) instead, and read durable.md for the version timeline.
auth.json holds API keys and OAuth tokens: Pi writes it 0600, keep it private and out ofversion control. Credential priority: CLI --api-key → auth.json →
env var → custom-provider keys in models.json.
replaced (per-model objects such as compaction thresholds merge before the model lookup). Use
pi install -l to write a package declaration to .pi/settings.json, which Pi reads only after
the project is trusted.
Take agents365-ai/pi-dev-rules from the repository into ~/.claude/skills for personal
use, or into .claude/skills inside a project.
The agent identifies a skill by the name field in its header. Two skills with the
same name cannot sit side by side — one of them will be ignored.
The instructions reference npm.
Without those the skill loads but fails at the first command.