Skip to content

feat(examples): make example extensions installable via pi install #1690

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

Closed
tshu-w wants to merge 1 commit into from
+13 −4
Closed

feat(examples): make example extensions installable via pi install #1690

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
4 changes: 4 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@
"tsx": "^4.20.3",
"typescript": "^5.9.2"
},
"keywords": ["pi-package"],
"pi": {
"extensions": ["./packages/coding-agent/examples/extensions"]
},
"engines": {
"node": ">=20.0.0"
},
Expand Down
13 changes: 9 additions & 4 deletions packages/coding-agent/examples/extensions/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,21 @@

Example extensions for pi-coding-agent.

## Usage
## Install

```bash
# Load an extension with --extension flag
pi --extension examples/extensions/permission-gate.ts
# Install all examples as a pi package
pi install git:github.com/badlogic/pi-mono

# Or copy to extensions directory for auto-discovery
# Or load a single extension for a one-off test
pi -e ./packages/coding-agent/examples/extensions/hello.ts

# Or copy individual extensions to your extensions directory
cp permission-gate.ts ~/.pi/agent/extensions/
```

Extensions with external dependencies (`with-deps/`, `custom-provider-*/`, `sandbox/`) need `npm install` in their directory before use.

## Examples

### Lifecycle & Safety
Expand Down