docs(pi): simplify fork installation instructions

Signed-off-by: Salman Mohammed <smohammed@squareup.com>
This commit is contained in:
Salman Mohammed
2026-09-09 10:02:05 -04:00
parent ef21680b70
commit 0a86962eb2
2 changed files with 15 additions and 18 deletions

View File

@@ -1,23 +1,20 @@
# Pi adapter integration
Buzz's Pi preset uses [salman1993/pi-acp](https://github.com/salman1993/pi-acp).
Install Pi separately, then build and install the adapter from source:
Requires Node.js 22 or newer. Install Pi and configure its model provider,
then install the adapter directly from the fork:
```sh
npm install -g --ignore-scripts @earendil-works/pi-coding-agent
git clone https://github.com/salman1993/pi-acp.git
cd pi-acp
git checkout b893ff9241c35fd04f27b0e9dbfa2f7bc463fc42
npm ci
npm run build
npm install -g .
npm install -g @earendil-works/pi-coding-agent
pi
npm install -g --install-links=true git+https://github.com/salman1993/pi-acp.git#main
```
Keep that checkout if npm links the global executable to it. Direct GitHub npm
installation at this revision does not build `dist/index.js`. The unscoped
`npm install -g pi-acp` command installs the upstream package, without these
extensions. Restart managed Pi agents after installing the fork; use fresh
sessions to replace old user-framed standing instructions.
Restart Buzz, then select **Pi** as the agent harness. Buzz starts `pi-acp`
automatically. Run the same adapter install command again to update it.
The unscoped `npm install -g pi-acp` command installs the upstream package,
without these extensions. Use fresh sessions to replace old user-framed
standing instructions.
Buzz adds `-- --skill <harness-cwd>/.agents/skills` when launching `pi-acp`.
An existing separator and explicit Pi options are preserved. Managed agents

View File

@@ -110,10 +110,10 @@ pub(super) const PRESET_HARNESSES: &[PresetHarness] = &[
command: "pi-acp",
args: &[],
install_instructions_url: "https://github.com/salman1993/pi-acp",
install_hint: "Install the Pi ACP adapter by cloning https://github.com/salman1993/pi-acp and running `npm ci && npm run build && npm install -g .` in the checkout.",
install_hint: "Requires Node.js 22 or newer. Install the Pi ACP adapter with `npm install -g --install-links=true git+https://github.com/salman1993/pi-acp.git#main`. Restart Buzz, then select Pi as the agent harness. Run the same install command again to update the adapter.",
underlying_cli: Some("pi"),
underlying_cli_install_hint: Some(
"Install Pi with npm install -g --ignore-scripts @earendil-works/pi-coding-agent.",
"Install Pi with `npm install -g @earendil-works/pi-coding-agent`, then run `pi` to configure its model provider.",
),
underlying_cli_install_instructions_url: Some(
"https://github.com/badlogic/pi-mono/tree/main/packages/coding-agent",
@@ -434,7 +434,7 @@ mod tests {
assert!(adapter_missing.default_args.is_empty());
assert_eq!(
adapter_missing.install_hint,
"Install the Pi ACP adapter by cloning https://github.com/salman1993/pi-acp and running `npm ci && npm run build && npm install -g .` in the checkout."
"Requires Node.js 22 or newer. Install the Pi ACP adapter with `npm install -g --install-links=true git+https://github.com/salman1993/pi-acp.git#main`. Restart Buzz, then select Pi as the agent harness. Run the same install command again to update the adapter."
);
assert_eq!(
adapter_missing.install_instructions_url,
@@ -448,7 +448,7 @@ mod tests {
assert_eq!(cli_missing.command.as_deref(), Some("pi-acp"));
assert_eq!(
cli_missing.install_hint,
"Install Pi with npm install -g --ignore-scripts @earendil-works/pi-coding-agent."
"Install Pi with `npm install -g @earendil-works/pi-coding-agent`, then run `pi` to configure its model provider."
);
assert_eq!(
cli_missing.install_instructions_url,
@@ -462,7 +462,7 @@ mod tests {
);
assert_eq!(
not_installed.install_hint,
"Install Pi with npm install -g --ignore-scripts @earendil-works/pi-coding-agent. Install the Pi ACP adapter by cloning https://github.com/salman1993/pi-acp and running `npm ci && npm run build && npm install -g .` in the checkout."
"Install Pi with `npm install -g @earendil-works/pi-coding-agent`, then run `pi` to configure its model provider. Requires Node.js 22 or newer. Install the Pi ACP adapter with `npm install -g --install-links=true git+https://github.com/salman1993/pi-acp.git#main`. Restart Buzz, then select Pi as the agent harness. Run the same install command again to update the adapter."
);
}