@quickcall/krew 0.1.0 → 0.1.7
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/README.md +73 -538
- package/dist/core/agent-session-runtime.d.ts.map +1 -1
- package/dist/core/agent-session-runtime.js +3 -0
- package/dist/core/agent-session-runtime.js.map +1 -1
- package/dist/core/extensions/types.d.ts +1 -1
- package/dist/core/extensions/types.d.ts.map +1 -1
- package/dist/core/extensions/types.js.map +1 -1
- package/dist/core/system-prompt.d.ts.map +1 -1
- package/dist/core/system-prompt.js +5 -5
- package/dist/core/system-prompt.js.map +1 -1
- package/dist/modes/interactive/interactive-mode.d.ts.map +1 -1
- package/dist/modes/interactive/interactive-mode.js +1 -1
- package/dist/modes/interactive/interactive-mode.js.map +1 -1
- package/dist/modes/interactive/theme/theme-schema.json +2 -2
- package/dist/utils/pi-user-agent.d.ts.map +1 -1
- package/dist/utils/pi-user-agent.js +1 -1
- package/dist/utils/pi-user-agent.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,418 +1,120 @@
|
|
|
1
1
|
<p align="center">
|
|
2
|
-
<a href="https://
|
|
3
|
-
<img alt="pi logo" src="https://pi.dev/logo-auto.svg" width="128">
|
|
4
|
-
</a>
|
|
2
|
+
<a href="https://www.npmjs.com/package/@quickcall/krew"><img alt="npm" src="https://img.shields.io/npm/v/@quickcall/krew?style=flat-square" /></a>
|
|
5
3
|
</p>
|
|
6
|
-
<p align="center">
|
|
7
|
-
<a href="https://discord.com/invite/3cU7Bz4UPx"><img alt="Discord" src="https://img.shields.io/badge/discord-community-5865F2?style=flat-square&logo=discord&logoColor=white" /></a>
|
|
8
|
-
<a href="https://www.npmjs.com/package/@earendil-works/pi-coding-agent"><img alt="npm" src="https://img.shields.io/npm/v/@earendil-works/pi-coding-agent?style=flat-square" /></a>
|
|
9
|
-
</p>
|
|
10
|
-
<p align="center">
|
|
11
|
-
<a href="https://pi.dev">pi.dev</a> domain graciously donated by
|
|
12
|
-
<br /><br />
|
|
13
|
-
<a href="https://exe.dev"><img src="docs/images/exy.png" alt="Exy mascot" width="48" /><br />exe.dev</a>
|
|
14
|
-
</p>
|
|
15
|
-
|
|
16
|
-
> New issues and PRs from new contributors are auto-closed by default. Maintainers review auto-closed issues daily. See [CONTRIBUTING.md](../../CONTRIBUTING.md).
|
|
17
|
-
|
|
18
|
-
---
|
|
19
|
-
|
|
20
|
-
Pi is a minimal terminal coding harness. Adapt pi to your workflows, not the other way around, without having to fork and modify pi internals. Extend it with TypeScript [Extensions](#extensions), [Skills](#skills), [Prompt Templates](#prompt-templates), and [Themes](#themes). Put your extensions, skills, prompt templates, and themes in [Pi Packages](#pi-packages) and share them with others via npm or git.
|
|
21
|
-
|
|
22
|
-
Pi ships with powerful defaults but skips features like sub agents and plan mode. Instead, you can ask pi to build what you want or install a third party pi package that matches your workflow.
|
|
23
|
-
|
|
24
|
-
Pi runs in four modes: interactive, print or JSON, RPC for process integration, and an SDK for embedding in your own apps. See [openclaw/openclaw](https://github.com/openclaw/openclaw) for a real-world SDK integration.
|
|
25
4
|
|
|
26
|
-
|
|
5
|
+
# QuickCall Krew
|
|
27
6
|
|
|
28
|
-
|
|
7
|
+
QuickCall Krew is a minimal, extensible terminal coding agent. It gives a model a small set of tools (`read`, `write`, `edit`, `bash`, and more) and a clean interactive TUI, then gets out of the way so you can shape it to your workflow with extensions, skills, prompt templates, and themes.
|
|
29
8
|
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
For the full explanation, see [this post on X](https://x.com/badlogicgames/status/2037811643774652911).
|
|
33
|
-
|
|
34
|
-
To publish sessions, use [`badlogic/pi-share-hf`](https://github.com/badlogic/pi-share-hf). Read its README.md for setup instructions. All you need is a Hugging Face account, the Hugging Face CLI, and `pi-share-hf`.
|
|
35
|
-
|
|
36
|
-
You can also watch [this video](https://x.com/badlogicgames/status/2041151967695634619), where I show how I publish my `pi-mono` sessions.
|
|
37
|
-
|
|
38
|
-
I regularly publish my own `pi-mono` work sessions here:
|
|
39
|
-
|
|
40
|
-
- [badlogicgames/pi-mono on Hugging Face](https://huggingface.co/datasets/badlogicgames/pi-mono)
|
|
41
|
-
|
|
42
|
-
## Table of Contents
|
|
43
|
-
|
|
44
|
-
- [Quick Start](#quick-start)
|
|
45
|
-
- [Providers & Models](#providers--models)
|
|
46
|
-
- [Interactive Mode](#interactive-mode)
|
|
47
|
-
- [Editor](#editor)
|
|
48
|
-
- [Commands](#commands)
|
|
49
|
-
- [Keyboard Shortcuts](#keyboard-shortcuts)
|
|
50
|
-
- [Message Queue](#message-queue)
|
|
51
|
-
- [Sessions](#sessions)
|
|
52
|
-
- [Branching](#branching)
|
|
53
|
-
- [Compaction](#compaction)
|
|
54
|
-
- [Settings](#settings)
|
|
55
|
-
- [Context Files](#context-files)
|
|
56
|
-
- [Customization](#customization)
|
|
57
|
-
- [Prompt Templates](#prompt-templates)
|
|
58
|
-
- [Skills](#skills)
|
|
59
|
-
- [Extensions](#extensions)
|
|
60
|
-
- [Themes](#themes)
|
|
61
|
-
- [Pi Packages](#pi-packages)
|
|
62
|
-
- [Programmatic Usage](#programmatic-usage)
|
|
63
|
-
- [Philosophy](#philosophy)
|
|
64
|
-
- [CLI Reference](#cli-reference)
|
|
65
|
-
|
|
66
|
-
---
|
|
9
|
+
> QuickCall Krew is a fork of the [Pi](https://pi.dev) coding agent harness, adapted for QuickCall's hiring workflows.
|
|
67
10
|
|
|
68
11
|
## Quick Start
|
|
69
12
|
|
|
70
|
-
|
|
71
|
-
curl -fsSL https://pi.dev/install.sh | sh
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
Or with npm:
|
|
13
|
+
Install globally:
|
|
75
14
|
|
|
76
15
|
```bash
|
|
77
|
-
npm install -g @
|
|
16
|
+
npm install -g @quickcall/krew
|
|
78
17
|
```
|
|
79
18
|
|
|
80
|
-
Authenticate with an API key:
|
|
19
|
+
Authenticate with an API key and start:
|
|
81
20
|
|
|
82
21
|
```bash
|
|
83
22
|
export ANTHROPIC_API_KEY=sk-ant-...
|
|
84
|
-
|
|
23
|
+
quickcall
|
|
85
24
|
```
|
|
86
25
|
|
|
87
|
-
Or
|
|
26
|
+
Or sign in with an existing subscription:
|
|
88
27
|
|
|
89
28
|
```bash
|
|
90
|
-
|
|
91
|
-
/login
|
|
29
|
+
quickcall
|
|
30
|
+
/login # then pick a provider
|
|
92
31
|
```
|
|
93
32
|
|
|
94
|
-
Then just talk to
|
|
95
|
-
|
|
96
|
-
**Platform notes:** [Windows](docs/windows.md) | [Termux (Android)](docs/termux.md) | [tmux](docs/tmux.md) | [Terminal setup](docs/terminal-setup.md) | [Shell aliases](docs/shell-aliases.md)
|
|
97
|
-
|
|
98
|
-
---
|
|
33
|
+
Then just talk to the agent. By default it can read, write, and edit files and run shell commands to carry out your requests. Extend it with [skills](#customization), [prompt templates](#customization), [extensions](#customization), or [packages](#packages).
|
|
99
34
|
|
|
100
35
|
## Providers & Models
|
|
101
36
|
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
**Subscriptions:**
|
|
105
|
-
- Anthropic Claude Pro/Max
|
|
106
|
-
- OpenAI ChatGPT Plus/Pro (Codex)
|
|
107
|
-
- GitHub Copilot
|
|
108
|
-
|
|
109
|
-
**API keys:**
|
|
110
|
-
- Anthropic
|
|
111
|
-
- OpenAI
|
|
112
|
-
- Azure OpenAI
|
|
113
|
-
- DeepSeek
|
|
114
|
-
- Google Gemini
|
|
115
|
-
- Google Vertex
|
|
116
|
-
- Amazon Bedrock
|
|
117
|
-
- Mistral
|
|
118
|
-
- Groq
|
|
119
|
-
- Cerebras
|
|
120
|
-
- Cloudflare AI Gateway
|
|
121
|
-
- Cloudflare Workers AI
|
|
122
|
-
- xAI
|
|
123
|
-
- OpenRouter
|
|
124
|
-
- Vercel AI Gateway
|
|
125
|
-
- ZAI
|
|
126
|
-
- OpenCode Zen
|
|
127
|
-
- OpenCode Go
|
|
128
|
-
- Hugging Face
|
|
129
|
-
- Fireworks
|
|
130
|
-
- Together AI
|
|
131
|
-
- Kimi For Coding
|
|
132
|
-
- MiniMax
|
|
133
|
-
- Xiaomi MiMo
|
|
134
|
-
- Xiaomi MiMo Token Plan (China)
|
|
135
|
-
- Xiaomi MiMo Token Plan (Amsterdam)
|
|
136
|
-
- Xiaomi MiMo Token Plan (Singapore)
|
|
137
|
-
|
|
138
|
-
See [docs/providers.md](docs/providers.md) for detailed setup instructions.
|
|
139
|
-
|
|
140
|
-
**Custom providers & models:** Add providers via `~/.pi/agent/models.json` if they speak a supported API (OpenAI, Anthropic, Google). For custom APIs or OAuth, use extensions. See [docs/models.md](docs/models.md) and [docs/custom-provider.md](docs/custom-provider.md).
|
|
141
|
-
|
|
142
|
-
---
|
|
37
|
+
QuickCall Krew ships with a maintained list of tool-capable models per provider. Authenticate by subscription (`/login`) or API key, then switch models with `/model` (or Ctrl+L).
|
|
143
38
|
|
|
144
|
-
|
|
39
|
+
- **Subscriptions:** Anthropic Claude, OpenAI ChatGPT (Codex), GitHub Copilot
|
|
40
|
+
- **API keys:** Anthropic, OpenAI, Azure OpenAI, Google Gemini / Vertex, Amazon Bedrock, Mistral, Groq, Cerebras, xAI, OpenRouter, DeepSeek, and more
|
|
145
41
|
|
|
146
|
-
|
|
42
|
+
Add custom providers via `~/.quickcall/agent/models.json` (for OpenAI/Anthropic/Google-compatible APIs) or via an extension for anything bespoke.
|
|
147
43
|
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
- **Startup header** - Shows shortcuts (`/hotkeys` for all), loaded AGENTS.md files, prompt templates, skills, and extensions
|
|
151
|
-
- **Messages** - Your messages, assistant responses, tool calls and results, notifications, errors, and extension UI
|
|
152
|
-
- **Editor** - Where you type; border color indicates thinking level
|
|
153
|
-
- **Footer** - Working directory, session name, total token/cache usage, cost, context usage, current model
|
|
44
|
+
## Interactive Mode
|
|
154
45
|
|
|
155
|
-
The
|
|
46
|
+
The TUI shows a startup header (shortcuts, loaded context, skills, extensions), the message stream, an editor, and a footer with working directory, session, token usage, cost, and the active model.
|
|
156
47
|
|
|
157
|
-
|
|
48
|
+
Editor highlights:
|
|
158
49
|
|
|
159
50
|
| Feature | How |
|
|
160
51
|
|---------|-----|
|
|
161
52
|
| File reference | Type `@` to fuzzy-search project files |
|
|
162
|
-
|
|
|
163
|
-
|
|
|
164
|
-
|
|
|
165
|
-
| Bash commands | `!command` runs and sends output to LLM, `!!command` runs without sending |
|
|
166
|
-
|
|
167
|
-
Standard editing keybindings for delete word, undo, etc. See [docs/keybindings.md](docs/keybindings.md).
|
|
168
|
-
|
|
169
|
-
### Commands
|
|
170
|
-
|
|
171
|
-
Type `/` in the editor to trigger commands. [Extensions](#extensions) can register custom commands, [skills](#skills) are available as `/skill:name`, and [prompt templates](#prompt-templates) expand via `/templatename`.
|
|
172
|
-
|
|
173
|
-
| Command | Description |
|
|
174
|
-
|---------|-------------|
|
|
175
|
-
| `/login`, `/logout` | OAuth authentication |
|
|
176
|
-
| `/model` | Switch models |
|
|
177
|
-
| `/scoped-models` | Enable/disable models for Ctrl+P cycling |
|
|
178
|
-
| `/settings` | Thinking level, theme, message delivery, transport |
|
|
179
|
-
| `/resume` | Pick from previous sessions |
|
|
180
|
-
| `/new` | Start a new session |
|
|
181
|
-
| `/name <name>` | Set session display name |
|
|
182
|
-
| `/session` | Show session info (file, ID, messages, tokens, cost) |
|
|
183
|
-
| `/tree` | Jump to any point in the session and continue from there |
|
|
184
|
-
| `/fork` | Create a new session from a previous user message |
|
|
185
|
-
| `/clone` | Duplicate the current active branch into a new session |
|
|
186
|
-
| `/compact [prompt]` | Manually compact context, optional custom instructions |
|
|
187
|
-
| `/copy` | Copy last assistant message to clipboard |
|
|
188
|
-
| `/export [file]` | Export session to HTML file |
|
|
189
|
-
| `/share` | Upload as private GitHub gist with shareable HTML link |
|
|
190
|
-
| `/reload` | Reload keybindings, extensions, skills, prompts, and context files (themes hot-reload automatically) |
|
|
191
|
-
| `/hotkeys` | Show all keyboard shortcuts |
|
|
192
|
-
| `/changelog` | Display version history |
|
|
193
|
-
| `/quit` | Quit pi |
|
|
194
|
-
|
|
195
|
-
### Keyboard Shortcuts
|
|
196
|
-
|
|
197
|
-
See `/hotkeys` for the full list. Customize via `~/.pi/agent/keybindings.json`. See [docs/keybindings.md](docs/keybindings.md).
|
|
198
|
-
|
|
199
|
-
**Commonly used:**
|
|
200
|
-
|
|
201
|
-
| Key | Action |
|
|
202
|
-
|-----|--------|
|
|
203
|
-
| Ctrl+C | Clear editor |
|
|
204
|
-
| Ctrl+C twice | Quit |
|
|
205
|
-
| Escape | Cancel/abort |
|
|
206
|
-
| Escape twice | Open `/tree` |
|
|
207
|
-
| Ctrl+L | Open model selector |
|
|
208
|
-
| Ctrl+P / Shift+Ctrl+P | Cycle scoped models forward/backward |
|
|
209
|
-
| Shift+Tab | Cycle thinking level |
|
|
210
|
-
| Ctrl+O | Collapse/expand tool output |
|
|
211
|
-
| Ctrl+T | Collapse/expand thinking blocks |
|
|
212
|
-
|
|
213
|
-
### Message Queue
|
|
214
|
-
|
|
215
|
-
Submit messages while the agent is working:
|
|
216
|
-
|
|
217
|
-
- **Enter** queues a *steering* message, delivered after the current assistant turn finishes executing its tool calls
|
|
218
|
-
- **Alt+Enter** queues a *follow-up* message, delivered only after the agent finishes all work
|
|
219
|
-
- **Escape** aborts and restores queued messages to editor
|
|
220
|
-
- **Alt+Up** retrieves queued messages back to editor
|
|
221
|
-
|
|
222
|
-
On Windows Terminal, `Alt+Enter` is fullscreen by default. Remap it in [docs/terminal-setup.md](docs/terminal-setup.md) so pi can receive the follow-up shortcut.
|
|
223
|
-
|
|
224
|
-
Configure delivery in [settings](docs/settings.md): `steeringMode` and `followUpMode` can be `"one-at-a-time"` (default, waits for response) or `"all"` (delivers all queued at once). `transport` selects provider transport preference (`"sse"`, `"websocket"`, or `"auto"`) for providers that support multiple transports.
|
|
225
|
-
|
|
226
|
-
---
|
|
227
|
-
|
|
228
|
-
## Sessions
|
|
53
|
+
| Multi-line | Shift+Enter |
|
|
54
|
+
| Images | Ctrl+V to paste, or drag onto the terminal |
|
|
55
|
+
| Bash | `!command` runs and sends output to the model; `!!command` runs without sending |
|
|
229
56
|
|
|
230
|
-
|
|
57
|
+
Type `/` for commands (`/model`, `/settings`, `/resume`, `/new`, `/compact`, `/share`, `/export`, and more). Press `/hotkeys` for the full keyboard reference.
|
|
231
58
|
|
|
232
|
-
|
|
59
|
+
## Sessions
|
|
233
60
|
|
|
234
|
-
Sessions auto-save
|
|
61
|
+
Sessions are stored as JSONL files with a tree structure, so you can branch in place without losing history. They auto-save under `~/.quickcall/agent/sessions/`, organized by working directory.
|
|
235
62
|
|
|
236
63
|
```bash
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
64
|
+
quickcall -c # continue most recent session
|
|
65
|
+
quickcall -r # browse and resume a past session
|
|
66
|
+
quickcall --no-session # ephemeral (don't save)
|
|
67
|
+
quickcall --session <path|id> # open a specific session
|
|
68
|
+
quickcall --fork <path|id> # fork a session into a new one
|
|
242
69
|
```
|
|
243
70
|
|
|
244
|
-
Use `/
|
|
245
|
-
|
|
246
|
-
### Branching
|
|
247
|
-
|
|
248
|
-
**`/tree`** - Navigate the session tree in-place. Select any previous point, continue from there, and switch between branches. All history preserved in a single file.
|
|
249
|
-
|
|
250
|
-
<p align="center"><img src="docs/images/tree-view.png" alt="Tree View" width="600"></p>
|
|
251
|
-
|
|
252
|
-
- Search by typing, fold/unfold and jump between branches with Ctrl+←/Ctrl+→ or Alt+←/Alt+→, page with ←/→
|
|
253
|
-
- Filter modes (Ctrl+O): default → no-tools → user-only → labeled-only → all
|
|
254
|
-
- Press Shift+L to label entries as bookmarks and Shift+T to toggle label timestamps
|
|
255
|
-
|
|
256
|
-
**`/fork`** - Create a new session file from a previous user message on the active branch. Opens a selector, copies the active path up to that point, and places the selected prompt in the editor for modification.
|
|
257
|
-
|
|
258
|
-
**`/clone`** - Duplicate the current active branch into a new session file at the current position. The new session keeps the full active-path history and opens with an empty editor.
|
|
259
|
-
|
|
260
|
-
**`--fork <path|id>`** - Fork an existing session file or partial session UUID directly from the CLI. This copies the full source session into a new session file in the current project.
|
|
261
|
-
|
|
262
|
-
### Compaction
|
|
263
|
-
|
|
264
|
-
Long sessions can exhaust context windows. Compaction summarizes older messages while keeping recent ones.
|
|
265
|
-
|
|
266
|
-
**Manual:** `/compact` or `/compact <custom instructions>`
|
|
267
|
-
|
|
268
|
-
**Automatic:** Enabled by default. Triggers on context overflow (recovers and retries) or when approaching the limit (proactive). Configure via `/settings` or `settings.json`.
|
|
269
|
-
|
|
270
|
-
Compaction is lossy. The full history remains in the JSONL file; use `/tree` to revisit. Customize compaction behavior via [extensions](#extensions). See [docs/compaction.md](docs/compaction.md) for internals.
|
|
271
|
-
|
|
272
|
-
---
|
|
71
|
+
Use `/tree` to navigate, branch, and bookmark within a session, and `/compact` to summarize older messages when context grows long.
|
|
273
72
|
|
|
274
73
|
## Settings
|
|
275
74
|
|
|
276
|
-
Use `/settings`
|
|
75
|
+
Use `/settings` in the TUI, or edit JSON directly:
|
|
277
76
|
|
|
278
77
|
| Location | Scope |
|
|
279
78
|
|----------|-------|
|
|
280
|
-
| `~/.
|
|
281
|
-
| `.
|
|
282
|
-
|
|
283
|
-
See [docs/settings.md](docs/settings.md) for all options.
|
|
284
|
-
|
|
285
|
-
### Telemetry and update checks
|
|
286
|
-
|
|
287
|
-
Pi has two separate startup features:
|
|
288
|
-
|
|
289
|
-
- **Update check:** fetches `https://pi.dev/api/latest-version` to check whether a newer Pi version exists. Disable it with `PI_SKIP_VERSION_CHECK=1`. Disabling update checks only turns off this check.
|
|
290
|
-
- **Install/update telemetry:** after first install or a changelog-detected update, sends an anonymous version ping to `https://pi.dev/api/report-install`. Opt out by setting `enableInstallTelemetry` to `false` in `settings.json`, or by setting `PI_TELEMETRY=0`. This does not disable update checks; Pi may still contact `pi.dev` for the latest version unless update checks are disabled or offline mode is enabled.
|
|
291
|
-
|
|
292
|
-
Use `--offline` or `PI_OFFLINE=1` to disable all startup network operations described here, including update checks, package update checks, and install/update telemetry.
|
|
293
|
-
|
|
294
|
-
---
|
|
79
|
+
| `~/.quickcall/agent/settings.json` | Global (all projects) |
|
|
80
|
+
| `.quickcall/settings.json` | Project (overrides global) |
|
|
295
81
|
|
|
296
82
|
## Context Files
|
|
297
83
|
|
|
298
|
-
|
|
299
|
-
- `~/.pi/agent/AGENTS.md` (global)
|
|
300
|
-
- Parent directories (walking up from cwd)
|
|
301
|
-
- Current directory
|
|
302
|
-
|
|
303
|
-
Use for project instructions, conventions, common commands. All matching files are concatenated.
|
|
304
|
-
|
|
305
|
-
Disable context file loading with `--no-context-files` (or `-nc`).
|
|
306
|
-
|
|
307
|
-
### System Prompt
|
|
84
|
+
At startup QuickCall Krew loads `AGENTS.md` (or `CLAUDE.md`) from your home agent dir, parent directories, and the current directory. Use these for project conventions and common commands. Disable with `--no-context-files` (`-nc`).
|
|
308
85
|
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
---
|
|
86
|
+
You can replace the system prompt with `.quickcall/SYSTEM.md` (project) or `~/.quickcall/agent/SYSTEM.md` (global), or extend it with `APPEND_SYSTEM.md`.
|
|
312
87
|
|
|
313
88
|
## Customization
|
|
314
89
|
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
Reusable prompts as Markdown files. Type `/name` to expand.
|
|
318
|
-
|
|
319
|
-
```markdown
|
|
320
|
-
<!-- ~/.pi/agent/prompts/review.md -->
|
|
321
|
-
Review this code for bugs, security issues, and performance problems.
|
|
322
|
-
Focus on: {{focus}}
|
|
323
|
-
```
|
|
324
|
-
|
|
325
|
-
Place in `~/.pi/agent/prompts/`, `.pi/prompts/`, or a [pi package](#pi-packages) to share with others. See [docs/prompt-templates.md](docs/prompt-templates.md).
|
|
326
|
-
|
|
327
|
-
### Skills
|
|
328
|
-
|
|
329
|
-
On-demand capability packages following the [Agent Skills standard](https://agentskills.io). Invoke via `/skill:name` or let the agent load them automatically.
|
|
330
|
-
|
|
331
|
-
```markdown
|
|
332
|
-
<!-- ~/.pi/agent/skills/my-skill/SKILL.md -->
|
|
333
|
-
# My Skill
|
|
334
|
-
Use this skill when the user asks about X.
|
|
335
|
-
|
|
336
|
-
## Steps
|
|
337
|
-
1. Do this
|
|
338
|
-
2. Then that
|
|
339
|
-
```
|
|
340
|
-
|
|
341
|
-
Place in `~/.pi/agent/skills/`, `~/.agents/skills/`, `.pi/skills/`, or `.agents/skills/` (from `cwd` up through parent directories) or a [pi package](#pi-packages) to share with others. See [docs/skills.md](docs/skills.md).
|
|
342
|
-
|
|
343
|
-
### Extensions
|
|
344
|
-
|
|
345
|
-
<p align="center"><img src="docs/images/doom-extension.png" alt="Doom Extension" width="600"></p>
|
|
346
|
-
|
|
347
|
-
TypeScript modules that extend pi with custom tools, commands, keyboard shortcuts, event handlers, and UI components.
|
|
348
|
-
|
|
349
|
-
```typescript
|
|
350
|
-
export default function (pi: ExtensionAPI) {
|
|
351
|
-
pi.registerTool({ name: "deploy", ... });
|
|
352
|
-
pi.registerCommand("stats", { ... });
|
|
353
|
-
pi.on("tool_call", async (event, ctx) => { ... });
|
|
354
|
-
}
|
|
355
|
-
```
|
|
356
|
-
|
|
357
|
-
The default export can also be `async`. pi waits for async extension factories before startup continues, which is useful for one-time initialization such as fetching remote model lists before calling `pi.registerProvider()`.
|
|
358
|
-
|
|
359
|
-
**What's possible:**
|
|
360
|
-
- Custom tools (or replace built-in tools entirely)
|
|
361
|
-
- Sub-agents and plan mode
|
|
362
|
-
- Custom compaction and summarization
|
|
363
|
-
- Permission gates and path protection
|
|
364
|
-
- Custom editors and UI components
|
|
365
|
-
- Status lines, headers, footers
|
|
366
|
-
- Git checkpointing and auto-commit
|
|
367
|
-
- SSH and sandbox execution
|
|
368
|
-
- MCP server integration
|
|
369
|
-
- Make pi look like Claude Code
|
|
370
|
-
- Games while waiting (yes, Doom runs)
|
|
371
|
-
- ...anything you can dream up
|
|
372
|
-
|
|
373
|
-
Place in `~/.pi/agent/extensions/`, `.pi/extensions/`, or a [pi package](#pi-packages) to share with others. See [docs/extensions.md](docs/extensions.md) and [examples/extensions/](examples/extensions/).
|
|
90
|
+
QuickCall Krew is built to be reshaped rather than configured into a corner:
|
|
374
91
|
|
|
375
|
-
|
|
92
|
+
- **Prompt templates** — reusable Markdown prompts, invoked as `/name`.
|
|
93
|
+
- **Skills** — on-demand capability packages following the [Agent Skills standard](https://agentskills.io), invoked as `/skill:name` or loaded automatically.
|
|
94
|
+
- **Extensions** — TypeScript modules that add tools, commands, shortcuts, event handlers, and UI (sub-agents, plan mode, permission gates, custom editors, and more).
|
|
95
|
+
- **Themes** — built-in `dark` and `light`, with hot-reload while you edit.
|
|
376
96
|
|
|
377
|
-
|
|
97
|
+
Each lives under `~/.quickcall/agent/<kind>/` (global) or `.quickcall/<kind>/` (project), or can be shared via a [package](#packages).
|
|
378
98
|
|
|
379
|
-
|
|
99
|
+
## Packages
|
|
380
100
|
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
Bundle and share extensions, skills, prompts, and themes via npm or git. Find packages on [npmjs.com](https://www.npmjs.com/search?q=keywords%3Api-package) or [Discord](https://discord.com/channels/1456806362351669492/1457744485428629628).
|
|
384
|
-
|
|
385
|
-
> **Security:** Pi packages run with full system access. Extensions execute arbitrary code, and skills can instruct the model to perform any action including running executables. Review source code before installing third-party packages.
|
|
101
|
+
Bundle and share extensions, skills, prompts, and themes via npm or git:
|
|
386
102
|
|
|
387
103
|
```bash
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
pi install git:git@github.com:user/repo@v1 # tag or commit
|
|
394
|
-
pi install https://github.com/user/repo
|
|
395
|
-
pi install https://github.com/user/repo@v1 # tag or commit
|
|
396
|
-
pi install ssh://git@github.com/user/repo
|
|
397
|
-
pi install ssh://git@github.com/user/repo@v1 # tag or commit
|
|
398
|
-
pi remove npm:@foo/pi-tools
|
|
399
|
-
pi uninstall npm:@foo/pi-tools # alias for remove
|
|
400
|
-
pi list
|
|
401
|
-
pi update # update pi and packages (skips pinned packages)
|
|
402
|
-
pi update --extensions # update packages only
|
|
403
|
-
pi update --self # update pi only
|
|
404
|
-
pi update --self --force # reinstall pi even if current
|
|
405
|
-
pi update npm:@foo/pi-tools # update one package
|
|
406
|
-
pi config # enable/disable extensions, skills, prompts, themes
|
|
104
|
+
quickcall install npm:@scope/pi-tools # install from npm
|
|
105
|
+
quickcall install git:github.com/user/repo # install from git
|
|
106
|
+
quickcall list # list installed packages
|
|
107
|
+
quickcall update # update the CLI and packages
|
|
108
|
+
quickcall config # enable/disable resources
|
|
407
109
|
```
|
|
408
110
|
|
|
409
|
-
|
|
111
|
+
> **Security:** packages run with full system access — extensions execute arbitrary code and skills can instruct the model to run anything. Review source before installing third-party packages.
|
|
410
112
|
|
|
411
|
-
|
|
113
|
+
Author a package by adding a `pi` manifest to `package.json` (the `pi-package` keyword aids discovery):
|
|
412
114
|
|
|
413
115
|
```json
|
|
414
116
|
{
|
|
415
|
-
"name": "my-
|
|
117
|
+
"name": "my-package",
|
|
416
118
|
"keywords": ["pi-package"],
|
|
417
119
|
"pi": {
|
|
418
120
|
"extensions": ["./extensions"],
|
|
@@ -423,18 +125,12 @@ Create a package by adding a `pi` key to `package.json`:
|
|
|
423
125
|
}
|
|
424
126
|
```
|
|
425
127
|
|
|
426
|
-
Without a `pi` manifest, pi auto-discovers from conventional directories (`extensions/`, `skills/`, `prompts/`, `themes/`).
|
|
427
|
-
|
|
428
|
-
See [docs/packages.md](docs/packages.md).
|
|
429
|
-
|
|
430
|
-
---
|
|
431
|
-
|
|
432
128
|
## Programmatic Usage
|
|
433
129
|
|
|
434
|
-
|
|
130
|
+
Embed the agent in your own app via the SDK:
|
|
435
131
|
|
|
436
132
|
```typescript
|
|
437
|
-
import { AuthStorage, createAgentSession, ModelRegistry, SessionManager } from "@
|
|
133
|
+
import { AuthStorage, createAgentSession, ModelRegistry, SessionManager } from "@quickcall/krew";
|
|
438
134
|
|
|
439
135
|
const authStorage = AuthStorage.create();
|
|
440
136
|
const modelRegistry = ModelRegistry.create(authStorage);
|
|
@@ -447,207 +143,46 @@ const { session } = await createAgentSession({
|
|
|
447
143
|
await session.prompt("What files are in the current directory?");
|
|
448
144
|
```
|
|
449
145
|
|
|
450
|
-
For
|
|
451
|
-
|
|
452
|
-
See [docs/sdk.md](docs/sdk.md) and [examples/sdk/](examples/sdk/).
|
|
453
|
-
|
|
454
|
-
### RPC Mode
|
|
455
|
-
|
|
456
|
-
For non-Node.js integrations, use RPC mode over stdin/stdout:
|
|
457
|
-
|
|
458
|
-
```bash
|
|
459
|
-
pi --mode rpc
|
|
460
|
-
```
|
|
461
|
-
|
|
462
|
-
RPC mode uses strict LF-delimited JSONL framing. Clients must split records on `\n` only. Do not use generic line readers like Node `readline`, which also split on Unicode separators inside JSON payloads.
|
|
463
|
-
|
|
464
|
-
See [docs/rpc.md](docs/rpc.md) for the protocol.
|
|
465
|
-
|
|
466
|
-
---
|
|
467
|
-
|
|
468
|
-
## Philosophy
|
|
469
|
-
|
|
470
|
-
Pi is aggressively extensible so it doesn't have to dictate your workflow. Features that other tools bake in can be built with [extensions](#extensions), [skills](#skills), or installed from third-party [pi packages](#pi-packages). This keeps the core minimal while letting you shape pi to fit how you work.
|
|
471
|
-
|
|
472
|
-
**No MCP.** Build CLI tools with READMEs (see [Skills](#skills)), or build an extension that adds MCP support. [Why?](https://mariozechner.at/posts/2025-11-02-what-if-you-dont-need-mcp/)
|
|
473
|
-
|
|
474
|
-
**No sub-agents.** There's many ways to do this. Spawn pi instances via tmux, or build your own with [extensions](#extensions), or install a package that does it your way.
|
|
475
|
-
|
|
476
|
-
**No permission popups.** Run in a container, or build your own confirmation flow with [extensions](#extensions) inline with your environment and security requirements.
|
|
477
|
-
|
|
478
|
-
**No plan mode.** Write plans to files, or build it with [extensions](#extensions), or install a package.
|
|
479
|
-
|
|
480
|
-
**No built-in to-dos.** They confuse models. Use a TODO.md file, or build your own with [extensions](#extensions).
|
|
481
|
-
|
|
482
|
-
**No background bash.** Use tmux. Full observability, direct interaction.
|
|
483
|
-
|
|
484
|
-
Read the [blog post](https://mariozechner.at/posts/2025-11-30-pi-coding-agent/) for the full rationale.
|
|
485
|
-
|
|
486
|
-
---
|
|
146
|
+
For non-Node integrations, run RPC mode over stdin/stdout with `quickcall --mode rpc` (strict LF-delimited JSONL framing).
|
|
487
147
|
|
|
488
148
|
## CLI Reference
|
|
489
149
|
|
|
490
150
|
```bash
|
|
491
|
-
|
|
492
|
-
```
|
|
493
|
-
|
|
494
|
-
### Package Commands
|
|
495
|
-
|
|
496
|
-
```bash
|
|
497
|
-
pi install <source> [-l] # Install package, -l for project-local
|
|
498
|
-
pi remove <source> [-l] # Remove package
|
|
499
|
-
pi uninstall <source> [-l] # Alias for remove
|
|
500
|
-
pi update [source|self|pi] # Update pi and packages (skips pinned packages)
|
|
501
|
-
pi update --extensions # Update packages only
|
|
502
|
-
pi update --self # Update pi only
|
|
503
|
-
pi update --self --force # Reinstall pi even if current
|
|
504
|
-
pi update --extension <src> # Update one package
|
|
505
|
-
pi list # List installed packages
|
|
506
|
-
pi config # Enable/disable package resources
|
|
151
|
+
quickcall [options] [@files...] [messages...]
|
|
507
152
|
```
|
|
508
153
|
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
| Flag | Description |
|
|
512
|
-
|------|-------------|
|
|
513
|
-
| (default) | Interactive mode |
|
|
514
|
-
| `-p`, `--print` | Print response and exit |
|
|
515
|
-
| `--mode json` | Output all events as JSON lines (see [docs/json.md](docs/json.md)) |
|
|
516
|
-
| `--mode rpc` | RPC mode for process integration (see [docs/rpc.md](docs/rpc.md)) |
|
|
517
|
-
| `--export <in> [out]` | Export session to HTML |
|
|
518
|
-
|
|
519
|
-
In print mode, pi also reads piped stdin and merges it into the initial prompt:
|
|
520
|
-
|
|
521
|
-
```bash
|
|
522
|
-
cat README.md | pi -p "Summarize this text"
|
|
523
|
-
```
|
|
524
|
-
|
|
525
|
-
### Model Options
|
|
154
|
+
Common options:
|
|
526
155
|
|
|
527
156
|
| Option | Description |
|
|
528
157
|
|--------|-------------|
|
|
529
|
-
| `--
|
|
530
|
-
| `--
|
|
531
|
-
| `--
|
|
158
|
+
| `-p`, `--print` | Print the response and exit |
|
|
159
|
+
| `--mode json` | Emit all events as JSON lines |
|
|
160
|
+
| `--mode rpc` | RPC mode for process integration |
|
|
161
|
+
| `--provider <name>` | Provider (anthropic, openai, google, ...) |
|
|
162
|
+
| `--model <pattern>` | Model pattern or `provider/id` (optional `:<thinking>`) |
|
|
532
163
|
| `--thinking <level>` | `off`, `minimal`, `low`, `medium`, `high`, `xhigh` |
|
|
533
|
-
| `--
|
|
534
|
-
| `--
|
|
535
|
-
|
|
536
|
-
### Session Options
|
|
537
|
-
|
|
538
|
-
| Option | Description |
|
|
539
|
-
|--------|-------------|
|
|
540
|
-
| `-c`, `--continue` | Continue most recent session |
|
|
541
|
-
| `-r`, `--resume` | Browse and select session |
|
|
542
|
-
| `--session <path\|id>` | Use specific session file or partial UUID |
|
|
543
|
-
| `--fork <path\|id>` | Fork specific session file or partial UUID into a new session |
|
|
544
|
-
| `--session-dir <dir>` | Custom session storage directory |
|
|
545
|
-
| `--no-session` | Ephemeral mode (don't save) |
|
|
546
|
-
|
|
547
|
-
### Tool Options
|
|
548
|
-
|
|
549
|
-
| Option | Description |
|
|
550
|
-
|--------|-------------|
|
|
551
|
-
| `--tools <list>`, `-t <list>` | Allowlist specific tool names across built-in, extension, and custom tools |
|
|
552
|
-
| `--no-builtin-tools`, `-nbt` | Disable built-in tools by default but keep extension/custom tools enabled |
|
|
553
|
-
| `--no-tools`, `-nt` | Disable all tools by default |
|
|
554
|
-
|
|
555
|
-
Available built-in tools: `read`, `bash`, `edit`, `write`, `grep`, `find`, `ls`
|
|
556
|
-
|
|
557
|
-
### Resource Options
|
|
558
|
-
|
|
559
|
-
| Option | Description |
|
|
560
|
-
|--------|-------------|
|
|
561
|
-
| `-e`, `--extension <source>` | Load extension from path, npm, or git (repeatable) |
|
|
562
|
-
| `--no-extensions` | Disable extension discovery |
|
|
563
|
-
| `--skill <path>` | Load skill (repeatable) |
|
|
564
|
-
| `--no-skills` | Disable skill discovery |
|
|
565
|
-
| `--prompt-template <path>` | Load prompt template (repeatable) |
|
|
566
|
-
| `--no-prompt-templates` | Disable prompt template discovery |
|
|
567
|
-
| `--theme <path>` | Load theme (repeatable) |
|
|
568
|
-
| `--no-themes` | Disable theme discovery |
|
|
569
|
-
| `--no-context-files`, `-nc` | Disable AGENTS.md and CLAUDE.md context file discovery |
|
|
570
|
-
|
|
571
|
-
Combine `--no-*` with explicit flags to load exactly what you need, ignoring settings.json (e.g., `--no-extensions -e ./my-ext.ts`).
|
|
572
|
-
|
|
573
|
-
### Other Options
|
|
574
|
-
|
|
575
|
-
| Option | Description |
|
|
576
|
-
|--------|-------------|
|
|
577
|
-
| `--system-prompt <text>` | Replace default prompt (context files and skills still appended) |
|
|
578
|
-
| `--append-system-prompt <text>` | Append to system prompt |
|
|
579
|
-
| `--verbose` | Force verbose startup |
|
|
164
|
+
| `--tools <list>`, `-t` | Allowlist specific tools |
|
|
165
|
+
| `-c`, `--continue` | Continue the most recent session |
|
|
166
|
+
| `-r`, `--resume` | Browse and resume a session |
|
|
580
167
|
| `-h`, `--help` | Show help |
|
|
581
168
|
| `-v`, `--version` | Show version |
|
|
582
169
|
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
Prefix files with `@` to include in the message:
|
|
170
|
+
Prefix files with `@` to include them in a message:
|
|
586
171
|
|
|
587
172
|
```bash
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
pi @code.ts @test.ts "Review these files"
|
|
173
|
+
quickcall @code.ts @test.ts "Review these files"
|
|
174
|
+
cat README.md | quickcall -p "Summarize this text"
|
|
591
175
|
```
|
|
592
176
|
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
```bash
|
|
596
|
-
# Interactive with initial prompt
|
|
597
|
-
pi "List all .ts files in src/"
|
|
598
|
-
|
|
599
|
-
# Non-interactive
|
|
600
|
-
pi -p "Summarize this codebase"
|
|
601
|
-
|
|
602
|
-
# Non-interactive with piped stdin
|
|
603
|
-
cat README.md | pi -p "Summarize this text"
|
|
604
|
-
|
|
605
|
-
# Different model
|
|
606
|
-
pi --provider openai --model gpt-4o "Help me refactor"
|
|
607
|
-
|
|
608
|
-
# Model with provider prefix (no --provider needed)
|
|
609
|
-
pi --model openai/gpt-4o "Help me refactor"
|
|
610
|
-
|
|
611
|
-
# Model with thinking level shorthand
|
|
612
|
-
pi --model sonnet:high "Solve this complex problem"
|
|
613
|
-
|
|
614
|
-
# Limit model cycling
|
|
615
|
-
pi --models "claude-*,gpt-4o"
|
|
616
|
-
|
|
617
|
-
# Read-only mode
|
|
618
|
-
pi --tools read,grep,find,ls -p "Review the code"
|
|
619
|
-
|
|
620
|
-
# High thinking level
|
|
621
|
-
pi --thinking high "Solve this complex problem"
|
|
622
|
-
```
|
|
623
|
-
|
|
624
|
-
### Environment Variables
|
|
177
|
+
Environment variables:
|
|
625
178
|
|
|
626
179
|
| Variable | Description |
|
|
627
180
|
|----------|-------------|
|
|
628
|
-
| `
|
|
629
|
-
| `
|
|
630
|
-
| `
|
|
631
|
-
| `PI_OFFLINE` | Disable startup network operations, including update checks, package update checks, and install/update telemetry |
|
|
632
|
-
| `PI_SKIP_VERSION_CHECK` | Skip the Pi version update check at startup. This prevents the `pi.dev` latest-version request |
|
|
633
|
-
| `PI_TELEMETRY` | Override install/update telemetry. Use `1`/`true`/`yes` to enable or `0`/`false`/`no` to disable. This does not disable update checks |
|
|
634
|
-
| `PI_CACHE_RETENTION` | Set to `long` for extended prompt cache (Anthropic: 1h, OpenAI: 24h) |
|
|
181
|
+
| `QUICKCALL_CODING_AGENT_DIR` | Override config directory (default: `~/.quickcall/agent`) |
|
|
182
|
+
| `QUICKCALL_CODING_AGENT_SESSION_DIR` | Override session storage directory |
|
|
183
|
+
| `PI_OFFLINE` | Disable startup network operations (update and telemetry checks) |
|
|
635
184
|
| `VISUAL`, `EDITOR` | External editor for Ctrl+G |
|
|
636
185
|
|
|
637
|
-
---
|
|
638
|
-
|
|
639
|
-
## Contributing & Development
|
|
640
|
-
|
|
641
|
-
See [CONTRIBUTING.md](../../CONTRIBUTING.md) for guidelines and [docs/development.md](docs/development.md) for setup, forking, and debugging.
|
|
642
|
-
|
|
643
|
-
---
|
|
644
|
-
|
|
645
186
|
## License
|
|
646
187
|
|
|
647
|
-
MIT
|
|
648
|
-
|
|
649
|
-
## See Also
|
|
650
|
-
|
|
651
|
-
- [@earendil-works/pi-ai](https://www.npmjs.com/package/@earendil-works/pi-ai): Core LLM toolkit
|
|
652
|
-
- [@earendil-works/pi-agent-core](https://www.npmjs.com/package/@earendil-works/pi-agent-core): Agent framework
|
|
653
|
-
- [@earendil-works/pi-tui](https://www.npmjs.com/package/@earendil-works/pi-tui): Terminal UI components
|
|
188
|
+
MIT. QuickCall Krew is a fork of the [Pi](https://pi.dev) coding agent harness.
|