pi-extension-template

Template for building Pi packages with extensions, Agent Skills, prompts, and themes.

This repository is the template source for new Pi extension OSS projects. The published npm package is create-pi-extension, not the root pi-extension-template name.

Quick start

Primary path (recommended)

Scaffold a new project with the CLI:

bunx create-pi-extension my-pi-package

The CLI copies the bundled template, replaces placeholders, removes bootstrap docs, and can run git init plus bun install. See docs/template-checklist.md for the minimal follow-up checklist.

For a scoped package name:

bunx create-pi-extension @my-scope/my-pi-tool

Secondary path: GitHub Template

Create a repository from this template when you prefer GitHub-first onboarding:

gh repo create OWNER/my-pi-package \
  --template eiei114/pi-extension-template \
  --clone

Then follow the Secondary path section in docs/template-checklist.md for manual placeholder replacement, metadata, and post-generation cleanup.

Legacy npm package

Do not use pi install npm:pi-extension-template as the main onboarding path. Use create-pi-extension to scaffold a new project instead. The legacy root-package install will be removed from npm in a future release. After you publish your own extension, install it with pi install npm:YOUR_PACKAGE_NAME as documented in that project's README.

Repository layout

Path	Purpose
Repository root	Template source (not published to npm)
packages/create-pi-extension/	Published scaffold CLI
scaffold/	Generated-package README source synced into the bundled template
docs/	Maintainer docs and template bootstrap guides

Development

npm install
npm run ci

npm run ci runs typecheck, sync:template, CLI scaffold tests, a create-pi-extension pack check, and template sync assertions.

See CONTRIBUTING.md and docs/template-sync.md.

Release

Releases publish create-pi-extension to npm through Trusted Publishing. The root template source is not published.

See docs/release.md for setup details.

Docs

• docs/template-checklist.md — Primary vs Secondary setup flows
• docs/template-sync.md — refresh packages/create-pi-extension/template/ before CLI publish
• docs/template-sync-checklist.md — checklist for syncing and verifying the bundled template
• docs/examples.md — extension, skill, prompt, and theme examples
• docs/release.md — Trusted Publishing and monorepo publish path
• ROADMAP.md — current status, priorities, and the maintenance seed backlog

Security

Pi packages can execute code with your local permissions. Review extensions before installing third-party packages.

For vulnerability reporting, see SECURITY.md.

Links

• npm (create-pi-extension): https://www.npmjs.com/package/create-pi-extension
• GitHub: https://github.com/eiei114/pi-extension-template
• Issues: https://github.com/eiei114/pi-extension-template/issues

License

MIT