@eminent337/aery 0.67.68
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +3768 -0
- package/README.md +623 -0
- package/docs/compaction.md +394 -0
- package/docs/custom-provider.md +637 -0
- package/docs/development.md +71 -0
- package/docs/extensions.md +2368 -0
- package/docs/images/doom-extension.png +0 -0
- package/docs/images/exy.png +0 -0
- package/docs/images/interactive-mode.png +0 -0
- package/docs/images/tree-view.png +0 -0
- package/docs/json.md +82 -0
- package/docs/keybindings.md +197 -0
- package/docs/models.md +395 -0
- package/docs/packages.md +218 -0
- package/docs/prompt-templates.md +88 -0
- package/docs/providers.md +195 -0
- package/docs/rpc.md +1407 -0
- package/docs/sdk.md +1149 -0
- package/docs/session.md +412 -0
- package/docs/settings.md +247 -0
- package/docs/shell-aliases.md +13 -0
- package/docs/skills.md +232 -0
- package/docs/terminal-setup.md +106 -0
- package/docs/termux.md +127 -0
- package/docs/themes.md +295 -0
- package/docs/tmux.md +61 -0
- package/docs/tree.md +233 -0
- package/docs/tui.md +918 -0
- package/docs/windows.md +17 -0
- package/examples/README.md +25 -0
- package/examples/extensions/README.md +208 -0
- package/examples/extensions/antigravity-image-gen.ts +418 -0
- package/examples/extensions/auto-commit-on-exit.ts +49 -0
- package/examples/extensions/bash-spawn-hook.ts +30 -0
- package/examples/extensions/bookmark.ts +50 -0
- package/examples/extensions/built-in-tool-renderer.ts +249 -0
- package/examples/extensions/claude-rules.ts +86 -0
- package/examples/extensions/commands.ts +72 -0
- package/examples/extensions/confirm-destructive.ts +59 -0
- package/examples/extensions/custom-compaction.ts +127 -0
- package/examples/extensions/custom-footer.ts +64 -0
- package/examples/extensions/custom-header.ts +73 -0
- package/examples/extensions/custom-provider-anthropic/index.ts +604 -0
- package/examples/extensions/custom-provider-anthropic/package-lock.json +24 -0
- package/examples/extensions/custom-provider-anthropic/package.json +19 -0
- package/examples/extensions/custom-provider-gitlab-duo/index.ts +349 -0
- package/examples/extensions/custom-provider-gitlab-duo/package.json +16 -0
- package/examples/extensions/custom-provider-gitlab-duo/test.ts +82 -0
- package/examples/extensions/custom-provider-qwen-cli/index.ts +345 -0
- package/examples/extensions/custom-provider-qwen-cli/package.json +16 -0
- package/examples/extensions/dirty-repo-guard.ts +56 -0
- package/examples/extensions/doom-overlay/README.md +46 -0
- package/examples/extensions/doom-overlay/doom/build/doom.js +21 -0
- package/examples/extensions/doom-overlay/doom/build/doom.wasm +0 -0
- package/examples/extensions/doom-overlay/doom/build.sh +152 -0
- package/examples/extensions/doom-overlay/doom/doomgeneric_pi.c +72 -0
- package/examples/extensions/doom-overlay/doom-component.ts +132 -0
- package/examples/extensions/doom-overlay/doom-engine.ts +173 -0
- package/examples/extensions/doom-overlay/doom-keys.ts +104 -0
- package/examples/extensions/doom-overlay/index.ts +74 -0
- package/examples/extensions/doom-overlay/wad-finder.ts +51 -0
- package/examples/extensions/dynamic-resources/SKILL.md +8 -0
- package/examples/extensions/dynamic-resources/dynamic.json +79 -0
- package/examples/extensions/dynamic-resources/dynamic.md +5 -0
- package/examples/extensions/dynamic-resources/index.ts +15 -0
- package/examples/extensions/dynamic-tools.ts +74 -0
- package/examples/extensions/event-bus.ts +43 -0
- package/examples/extensions/file-trigger.ts +41 -0
- package/examples/extensions/git-checkpoint.ts +53 -0
- package/examples/extensions/handoff.ts +153 -0
- package/examples/extensions/hello.ts +26 -0
- package/examples/extensions/hidden-thinking-label.ts +53 -0
- package/examples/extensions/inline-bash.ts +94 -0
- package/examples/extensions/input-transform.ts +43 -0
- package/examples/extensions/interactive-shell.ts +196 -0
- package/examples/extensions/mac-system-theme.ts +47 -0
- package/examples/extensions/message-renderer.ts +59 -0
- package/examples/extensions/minimal-mode.ts +426 -0
- package/examples/extensions/modal-editor.ts +85 -0
- package/examples/extensions/model-status.ts +31 -0
- package/examples/extensions/notify.ts +55 -0
- package/examples/extensions/overlay-qa-tests.ts +1348 -0
- package/examples/extensions/overlay-test.ts +150 -0
- package/examples/extensions/permission-gate.ts +34 -0
- package/examples/extensions/pirate.ts +47 -0
- package/examples/extensions/plan-mode/README.md +65 -0
- package/examples/extensions/plan-mode/index.ts +340 -0
- package/examples/extensions/plan-mode/utils.ts +168 -0
- package/examples/extensions/preset.ts +430 -0
- package/examples/extensions/protected-paths.ts +30 -0
- package/examples/extensions/provider-payload.ts +18 -0
- package/examples/extensions/qna.ts +122 -0
- package/examples/extensions/question.ts +264 -0
- package/examples/extensions/questionnaire.ts +427 -0
- package/examples/extensions/rainbow-editor.ts +88 -0
- package/examples/extensions/reload-runtime.ts +37 -0
- package/examples/extensions/rpc-demo.ts +118 -0
- package/examples/extensions/sandbox/index.ts +321 -0
- package/examples/extensions/sandbox/package-lock.json +92 -0
- package/examples/extensions/sandbox/package.json +19 -0
- package/examples/extensions/send-user-message.ts +97 -0
- package/examples/extensions/session-name.ts +27 -0
- package/examples/extensions/shutdown-command.ts +63 -0
- package/examples/extensions/snake.ts +343 -0
- package/examples/extensions/space-invaders.ts +560 -0
- package/examples/extensions/ssh.ts +220 -0
- package/examples/extensions/status-line.ts +32 -0
- package/examples/extensions/subagent/README.md +172 -0
- package/examples/extensions/subagent/agents/planner.md +37 -0
- package/examples/extensions/subagent/agents/reviewer.md +35 -0
- package/examples/extensions/subagent/agents/scout.md +50 -0
- package/examples/extensions/subagent/agents/worker.md +24 -0
- package/examples/extensions/subagent/agents.ts +126 -0
- package/examples/extensions/subagent/index.ts +987 -0
- package/examples/extensions/subagent/prompts/implement-and-review.md +10 -0
- package/examples/extensions/subagent/prompts/implement.md +10 -0
- package/examples/extensions/subagent/prompts/scout-and-plan.md +9 -0
- package/examples/extensions/summarize.ts +206 -0
- package/examples/extensions/system-prompt-header.ts +17 -0
- package/examples/extensions/tic-tac-toe.ts +1008 -0
- package/examples/extensions/timed-confirm.ts +70 -0
- package/examples/extensions/titlebar-spinner.ts +58 -0
- package/examples/extensions/todo.ts +297 -0
- package/examples/extensions/tool-override.ts +144 -0
- package/examples/extensions/tools.ts +141 -0
- package/examples/extensions/trigger-compact.ts +50 -0
- package/examples/extensions/truncated-tool.ts +195 -0
- package/examples/extensions/widget-placement.ts +9 -0
- package/examples/extensions/with-deps/index.ts +32 -0
- package/examples/extensions/with-deps/package-lock.json +31 -0
- package/examples/extensions/with-deps/package.json +22 -0
- package/examples/extensions/working-indicator.ts +123 -0
- package/examples/rpc-extension-ui.ts +632 -0
- package/examples/sdk/01-minimal.ts +22 -0
- package/examples/sdk/02-custom-model.ts +49 -0
- package/examples/sdk/03-custom-prompt.ts +62 -0
- package/examples/sdk/04-skills.ts +55 -0
- package/examples/sdk/05-tools.ts +44 -0
- package/examples/sdk/06-extensions.ts +90 -0
- package/examples/sdk/07-context-files.ts +42 -0
- package/examples/sdk/08-prompt-templates.ts +51 -0
- package/examples/sdk/09-api-keys-and-oauth.ts +48 -0
- package/examples/sdk/10-settings.ts +53 -0
- package/examples/sdk/11-sessions.ts +48 -0
- package/examples/sdk/12-full-control.ts +73 -0
- package/examples/sdk/13-session-runtime.ts +67 -0
- package/examples/sdk/README.md +147 -0
- package/package.json +102 -0
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
# SDK Examples
|
|
2
|
+
|
|
3
|
+
Programmatic usage of pi-coding-agent via `createAgentSession()` and `createAgentSessionRuntime()`.
|
|
4
|
+
|
|
5
|
+
The runtime example shows how to build a recreate function that closes over process-global fixed inputs and recreates cwd-bound services and sessions as the active session cwd changes.
|
|
6
|
+
|
|
7
|
+
## Examples
|
|
8
|
+
|
|
9
|
+
| File | Description |
|
|
10
|
+
|------|-------------|
|
|
11
|
+
| `01-minimal.ts` | Simplest usage with all defaults |
|
|
12
|
+
| `02-custom-model.ts` | Select model and thinking level |
|
|
13
|
+
| `03-custom-prompt.ts` | Replace or modify system prompt |
|
|
14
|
+
| `04-skills.ts` | Discover, filter, or replace skills |
|
|
15
|
+
| `05-tools.ts` | Built-in tools, custom tools |
|
|
16
|
+
| `06-extensions.ts` | Logging, blocking, result modification |
|
|
17
|
+
| `07-context-files.ts` | AGENTS.md context files |
|
|
18
|
+
| `08-slash-commands.ts` | File-based slash commands |
|
|
19
|
+
| `09-api-keys-and-oauth.ts` | API key resolution, OAuth config |
|
|
20
|
+
| `10-settings.ts` | Override compaction, retry, terminal settings |
|
|
21
|
+
| `11-sessions.ts` | In-memory, persistent, continue, list sessions |
|
|
22
|
+
| `12-full-control.ts` | Replace everything, no discovery |
|
|
23
|
+
| `13-session-runtime.ts` | Manage runtime-backed session replacement |
|
|
24
|
+
|
|
25
|
+
## Running
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
cd packages/coding-agent
|
|
29
|
+
npx tsx examples/sdk/01-minimal.ts
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Quick Reference
|
|
33
|
+
|
|
34
|
+
```typescript
|
|
35
|
+
import { getModel } from "@mariozechner/pi-ai";
|
|
36
|
+
import {
|
|
37
|
+
AuthStorage,
|
|
38
|
+
createAgentSession,
|
|
39
|
+
DefaultResourceLoader,
|
|
40
|
+
ModelRegistry,
|
|
41
|
+
SessionManager,
|
|
42
|
+
SettingsManager,
|
|
43
|
+
codingTools,
|
|
44
|
+
readOnlyTools,
|
|
45
|
+
readTool, bashTool, editTool, writeTool,
|
|
46
|
+
} from "@mariozechner/pi-coding-agent";
|
|
47
|
+
|
|
48
|
+
// Auth and models setup
|
|
49
|
+
const authStorage = AuthStorage.create();
|
|
50
|
+
const modelRegistry = ModelRegistry.create(authStorage);
|
|
51
|
+
|
|
52
|
+
// Minimal
|
|
53
|
+
const { session } = await createAgentSession({ authStorage, modelRegistry });
|
|
54
|
+
|
|
55
|
+
// Custom model
|
|
56
|
+
const model = getModel("anthropic", "claude-opus-4-5");
|
|
57
|
+
const { session } = await createAgentSession({ model, thinkingLevel: "high", authStorage, modelRegistry });
|
|
58
|
+
|
|
59
|
+
// Modify prompt
|
|
60
|
+
const loader = new DefaultResourceLoader({
|
|
61
|
+
systemPromptOverride: (base) => `${base}\n\nBe concise.`,
|
|
62
|
+
});
|
|
63
|
+
await loader.reload();
|
|
64
|
+
const { session } = await createAgentSession({ resourceLoader: loader, authStorage, modelRegistry });
|
|
65
|
+
|
|
66
|
+
// Read-only
|
|
67
|
+
const { session } = await createAgentSession({ tools: readOnlyTools, authStorage, modelRegistry });
|
|
68
|
+
|
|
69
|
+
// In-memory
|
|
70
|
+
const { session } = await createAgentSession({
|
|
71
|
+
sessionManager: SessionManager.inMemory(),
|
|
72
|
+
authStorage,
|
|
73
|
+
modelRegistry,
|
|
74
|
+
});
|
|
75
|
+
|
|
76
|
+
// Full control
|
|
77
|
+
const customAuth = AuthStorage.create("/my/app/auth.json");
|
|
78
|
+
customAuth.setRuntimeApiKey("anthropic", process.env.MY_KEY!);
|
|
79
|
+
const customRegistry = ModelRegistry.create(customAuth);
|
|
80
|
+
|
|
81
|
+
const resourceLoader = new DefaultResourceLoader({
|
|
82
|
+
systemPromptOverride: () => "You are helpful.",
|
|
83
|
+
extensionFactories: [myExtension],
|
|
84
|
+
skillsOverride: () => ({ skills: [], diagnostics: [] }),
|
|
85
|
+
agentsFilesOverride: () => ({ agentsFiles: [] }),
|
|
86
|
+
promptsOverride: () => ({ prompts: [], diagnostics: [] }),
|
|
87
|
+
});
|
|
88
|
+
await resourceLoader.reload();
|
|
89
|
+
|
|
90
|
+
const { session } = await createAgentSession({
|
|
91
|
+
model,
|
|
92
|
+
authStorage: customAuth,
|
|
93
|
+
modelRegistry: customRegistry,
|
|
94
|
+
resourceLoader,
|
|
95
|
+
tools: [readTool, bashTool],
|
|
96
|
+
customTools: [{ tool: myTool }],
|
|
97
|
+
sessionManager: SessionManager.inMemory(),
|
|
98
|
+
settingsManager: SettingsManager.inMemory(),
|
|
99
|
+
});
|
|
100
|
+
|
|
101
|
+
// Run prompts
|
|
102
|
+
session.subscribe((event) => {
|
|
103
|
+
if (event.type === "message_update" && event.assistantMessageEvent.type === "text_delta") {
|
|
104
|
+
process.stdout.write(event.assistantMessageEvent.delta);
|
|
105
|
+
}
|
|
106
|
+
});
|
|
107
|
+
await session.prompt("Hello");
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
## Options
|
|
111
|
+
|
|
112
|
+
| Option | Default | Description |
|
|
113
|
+
|--------|---------|-------------|
|
|
114
|
+
| `authStorage` | `AuthStorage.create()` | Credential storage |
|
|
115
|
+
| `modelRegistry` | `ModelRegistry.create(authStorage)` | Model registry |
|
|
116
|
+
| `cwd` | `process.cwd()` | Working directory |
|
|
117
|
+
| `agentDir` | `~/.pi/agent` | Config directory |
|
|
118
|
+
| `model` | From settings/first available | Model to use |
|
|
119
|
+
| `thinkingLevel` | From settings/"off" | off, low, medium, high |
|
|
120
|
+
| `tools` | `codingTools` | Built-in tools |
|
|
121
|
+
| `customTools` | `[]` | Additional tool definitions |
|
|
122
|
+
| `resourceLoader` | DefaultResourceLoader | Resource loader for extensions, skills, prompts, themes |
|
|
123
|
+
| `sessionManager` | `SessionManager.create(cwd)` | Persistence |
|
|
124
|
+
| `settingsManager` | `SettingsManager.create(cwd, agentDir)` | Settings overrides |
|
|
125
|
+
|
|
126
|
+
## Events
|
|
127
|
+
|
|
128
|
+
```typescript
|
|
129
|
+
session.subscribe((event) => {
|
|
130
|
+
switch (event.type) {
|
|
131
|
+
case "message_update":
|
|
132
|
+
if (event.assistantMessageEvent.type === "text_delta") {
|
|
133
|
+
process.stdout.write(event.assistantMessageEvent.delta);
|
|
134
|
+
}
|
|
135
|
+
break;
|
|
136
|
+
case "tool_execution_start":
|
|
137
|
+
console.log(`Tool: ${event.toolName}`);
|
|
138
|
+
break;
|
|
139
|
+
case "tool_execution_end":
|
|
140
|
+
console.log(`Result: ${event.result}`);
|
|
141
|
+
break;
|
|
142
|
+
case "agent_end":
|
|
143
|
+
console.log("Done");
|
|
144
|
+
break;
|
|
145
|
+
}
|
|
146
|
+
});
|
|
147
|
+
```
|
package/package.json
ADDED
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@eminent337/aery",
|
|
3
|
+
"version": "0.67.68",
|
|
4
|
+
"description": "Aery \u2014 AI coding agent by Aryee",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"piConfig": {
|
|
7
|
+
"name": "aery",
|
|
8
|
+
"configDir": ".aery"
|
|
9
|
+
},
|
|
10
|
+
"bin": {
|
|
11
|
+
"aery": "dist/cli.js"
|
|
12
|
+
},
|
|
13
|
+
"main": "./dist/index.js",
|
|
14
|
+
"types": "./dist/index.d.ts",
|
|
15
|
+
"exports": {
|
|
16
|
+
".": {
|
|
17
|
+
"types": "./dist/index.d.ts",
|
|
18
|
+
"import": "./dist/index.js"
|
|
19
|
+
},
|
|
20
|
+
"./hooks": {
|
|
21
|
+
"types": "./dist/core/hooks/index.d.ts",
|
|
22
|
+
"import": "./dist/core/hooks/index.js"
|
|
23
|
+
}
|
|
24
|
+
},
|
|
25
|
+
"files": [
|
|
26
|
+
"dist",
|
|
27
|
+
"docs",
|
|
28
|
+
"examples",
|
|
29
|
+
"CHANGELOG.md"
|
|
30
|
+
],
|
|
31
|
+
"scripts": {
|
|
32
|
+
"clean": "shx rm -rf dist",
|
|
33
|
+
"dev": "tsgo -p tsconfig.build.json --watch --preserveWatchOutput",
|
|
34
|
+
"build": "npx tsgo -p tsconfig.build.json && shx chmod +x dist/cli.js && npm run copy-assets",
|
|
35
|
+
"build:binary": "npm --prefix ../tui run build && npm --prefix ../ai run build && npm --prefix ../agent run build && npm run build && bun build --compile ./dist/bun/cli.js --outfile dist/pi && npm run copy-binary-assets",
|
|
36
|
+
"copy-assets": "shx mkdir -p dist/modes/interactive/theme && shx cp src/modes/interactive/theme/*.json dist/modes/interactive/theme/ && shx mkdir -p dist/modes/interactive/assets && shx cp src/modes/interactive/assets/*.png dist/modes/interactive/assets/ && shx mkdir -p dist/core/export-html/vendor && shx cp src/core/export-html/template.html src/core/export-html/template.css src/core/export-html/template.js dist/core/export-html/ && shx cp src/core/export-html/vendor/*.js dist/core/export-html/vendor/",
|
|
37
|
+
"copy-binary-assets": "shx cp package.json dist/ && shx cp README.md dist/ && shx cp CHANGELOG.md dist/ && shx mkdir -p dist/theme && shx cp src/modes/interactive/theme/*.json dist/theme/ && shx mkdir -p dist/assets && shx cp src/modes/interactive/assets/*.png dist/assets/ && shx mkdir -p dist/export-html/vendor && shx cp src/core/export-html/template.html dist/export-html/ && shx cp src/core/export-html/vendor/*.js dist/export-html/vendor/ && shx cp -r docs dist/ && shx cp -r examples dist/ && shx cp ../../node_modules/@silvia-odwyer/photon-node/photon_rs_bg.wasm dist/",
|
|
38
|
+
"test": "vitest --run",
|
|
39
|
+
"prepublishOnly": "npm run clean && ../../node_modules/.bin/tsgo -p tsconfig.build.json && ../../node_modules/.bin/shx chmod +x dist/cli.js && npm run copy-assets"
|
|
40
|
+
},
|
|
41
|
+
"dependencies": {
|
|
42
|
+
"@mariozechner/jiti": "2.6.2",
|
|
43
|
+
"@aryee/aery-core": "0.67.68",
|
|
44
|
+
"@aryee/aery-ai": "0.67.68",
|
|
45
|
+
"@aryee/aery-tui": "0.67.68",
|
|
46
|
+
"@silvia-odwyer/photon-node": "^0.3.4",
|
|
47
|
+
"@sinclair/typebox": "^0.34.41",
|
|
48
|
+
"ajv": "^8.17.1",
|
|
49
|
+
"chalk": "^5.5.0",
|
|
50
|
+
"cli-highlight": "^2.1.11",
|
|
51
|
+
"diff": "^8.0.2",
|
|
52
|
+
"extract-zip": "^2.0.1",
|
|
53
|
+
"file-type": "^21.1.1",
|
|
54
|
+
"glob": "^13.0.1",
|
|
55
|
+
"hosted-git-info": "^9.0.2",
|
|
56
|
+
"ignore": "^7.0.5",
|
|
57
|
+
"marked": "^15.0.12",
|
|
58
|
+
"minimatch": "^10.2.3",
|
|
59
|
+
"proper-lockfile": "^4.1.2",
|
|
60
|
+
"strip-ansi": "^7.1.0",
|
|
61
|
+
"undici": "^7.19.1",
|
|
62
|
+
"uuid": "^11.1.0",
|
|
63
|
+
"yaml": "^2.8.2"
|
|
64
|
+
},
|
|
65
|
+
"overrides": {
|
|
66
|
+
"rimraf": "6.1.2",
|
|
67
|
+
"gaxios": {
|
|
68
|
+
"rimraf": "6.1.2"
|
|
69
|
+
}
|
|
70
|
+
},
|
|
71
|
+
"optionalDependencies": {
|
|
72
|
+
"@mariozechner/clipboard": "0.3.2"
|
|
73
|
+
},
|
|
74
|
+
"devDependencies": {
|
|
75
|
+
"@types/diff": "^7.0.2",
|
|
76
|
+
"@types/hosted-git-info": "^3.0.5",
|
|
77
|
+
"@types/ms": "^2.1.0",
|
|
78
|
+
"@types/node": "^24.3.0",
|
|
79
|
+
"@types/proper-lockfile": "^4.1.4",
|
|
80
|
+
"shx": "^0.4.0",
|
|
81
|
+
"typescript": "^5.7.3",
|
|
82
|
+
"vitest": "^3.2.4"
|
|
83
|
+
},
|
|
84
|
+
"keywords": [
|
|
85
|
+
"coding-agent",
|
|
86
|
+
"ai",
|
|
87
|
+
"llm",
|
|
88
|
+
"cli",
|
|
89
|
+
"tui",
|
|
90
|
+
"agent"
|
|
91
|
+
],
|
|
92
|
+
"author": "Aryee",
|
|
93
|
+
"license": "MIT",
|
|
94
|
+
"repository": {
|
|
95
|
+
"type": "git",
|
|
96
|
+
"url": "git+https://github.com/eminent337/aery.git",
|
|
97
|
+
"directory": "packages/coding-agent"
|
|
98
|
+
},
|
|
99
|
+
"engines": {
|
|
100
|
+
"node": ">=20.6.0"
|
|
101
|
+
}
|
|
102
|
+
}
|