mirror of
https://github.com/badlogic/pi-mono.git
synced 2026-11-05 23:37:25 +00:00
25cc5c7bf4
* docs(coding-agent): improve getting started documentation * docs(coding-agent): correct getting started details * docs(coding-agent): clarify SDK entry point * docs(coding-agent): restructure guides and references * docs(coding-agent): improve getting started guides * docs(coding-agent): refresh integration guides * docs(coding-agent): improve terminal and CLI guides * docs(coding-agent): refresh customisation guides * docs(coding-agent): clarify project trust terminology * docs(coding-agent): simplify customisation guidance * docs(coding-agent): improve runtime and reference guidance * Fix settings reference * feat(coding-agent): add Crowdin documentation sync * docs(coding-agent): separate CLI and slash command references * docs(coding-agent): correct compaction reference * docs(coding-agent): streamline package documentation * docs(coding-agent): split RPC reference documentation * Update configuration docs * Shorten config docs * docs(coding-agent): refine configuration references * docs(coding-agent): streamline settings reference * docs(coding-agent): clarify configuration reference * docs(coding-agent): clarify project trust exception * docs(coding-agent): simplify keybindings reference * docs(coding-agent): remove Crowdin integration * docs(coding-agent): turn themes reference into guide * docs(coding-agent): consolidate model and authentication docs * docs(tui): require Component.invalidate() (fixes #9358) * docs(coding-agent): document offline catalog behavior (fixes #8684) * docs(coding-agent): preserve established documentation routes * docs(coding-agent): reorganize documentation navigation * docs(coding-agent): correct audited behavior Clarify provider, session, local-model, Termux, TUI, SDK, debug, and extension behavior. Simplify the documentation audit to report only clear user-visible contradictions. * docs(coding-agent): fix broken documentation links
70 lines
2.4 KiB
Markdown
70 lines
2.4 KiB
Markdown
<p align="center">
|
|
<a href="https://pi.dev">
|
|
<img alt="Pi logo" src="https://pi.dev/logo-auto.svg" width="128">
|
|
</a>
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://discord.com/invite/3cU7Bz4UPx"><img alt="Discord" src="https://img.shields.io/badge/discord-community-5865F2?style=flat-square&logo=discord&logoColor=white" /></a>
|
|
<a href="https://www.npmjs.com/package/@earendil-works/pi-coding-agent"><img alt="npm" src="https://img.shields.io/npm/v/@earendil-works/pi-coding-agent?style=flat-square&logo=npm&logoColor=white" /></a>
|
|
</p>
|
|
|
|
> New issues and PRs from new contributors are closed automatically. Maintainers review closed submissions daily. See [CONTRIBUTING.md](https://github.com/earendil-works/pi/blob/main/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:
|
|
|
|
```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
|
|
```
|
|
|
|
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](docs/index.md) for full setup and usage instructions.
|
|
|
|
## Development
|
|
|
|
Clone the repository, install its dependencies, and run Pi from source:
|
|
|
|
```bash
|
|
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:
|
|
|
|
```bash
|
|
npm run check
|
|
./test.sh
|
|
```
|
|
|
|
Read [CONTRIBUTING.md](https://github.com/earendil-works/pi/blob/main/CONTRIBUTING.md) before opening an issue or pull request. It defines the contribution gate, issue quality bar, and required checks. Read [AGENTS.md](https://github.com/earendil-works/pi/blob/main/AGENTS.md) for repository-specific implementation, testing, dependency, and release rules.
|
|
|
|
## License
|
|
|
|
MIT
|