sscoble/pi-mono
1
0
Fork 0
mirror of https://github.com/badlogic/pi-mono.git synced 2026-11-05 23:37:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

docs: update repo and CLI READMEs

Browse source 
Fixes #6907
This commit is contained in:
Christian Klotz 2026-10-02 14:29:23 +01:00
parent 9b3c19da5c
commit de7e675de2
No known key found for this signature in database
2 changed files with 74 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

43
packages/coding-agent/README.md
View file

@ -12,25 +12,35 @@
# Pi
Pi is a minimal, extensible AI agent for the terminal. Adapt Pi to your workflow, not the other way around.
Pi is a minimal, extensible agent harness that you can make your own.
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.
Adapt Pi to your workflows, not the other way around. Customize Pi with [extensions](docs/extensions.md), [skills](docs/skills.md), [prompt templates](docs/prompt-templates.md), and [themes](docs/themes.md). Bundle them as [Pi packages](docs/packages.md) and share via npm or git.
Pi ships with powerful defaults but skips features like sub-agents and plan mode. Ask Pi to build what you want, or install a package that does it your way.
Use Pi [interactively](docs/usage.md), automate it in [print or JSON mode](docs/cli.md), control it over [RPC](docs/rpc.md), or build apps with the [Pi TypeScript SDK](docs/sdk.md). See [OpenClaw](https://github.com/OpenClaw/OpenClaw) for a real-world integration.
## Getting started
Install the command-line interface with npm:
Install the command-line interface:
```bash
curl -fsSL https://pi.dev/install.sh | sh
```
On Windows:
```shell
powershell -c "irm https://pi.dev/install.ps1 | iex"
```
Alternatively, install directly with npm:
```bash
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:
```bash
curl -fsSL https://pi.dev/install.sh | sh
```
Pi requires Node.js 22.19 or newer. The macOS, Linux, and Windows installers can install it if needed. Pi does not require dependency lifecycle scripts for a normal npm installation.
Start Pi in the directory where you want it to work:
@ -43,6 +53,19 @@ For a built-in AI provider, run `/login` inside Pi to connect a subscription or
See the [documentation](docs/index.md) for full setup and usage instructions.
## Share your OSS coding agent sessions
If you use Pi for open source work, please share your coding agent sessions.
Public OSS session data helps improve models, prompts, tools, and evaluations using real development workflows.
For the full explanation, see [this post on X](https://x.com/badlogicgames/status/2037811643774652911).
To publish sessions, use [`badlogic/pi-share-hf`](https://github.com/badlogic/pi-share-hf) using a Hugging Face account and the Hugging Face CLI.
- [Demo video](https://x.com/badlogicgames/status/2041151967695634619) on how to publish Pi sessions
- Published Pi development sessions: [`badlogicgames/pi-mono` on Hugging Face](https://huggingface.co/datasets/badlogicgames/pi-mono).
## Development
Clone the repository, install its dependencies, and run Pi from source: