mirror of https://github.com/badlogic/pi-mono.git synced 2026-11-05 23:37:25 +00:00

History

David Brailovsky dc83372f8f fix(coding-agent): validate extension command registration Reject extension commands without a non-empty string name or a handler at registration, instead of letting them crash the editor when typing /. fixes #10054		2026-09-30 15:02:08 +02:00
..
docs	feat(coding-agent): allow a custom OAuth client name for MCP servers	2026-09-30 13:59:24 +02:00
examples	feat(coding-agent): list MCP servers instead of their tools in codemode	2026-09-30 13:54:02 +02:00
install-lock	Release v0.99.1	2026-09-29 20:06:55 +02:00
scripts	fix: use portable shebang in shell scripts	2026-01-22 21:44:39 +01:00
src	fix(coding-agent): validate extension command registration	2026-09-30 15:02:08 +02:00
test	fix(coding-agent): resolve branch model selection with one catalog lookup	2026-09-30 14:20:03 +02:00
.gitignore	Fix tool call ID normalization for cross-provider switches to Anthropic/GitHub Copilot	2026-01-13 04:07:10 +01:00
CHANGELOG.md	fix(coding-agent): validate extension command registration	2026-09-30 15:02:08 +02:00
npm-shrinkwrap.json	Release v0.99.1	2026-09-29 20:06:55 +02:00
package.json	Release v0.99.1	2026-09-29 20:06:55 +02:00
README.md	docs(coding-agent): refresh documentation (#9898 )	2026-09-22 16:48:19 +02:00
tsconfig.build.json	fix(coding-agent): keep remote harness dependencies development-only	2026-09-05 12:45:04 +02:00
tsconfig.examples.json	chore: migrate pi packages to earendil works scope	2026-05-07 15:59:42 +02:00
vitest.config.ts	fix: use bounded runtime paths for Unix sockets	2026-08-14 17:02:03 +03:00

README.md

New issues and PRs from new contributors are closed automatically. Maintainers review closed submissions daily. See CONTRIBUTING.md.

Pi

Pi is a minimal, extensible AI agent for the terminal. Adapt Pi to your workflow, not the other way around.

Ask Pi to create the prompt templates, skills, extensions, and themes you need, or install a Pi package. Use Pi directly, automate it in print, JSON, or RPC mode, or build applications with the TypeScript SDK.

Getting started

Install the command-line interface with npm:

npm install -g --ignore-scripts @earendil-works/pi-coding-agent

This requires Node.js 22.19 or newer. Pi does not require dependency lifecycle scripts for a normal npm installation.

On macOS or Linux, you can instead use the installer:

curl -fsSL https://pi.dev/install.sh | sh

Start Pi in the directory where you want it to work:

cd /path/to/project
pi

For a built-in AI provider, run /login inside Pi to connect a subscription or API key. Then give Pi a task.

See the documentation for full setup and usage instructions.

Development

Clone the repository, install its dependencies, and run Pi from source:

git clone https://github.com/earendil-works/pi
cd pi
npm install --ignore-scripts
./pi-test.sh

pi-test.sh can be called from any directory and preserves the caller's working directory.

Before submitting changes, run:

npm run check
./test.sh

Read CONTRIBUTING.md before opening an issue or pull request. It defines the contribution gate, issue quality bar, and required checks. Read AGENTS.md for repository-specific implementation, testing, dependency, and release rules.

License

MIT