doc: Update readmes
This commit is contained in:
26
README.md
26
README.md
@@ -1,15 +1,10 @@
|
|||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://pi.dev">
|
<a href="https://pi.dev">
|
||||||
<picture>
|
<img alt="pi logo" src="https://pi.dev/logo-auto.svg" width="128">
|
||||||
<source media="(prefers-color-scheme: dark)" srcset="https://pi.dev/logo.svg">
|
|
||||||
<source media="(prefers-color-scheme: light)" srcset="https://huggingface.co/buckets/julien-c/my-training-bucket/resolve/pi-logo-dark.svg">
|
|
||||||
<img alt="pi logo" src="https://pi.dev/logo.svg" width="128">
|
|
||||||
</picture>
|
|
||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
<p align="center">
|
<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://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://github.com/earendil-works/pi-mono/actions/workflows/ci.yml"><img alt="Build status" src="https://img.shields.io/github/actions/workflow/status/earendil-works/pi-mono/ci.yml?style=flat-square&branch=main" /></a>
|
|
||||||
</p>
|
</p>
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://pi.dev">pi.dev</a> domain graciously donated by
|
<a href="https://pi.dev">pi.dev</a> domain graciously donated by
|
||||||
@@ -21,11 +16,18 @@
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Pi Monorepo
|
# Pi Agent Harness Mono Repo
|
||||||
|
|
||||||
> **Looking for the pi coding agent?** See **[packages/coding-agent](packages/coding-agent)** for installation and usage.
|
This is the home of the pi agent harness project including our self extensible coding agent.
|
||||||
|
|
||||||
Tools for building AI agents.
|
* **[@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, …)
|
||||||
|
|
||||||
|
To learn more about pi:
|
||||||
|
|
||||||
|
* [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
|
||||||
|
|
||||||
## Share your OSS coding agent sessions
|
## Share your OSS coding agent sessions
|
||||||
|
|
||||||
@@ -43,7 +45,7 @@ I regularly publish my own `pi-mono` work sessions here:
|
|||||||
|
|
||||||
- [badlogicgames/pi-mono on Hugging Face](https://huggingface.co/datasets/badlogicgames/pi-mono)
|
- [badlogicgames/pi-mono on Hugging Face](https://huggingface.co/datasets/badlogicgames/pi-mono)
|
||||||
|
|
||||||
## Packages
|
## All Packages
|
||||||
|
|
||||||
| Package | Description |
|
| Package | Description |
|
||||||
|---------|-------------|
|
|---------|-------------|
|
||||||
@@ -53,9 +55,7 @@ I regularly publish my own `pi-mono` work sessions here:
|
|||||||
| **[@earendil-works/pi-tui](packages/tui)** | Terminal UI library with differential rendering |
|
| **[@earendil-works/pi-tui](packages/tui)** | Terminal UI library with differential rendering |
|
||||||
| **[@earendil-works/pi-web-ui](packages/web-ui)** | Web components for AI chat interfaces |
|
| **[@earendil-works/pi-web-ui](packages/web-ui)** | Web components for AI chat interfaces |
|
||||||
|
|
||||||
## Chat bot workflows
|
For Slack/chat automation and workflows see [earendil-works/pi-chat](https://github.com/earendil-works/pi-chat).
|
||||||
|
|
||||||
For Slack/chat automation, see [earendil-works/pi-chat](https://github.com/earendil-works/pi-chat).
|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
|
|||||||
@@ -1,16 +1,11 @@
|
|||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://pi.dev">
|
<a href="https://pi.dev">
|
||||||
<picture>
|
<img alt="pi logo" src="https://pi.dev/logo-auto.svg" width="128">
|
||||||
<source media="(prefers-color-scheme: dark)" srcset="https://pi.dev/logo.svg">
|
|
||||||
<source media="(prefers-color-scheme: light)" srcset="https://huggingface.co/buckets/julien-c/my-training-bucket/resolve/pi-logo-dark.svg">
|
|
||||||
<img alt="pi logo" src="https://pi.dev/logo.svg" width="128">
|
|
||||||
</picture>
|
|
||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
<p align="center">
|
<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://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" /></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" /></a>
|
||||||
<a href="https://github.com/earendil-works/pi-mono/actions/workflows/ci.yml"><img alt="Build status" src="https://img.shields.io/github/actions/workflow/status/earendil-works/pi-mono/ci.yml?style=flat-square&branch=main" /></a>
|
|
||||||
</p>
|
</p>
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://pi.dev">pi.dev</a> domain graciously donated by
|
<a href="https://pi.dev">pi.dev</a> domain graciously donated by
|
||||||
@@ -72,6 +67,12 @@ I regularly publish my own `pi-mono` work sessions here:
|
|||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -fsSL https://pi.dev/install.sh | sh
|
||||||
|
```
|
||||||
|
|
||||||
|
Or with npm:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install -g @earendil-works/pi-coding-agent
|
npm install -g @earendil-works/pi-coding-agent
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -4,7 +4,13 @@ Pi is a minimal terminal coding harness. It is designed to stay small at the cor
|
|||||||
|
|
||||||
## Quick start
|
## Quick start
|
||||||
|
|
||||||
Install pi with npm:
|
On linux or mac you can install Pi with curl:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -fsSL https://pi.dev/install.sh | sh
|
||||||
|
```
|
||||||
|
|
||||||
|
Or alternatively with npm:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install -g @earendil-works/pi-coding-agent
|
npm install -g @earendil-works/pi-coding-agent
|
||||||
|
|||||||
Reference in New Issue
Block a user