Skip to content

Document published Foreman core and Pi bridge installation #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JARosen merged 1 commit into from
Oct 7, 2026
Merged

Document published Foreman core and Pi bridge installation #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,7 +402,8 @@ The [Pi and Pi Durable bridges](integrations/pi/README.md) forward native extens
task hooks to the same runtime. They include prompt routing, tool supervision, completion
continuations, and a Durable replay contract. Pi supervision requires both `foreman-core` and the
separate TypeScript bridge; installing the Python core alone does not load the Pi extension.
See the bridge guide for npm installation after publication and building from source today.
Install the published bridge with `pi install npm:@thruwire/foreman-pi`.
See the bridge guide for Pi Durable setup and building from source.

## Persistence and inspection

Expand Down
4 changes: 2 additions & 2 deletions docs/releasing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,6 @@ Durable import in a separate installation before publishing.

After publication, confirm `npm view @thruwire/foreman-pi@0.1.0 version` and
`pi install npm:@thruwire/foreman-pi@0.1.0` in an isolated Pi configuration. Remove
the conditional "once published" language in the installation guides only
after verifying the releases. The existing `release.yml` workflow publishes
outdated installation language only after verifying the releases. The existing
`release.yml` workflow publishes
the Python core only; an npm release still needs the manual steps above.
2 changes: 1 addition & 1 deletion integrations/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ are available to marketplace discovery before installation.
`foreman hook --client pi` and `foreman hook --client pi-durable` respectively. This is a local
integration package with installation documentation and offline tests. Pi supervision requires
the TypeScript bridge in addition to `foreman-core`; the guide covers source installation and
npm installation once the package is published.
installation from the published `@thruwire/foreman-pi` npm package.
- [`claude/`](claude/) reserves the future Claude Code integration location. It is not currently an
installable plugin.
10 changes: 5 additions & 5 deletions integrations/pi/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,19 @@ TypeScript bridge. Installing `foreman-core` alone does not load an extension
into Pi. The bridge invokes the `foreman` executable; it does not bundle Python
or install the core automatically.

The first npm release requires `foreman-core` **0.4.4 or newer**. Version 0.4.3
predates the Pi adapters. Until 0.4.4 is published to PyPI, use the source
installation below for the core as well as the bridge.
The bridge requires `foreman-core` **0.4.4 or newer**. Version 0.4.3 predates
the Pi adapters.

After the core release is published, install it with:
Install the core with:

```bash
pipx install 'foreman-core>=0.4.4'
```

### npm installation

Once `@thruwire/foreman-pi` has been published to npm, install it into Pi with:
Install the published [`@thruwire/foreman-pi`](https://www.npmjs.com/package/@thruwire/foreman-pi)
package into Pi with:

```bash
pi install npm:@thruwire/foreman-pi
Expand Down
Loading