872b0adb48
Split flat docs/ into user-docs/ (guides, config, troubleshooting) and dev/ (ADRs, architecture, extension guides, proposals). Updated docs/README.md index to reflect new paths.
54 lines
1.3 KiB
Markdown
54 lines
1.3 KiB
Markdown
# Extension Structure & Styles
|
|
|
|
|
|
### Single File (simplest)
|
|
|
|
```
|
|
~/.gsd/agent/extensions/
|
|
└── my-extension.ts
|
|
```
|
|
|
|
### Directory with index.ts (multi-file)
|
|
|
|
```
|
|
~/.gsd/agent/extensions/
|
|
└── my-extension/
|
|
├── index.ts # Entry point (must export default function)
|
|
├── tools.ts
|
|
└── utils.ts
|
|
```
|
|
|
|
### Package with Dependencies (npm packages needed)
|
|
|
|
```
|
|
~/.gsd/agent/extensions/
|
|
└── my-extension/
|
|
├── package.json
|
|
├── package-lock.json
|
|
├── node_modules/
|
|
└── src/
|
|
└── index.ts
|
|
```
|
|
|
|
```json
|
|
// package.json
|
|
{
|
|
"name": "my-extension",
|
|
"dependencies": { "zod": "^3.0.0" },
|
|
"pi": { "extensions": ["./src/index.ts"] }
|
|
}
|
|
```
|
|
|
|
Run `npm install` in the extension directory. Imports from `node_modules/` resolve automatically.
|
|
|
|
### Available Imports
|
|
|
|
| Package | Purpose |
|
|
|---------|---------|
|
|
| `@mariozechner/pi-coding-agent` | Extension types (`ExtensionAPI`, `ExtensionContext`, event types, utilities) |
|
|
| `@sinclair/typebox` | Schema definitions for tool parameters (`Type.Object`, `Type.String`, etc.) |
|
|
| `@mariozechner/pi-ai` | AI utilities (`StringEnum` for Google-compatible enums) |
|
|
| `@mariozechner/pi-tui` | TUI components (`Text`, `Box`, `Container`, `SelectList`, etc.) |
|
|
| Node.js built-ins | `node:fs`, `node:path`, `node:child_process`, etc. |
|
|
|
|
---
|