mirror of
https://github.com/badlogic/pi-mono.git
synced 2026-11-05 23:37:25 +00:00
parent
9b3c19da5c
commit
de7e675de2
2 changed files with 74 additions and 19 deletions
50
README.md
50
README.md
|
|
@ -10,20 +10,52 @@
|
|||
|
||||
> New issues and PRs from new contributors are auto-closed by default. Maintainers review auto-closed issues daily. See [CONTRIBUTING.md](CONTRIBUTING.md).
|
||||
|
||||
# Pi Agent Harness
|
||||
# Pi
|
||||
|
||||
This is the home of the Pi agent harness project including our self extensible coding agent.
|
||||
Pi is a minimal, extensible agent harness that you can make your own.
|
||||
|
||||
* **[@earendil-works/pi-coding-agent](packages/coding-agent)**: Interactive coding agent CLI
|
||||
* **[@earendil-works/pi-agent-core](packages/agent)**: Agent runtime with tool calling and state management
|
||||
* **[@earendil-works/pi-ai](packages/ai)**: Unified multi-provider LLM API (OpenAI, Anthropic, Google, …)
|
||||
Adapt Pi to your workflows, not the other way around. Customize Pi with [extensions](packages/coding-agent/docs/extensions.md), [skills](packages/coding-agent/docs/skills.md), [prompt templates](packages/coding-agent/docs/prompt-templates.md), and [themes](packages/coding-agent/docs/themes.md). Bundle them as [Pi packages](packages/coding-agent/docs/packages.md) and share via npm or git.
|
||||
|
||||
To learn more about Pi:
|
||||
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.
|
||||
|
||||
* [Visit pi.dev](https://pi.dev), the project website with demos
|
||||
* [Read the documentation](https://pi.dev/docs/latest), but you can also ask the agent to explain itself
|
||||
Use Pi [interactively](packages/coding-agent/docs/usage.md), automate it in [print or JSON mode](packages/coding-agent/docs/cli.md), control it over [RPC](packages/coding-agent/docs/rpc.md), or build apps with the [Pi TypeScript SDK](packages/coding-agent/docs/sdk.md). See [OpenClaw](https://github.com/OpenClaw/OpenClaw) for a real-world integration.
|
||||
|
||||
## All Packages
|
||||
## Getting started
|
||||
|
||||
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
|
||||
```
|
||||
|
||||
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:
|
||||
|
||||
```bash
|
||||
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](https://pi.dev/docs/latest) for full setup and usage instructions, or [visit pi.dev](https://pi.dev) for demos.
|
||||
|
||||
## Packages
|
||||
|
||||
This monorepo contains the Pi CLI and its supporting libraries.
|
||||
|
||||
| Package | Description |
|
||||
|---------|-------------|
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue