chore(vendor): import pi 1.3.0
Imported as a linear vendor commit so forge rebases do not replay the upstream root tree. git-subtree-dir: third_party/pi git-subtree-split: 71023aec1546d6d677a65669c5665c0927ce0dd0
This commit is contained in:
121
third_party/pi/README.md
vendored
121
third_party/pi/README.md
vendored
@@ -10,26 +10,75 @@
|
||||
|
||||
> 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"
|
||||
```
|
||||
|
||||
The installer pins all dependencies and updates Pi with `pi update`. Alternatively, install directly with npm, which does not pin transitive dependencies:
|
||||
|
||||
```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.
|
||||
|
||||
## Run with Nix
|
||||
|
||||
```bash
|
||||
nix run github:earendil-works/pi/stable
|
||||
```
|
||||
|
||||
`stable` points at the latest release. Install it with `nix profile add github:earendil-works/pi/stable` and update with `nix profile upgrade pi`. Use a release tag such as `github:earendil-works/pi/v1.0.0` to pin a version, or `github:earendil-works/pi` for unreleased changes on `main`. Nix builds Pi from source.
|
||||
|
||||
Supports ARM64 and x86-64 on Linux and macOS. Use `nix build .` or `nix run .` to build or run your checkout.
|
||||
|
||||
Nix builds are offline, so the bundled model data comes from a pi.dev model catalog revision pinned in `nix/model-catalog.json`. At runtime, Pi still overlays newer catalog data from pi.dev as usual. The Nix workflow replaces the pin on `main` when it no longer matches the checkout, for example after a provider is added or gains a new model type. To refresh it by hand:
|
||||
|
||||
```bash
|
||||
npm run update:model-catalog-pin
|
||||
```
|
||||
|
||||
## Packages
|
||||
|
||||
This monorepo contains the Pi CLI and its supporting libraries.
|
||||
|
||||
| Package | Description |
|
||||
|---------|-------------|
|
||||
| **[@earendil-works/chord](packages/chord)** | Standalone application-composition runtime for services, replicated state, RPC, and plugins |
|
||||
| **[@earendil-works/chord](packages/chord)** | Typed host runtime for hot-reloadable plugins, contracts, replicated state, and RPC over JSON links |
|
||||
| **[@earendil-works/pi-telemetry](packages/telemetry)** | Vendor-neutral telemetry contracts, reference adapter, conformance tests, and typed schemas |
|
||||
| **[@earendil-works/pi-ai](packages/ai)** | Unified multi-provider LLM API (OpenAI, Anthropic, Google, etc.) |
|
||||
| **[@earendil-works/pi-durable](packages/durable)** | Durable conversation, task, and document runtime |
|
||||
| **[@earendil-works/pi-agent-core](packages/agent)** | Agent runtime with tool calling and state management |
|
||||
| **[@earendil-works/pi-coding-agent](packages/coding-agent)** | Interactive coding agent CLI |
|
||||
| **[@earendil-works/pi-tui](packages/tui)** | Terminal UI library with differential rendering |
|
||||
@@ -61,6 +110,48 @@ npm run check # Lint, format, and type check
|
||||
./pi-test.sh # Run pi from sources (can be run from any directory)
|
||||
```
|
||||
|
||||
### Using local packages outside the monorepo
|
||||
|
||||
Build every public package into one coherent local artifact set:
|
||||
|
||||
```bash
|
||||
npm run pack:packages -- --out .artifacts/pi-packages
|
||||
```
|
||||
|
||||
This refreshes model data before building `pi-ai`. To avoid network access when
|
||||
model data is already hydrated, pass `--offline-model-data`.
|
||||
|
||||
Then configure an external project to consume one package and resolve all of
|
||||
its Pi dependencies from the same artifact set. npm is the default:
|
||||
|
||||
```bash
|
||||
node scripts/use-local-packages.mjs \
|
||||
--manifest .artifacts/pi-packages/manifest.json \
|
||||
--consumer ../my-project \
|
||||
--package @earendil-works/pi-durable \
|
||||
--package @earendil-works/pi-agent-core
|
||||
cd ../my-project
|
||||
npm install --ignore-scripts
|
||||
```
|
||||
|
||||
For a pnpm project, point `--consumer` at the workspace root:
|
||||
|
||||
```bash
|
||||
node scripts/use-local-packages.mjs \
|
||||
--manifest .artifacts/pi-packages/manifest.json \
|
||||
--consumer ../my-project \
|
||||
--package @earendil-works/pi-agent-core \
|
||||
--package-manager pnpm
|
||||
cd ../my-project
|
||||
pnpm install --ignore-scripts
|
||||
```
|
||||
|
||||
Repeat `--package` for each direct dependency. The command updates the
|
||||
consumer's `package.json` with content-addressed local `file:` references. It
|
||||
writes transitive overrides to `package.json` for npm or `pnpm-workspace.yaml`
|
||||
for pnpm. Keep the artifact directory available while installing or updating
|
||||
the consumer. Re-run both commands after changing Pi source.
|
||||
|
||||
## Building standalone binaries from release source
|
||||
|
||||
GitHub releases include a versioned source archive covered by the release's `SHA256SUMS` file. Extract it and run the same build script used for the official standalone binaries:
|
||||
@@ -72,7 +163,7 @@ cd "pi-${VERSION}"
|
||||
./scripts/build-binaries.sh --offline-model-data --platform linux-x64 --out "$PWD/out"
|
||||
```
|
||||
|
||||
The source archive includes the generated provider model data used for the release. `--offline-model-data` builds with that snapshot instead of refreshing it from live provider catalogs. The script still installs dependencies, builds the monorepo, compiles the Bun executable, and stages its runtime assets. Package maintainers who provide dependencies separately can pass `--skip-install --skip-deps`.
|
||||
The archive includes release model data and native prebuilds. `--offline-model-data` uses that model data without refreshing provider catalogs. The script installs dependencies and builds the executable with its runtime assets; pass `--skip-install` if dependencies are already provided.
|
||||
|
||||
## Supply-chain hardening
|
||||
|
||||
@@ -81,12 +172,12 @@ We treat npm dependency changes as reviewed code changes.
|
||||
- Direct external dependencies are pinned to exact versions. Internal workspace packages remain version-ranged.
|
||||
- `.npmrc` sets `save-exact=true` and `min-release-age=2` to avoid same-day dependency releases during npm resolution.
|
||||
- `package-lock.json` is the dependency ground truth. Pre-commit blocks accidental lockfile commits unless `PI_ALLOW_LOCKFILE_CHANGE=1` is set.
|
||||
- `npm run check` verifies pinned direct deps, native TypeScript import compatibility, and the generated coding-agent shrinkwrap.
|
||||
- The published CLI package includes `packages/coding-agent/npm-shrinkwrap.json`, generated from the root lockfile, to pin transitive deps for npm users.
|
||||
- Release smoke tests use `npm run release:local` to build, pack, and create isolated npm and Bun installs outside the repo before tagging a release.
|
||||
- `npm run check` verifies pinned direct deps, native TypeScript import compatibility, and the generated coding-agent install lock.
|
||||
- The pi.dev installer installs from `packages/coding-agent/install-lock/`, generated from the root lockfile, to pin transitive deps. The npm package does not pin transitive deps.
|
||||
- Local release smoke tests and npm publication use the same tarball packer; npm publishes the validated tarballs rather than repacking workspace directories.
|
||||
- Local release installs, documented npm installs, and `pi update --self` use `--ignore-scripts` where supported.
|
||||
- CI installs with `npm ci --ignore-scripts`, and a scheduled GitHub workflow runs `npm audit --omit=dev` plus `npm audit signatures --omit=dev`.
|
||||
- Shrinkwrap generation has an explicit allowlist for dependency lifecycle scripts; new lifecycle-script deps fail checks until reviewed.
|
||||
- Install lock generation has an explicit allowlist for dependency lifecycle scripts; new lifecycle-script deps fail checks until reviewed.
|
||||
|
||||
## Share your OSS coding agent sessions
|
||||
|
||||
|
||||
Reference in New Issue
Block a user