pikiclaw 0.3.36 → 0.3.38
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 +149 -149
- package/README.zh-CN.md +153 -153
- package/dashboard/dist/assets/AgentTab-BkZnuKaS.js +1 -0
- package/dashboard/dist/assets/{BrandIcon-DuvssI5P.js → BrandIcon-AD156ArP.js} +1 -1
- package/dashboard/dist/assets/{DirBrowser-CfaNqvEe.js → DirBrowser-BwzrHjjR.js} +1 -1
- package/dashboard/dist/assets/{ExtensionsTab-BXEctSc6.js → ExtensionsTab-BwH0CaMy.js} +1 -1
- package/dashboard/dist/assets/{IMAccessTab-DM1rsj-u.js → IMAccessTab-_0gPo7VO.js} +1 -1
- package/dashboard/dist/assets/{Modal-DHVhz66H.js → Modal-CdInMPb1.js} +1 -1
- package/dashboard/dist/assets/{Modals-Dhxu3hSi.js → Modals-DbI2X4wo.js} +1 -1
- package/dashboard/dist/assets/{Select-lWGnI7Cq.js → Select-BE8Z-HNs.js} +1 -1
- package/dashboard/dist/assets/SessionPanel-DUq59l08.js +1 -0
- package/dashboard/dist/assets/SystemTab-Bfw4XWnc.js +1 -0
- package/dashboard/dist/assets/index-5bbMY2wM.js +16 -0
- package/dashboard/dist/assets/index-BP_D94Yk.css +1 -0
- package/dashboard/dist/assets/index-C2q8FWKH.js +5 -0
- package/dashboard/dist/assets/router-Cav8lq-m.js +3 -0
- package/dashboard/dist/assets/{shared-DKIT06du.js → shared-DFRcspIO.js} +1 -1
- package/dashboard/dist/index.html +3 -3
- package/dist/agent/drivers/claude.js +11 -15
- package/dist/agent/drivers/gemini.js +3 -3
- package/dist/agent/index.js +1 -1
- package/dist/agent/mcp/bridge.js +195 -9
- package/dist/agent/mcp/session-server.js +9 -5
- package/dist/agent/mcp/tools/ask-user.js +113 -0
- package/dist/agent/session.js +13 -0
- package/dist/agent/stream.js +28 -8
- package/dist/agent/utils.js +24 -0
- package/dist/bot/bot.js +114 -36
- package/dist/browser-profile.js +42 -0
- package/dist/browser-supervisor.js +79 -11
- package/dist/catalog/local-models.js +112 -0
- package/dist/channels/weixin/bot.js +413 -79
- package/dist/cli/autostart.js +226 -0
- package/dist/cli/main.js +19 -1
- package/dist/core/platform.js +9 -4
- package/dist/dashboard/routes/local-models.js +276 -0
- package/dist/dashboard/routes/sessions.js +18 -1
- package/dist/dashboard/server.js +2 -0
- package/dist/dashboard/session-control.js +14 -0
- package/package.json +1 -1
- package/dashboard/dist/assets/AgentTab-B0k6567P.js +0 -1
- package/dashboard/dist/assets/PermissionsTab-B-KiKU8D.js +0 -1
- package/dashboard/dist/assets/SessionPanel-DL2E4VnO.js +0 -1
- package/dashboard/dist/assets/SystemTab-B6NbPTbB.js +0 -1
- package/dashboard/dist/assets/index-BWqrPOhO.js +0 -16
- package/dashboard/dist/assets/index-CmjPBA1x.js +0 -3
- package/dashboard/dist/assets/index-DgLQyCkc.css +0 -1
- package/dashboard/dist/assets/router-emLofBBH.js +0 -3
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
##### *The open Agent orchestrator for the era when creators no longer need to read code.*
|
|
8
8
|
|
|
9
|
-
*Plug in any agent (Claude · Codex · Gemini · Hermes · …), any model (Claude · GPT · Gemini · DeepSeek ·
|
|
9
|
+
*Plug in any agent (Claude · Codex · Gemini · Hermes · …), any model (Claude · GPT · Gemini · DeepSeek · Doubao · MiMo · MiniMax · OpenRouter · or any third-party proxy), and any tool (Skills · MCP · CLI). Drive them seamlessly from your favorite terminal—whether it's an IM, Web Dashboard, or future interfaces. pikiclaw is built using pikiclaw.*
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
12
|
npx pikiclaw@latest
|
|
@@ -32,12 +32,12 @@ npx pikiclaw@latest
|
|
|
32
32
|
|
|
33
33
|
## What is pikiclaw?
|
|
34
34
|
|
|
35
|
-
**Most "AI dev
|
|
35
|
+
**Most "AI dev tools" settle for a narrow slice of the pie—binding you to a single IDE, a specific agent, or a closed model ecosystem.** pikiclaw is built on a fundamentally different premise: the next era of software creation won't be confined to a single code editor. It happens within an **Orchestrator** that empowers a creator to drive a *swarm* of agents—in parallel, from one console—running on the best models available, through whichever terminal is closest at hand. And you might never need to open a code file.
|
|
36
36
|
|
|
37
|
-
The product is the orchestrator. Everything else plugs in. **And
|
|
37
|
+
The product is the orchestrator itself. Everything else simply plugs in. **And what's cooler is that this orchestrator is entirely self-bootstrapped**—pikiclaw is what we use to build pikiclaw.
|
|
38
38
|
|
|
39
|
-
```
|
|
40
|
-
Terminal
|
|
39
|
+
```text
|
|
40
|
+
Terminal Layer Telegram · Feishu · WeChat · Slack · Discord · DingTalk · WeCom · Web Dashboard
|
|
41
41
|
\__________________________|__________________________/
|
|
42
42
|
v
|
|
43
43
|
┌──────────────────────────────┐
|
|
@@ -46,88 +46,88 @@ The product is the orchestrator. Everything else plugs in. **And the orchestrato
|
|
|
46
46
|
|
|
|
47
47
|
┌────────────────────────────────────────┼────────────────────────────────────────┐
|
|
48
48
|
v v v
|
|
49
|
-
|
|
49
|
+
Agent Layer Model Layer Tool Layer
|
|
50
50
|
Claude Code · Codex · Gemini · Hermes Claude · GPT · Gemini · DeepSeek Skills · MCP · CLI
|
|
51
|
-
(driver registry · ACP · any agent)
|
|
51
|
+
(driver registry · ACP · any agent) Doubao · MiMo · MiniMax · OpenRouter (global × workspace)
|
|
52
52
|
· any OpenAI-compatible proxy · …
|
|
53
53
|
|
|
|
54
54
|
v
|
|
55
|
-
Your
|
|
55
|
+
Your Machine
|
|
56
56
|
```
|
|
57
57
|
|
|
58
|
-
- **Terminal
|
|
59
|
-
- **Agent
|
|
60
|
-
- **Model
|
|
61
|
-
- **Tool
|
|
58
|
+
- **Terminal Layer** — Telegram, Feishu, WeChat, Slack, Discord, DingTalk, WeCom, and the Web Dashboard are all first-class, co-equal entry points. New terminals plug right in.
|
|
59
|
+
- **Agent Layer** — We use the official Claude Code, Codex, Gemini, and Hermes CLIs as underlying drivers. Hermes communicates via ACP (Agent Client Protocol); our flexible registry can accommodate virtually any agent.
|
|
60
|
+
- **Model Layer** — Access Claude, GPT, Gemini, leading Chinese domestic models (DeepSeek, Doubao, MiMo, MiniMax), plus OpenRouter and any OpenAI-compatible proxy. Providers and Profiles are treated as a first-class layer with their own credential vault, a read-only models.dev catalog, and per-agent environment injection.
|
|
61
|
+
- **Tool Layer** — Skills, MCP servers, and CLI tools are intelligently merged across global and workspace scopes, automatically injected into every session.
|
|
62
62
|
|
|
63
63
|
---
|
|
64
64
|
|
|
65
|
-
## Built with
|
|
65
|
+
## Built with Itself
|
|
66
66
|
|
|
67
|
-
> The most credible test of an Agent orchestrator is whether it can build itself. pikiclaw can. We use pikiclaw to develop, test, release, and operate pikiclaw
|
|
67
|
+
> The most credible test of an Agent orchestrator is whether it can build itself. pikiclaw can. We use pikiclaw to develop, test, release, and operate pikiclaw—driving every commit and every release.
|
|
68
68
|
|
|
69
|
-
A typical day
|
|
69
|
+
A typical day of development inside pikiclaw:
|
|
70
70
|
|
|
71
|
-
- A Claude Code session in
|
|
72
|
-
- A Codex session in
|
|
73
|
-
- A Gemini session in
|
|
74
|
-
-
|
|
75
|
-
- All four streams run in parallel;
|
|
71
|
+
- A Claude Code session in pane 1 implements a new dashboard route.
|
|
72
|
+
- A Codex session in pane 2 writes the matching unit tests against the same workspace.
|
|
73
|
+
- A Gemini session in pane 3 reviews the diffs and drafts the changelog.
|
|
74
|
+
- Meanwhile, a background skill (`/sk_promote`) sweeps GitHub for relevant issues and automatically drafts replies in a fourth thread.
|
|
75
|
+
- All four streams run entirely in parallel; a single human steers them all from a phone in a coffee shop.
|
|
76
76
|
|
|
77
|
-
The orchestrator is the product. It also happens to be the IDE the orchestrator is built
|
|
77
|
+
The orchestrator is the product. It also happens to be the ultimate IDE in which the orchestrator itself is built.
|
|
78
78
|
|
|
79
79
|
---
|
|
80
80
|
|
|
81
|
-
## A
|
|
81
|
+
## A Swarm by Default
|
|
82
82
|
|
|
83
|
-
Most "AI dev tools" assume one user, one agent, one task at a time. pikiclaw assumes the opposite: **N agents, N windows, one operator, one toolkit.**
|
|
83
|
+
Most "AI dev tools" assume a 1:1:1 ratio: one user, one agent, one task at a time. pikiclaw assumes the exact opposite: **N agents, N windows, one operator, one unified toolkit.**
|
|
84
84
|
|
|
85
|
-
- **N
|
|
86
|
-
- **Mix-and-
|
|
87
|
-
- **One
|
|
88
|
-
- **Steer
|
|
89
|
-
- **Group
|
|
85
|
+
- **N Parallel Sessions** — Every dashboard pane represents an independent agent stream tied to an independent session workspace. Add IM threads, and you scale effortlessly.
|
|
86
|
+
- **Mix-and-Match Agents** — Run Claude Code in pane 1, Codex in pane 2, and Gemini in pane 3, all working simultaneously on different repositories or workspaces.
|
|
87
|
+
- **One Unified Toolkit** — Global skills, global MCP servers, and per-workspace overrides apply uniformly. Configure it once, and every session inherits the power.
|
|
88
|
+
- **Steer from Anywhere** — Interrupt any running stream, queue a follow-up instruction, or hand over control to the next agent in line seamlessly.
|
|
89
|
+
- **Group Collaboration Mode** — Drop the orchestrator into a Feishu, Slack, Discord, or WeCom group, and let your entire team share and steer the same agent swarm.
|
|
90
90
|
|
|
91
|
-
This is the shape that matters: one creator, with a swarm at their fingertips.
|
|
91
|
+
This is the shape that matters: one creator, with a swarm of AI agents at their fingertips.
|
|
92
92
|
|
|
93
93
|
---
|
|
94
94
|
|
|
95
|
-
## See
|
|
95
|
+
## See It in Action
|
|
96
96
|
|
|
97
|
-
> **Real
|
|
97
|
+
> **Real-world Task** — Ask pikiclaw to gather and summarize today's AI news; the agent reads, writes, and ships the results back through Telegram, all controlled from your phone.
|
|
98
98
|
|
|
99
|
-
<p align="center"><img src="docs/promo-demo.gif" alt="Demo:
|
|
99
|
+
<p align="center"><img src="docs/promo-demo.gif" alt="Demo: Ask Telegram, agent works locally, result returns to chat" width="780"></p>
|
|
100
100
|
|
|
101
|
-
> **Web Dashboard** — multi-pane workspace
|
|
101
|
+
> **Web Dashboard** — A multi-pane workspace featuring a session list, conversation threads, tool-use traces, and an input composer (supporting 1, 2, 3, or 6-pane layouts).
|
|
102
102
|
|
|
103
103
|
<p align="center"><img src="docs/promo-dashboard-workspace.png" alt="Web Dashboard workspace" width="780"></p>
|
|
104
104
|
|
|
105
105
|
<details>
|
|
106
|
-
<summary><b>More:
|
|
106
|
+
<summary><b>More: Basic Ops · IM Access · Agents · Models · Extensions · Permissions · System Info</b></summary>
|
|
107
107
|
|
|
108
|
-
> Send a message, watch the agent stream, receive files back.
|
|
108
|
+
> Send a message, watch the agent stream its thoughts, and receive files back instantly.
|
|
109
109
|
|
|
110
110
|
<img src="docs/promo-basic-ops.gif" alt="Basic operations" width="780">
|
|
111
111
|
|
|
112
|
-
> **IM Access** — Telegram, Feishu, WeChat, Slack, Discord, DingTalk,
|
|
112
|
+
> **IM Access** — Check and configure connection statuses for Telegram, Feishu, WeChat, Slack, Discord, DingTalk, and WeCom.
|
|
113
113
|
|
|
114
114
|
<img src="docs/promo-dashboard-im.png" alt="IM Access" width="780">
|
|
115
115
|
|
|
116
|
-
> **Agents** — installed agent CLIs, default agent, per-agent
|
|
116
|
+
> **Agents** — Manage installed agent CLIs, set your default agent, and configure per-agent models and reasoning effort levels.
|
|
117
117
|
|
|
118
118
|
<img src="docs/promo-dashboard-agents.png" alt="Agents" width="780">
|
|
119
119
|
|
|
120
|
-
> **Models** — Providers + Profiles vault (Claude, GPT, Gemini, DeepSeek,
|
|
120
|
+
> **Models** — A secure Providers + Profiles vault (supporting Claude, GPT, Gemini, DeepSeek, Doubao, MiMo, MiniMax, OpenRouter, and any OpenAI-compatible proxy), validated against the models.dev catalog and injected directly per agent.
|
|
121
121
|
|
|
122
|
-
> **Extensions** — global MCP servers, community skills,
|
|
122
|
+
> **Extensions** — Manage global MCP servers, community skills, and built-in automation for headless browsers and macOS desktop (Peekaboo).
|
|
123
123
|
|
|
124
124
|
<img src="docs/promo-dashboard-extensions.png" alt="Extensions" width="780">
|
|
125
125
|
|
|
126
|
-
> **System Permissions** — macOS
|
|
126
|
+
> **System Permissions** — Handle macOS Accessibility, Screen Recording, and Disk Access permissions seamlessly.
|
|
127
127
|
|
|
128
128
|
<img src="docs/promo-dashboard-permissions.png" alt="Permissions" width="780">
|
|
129
129
|
|
|
130
|
-
> **System Info** — working directory
|
|
130
|
+
> **System Info** — Monitor your working directory alongside real-time CPU, memory, and disk usage.
|
|
131
131
|
|
|
132
132
|
<img src="docs/promo-dashboard-system.png" alt="System Info" width="780">
|
|
133
133
|
|
|
@@ -135,9 +135,9 @@ This is the shape that matters: one creator, with a swarm at their fingertips.
|
|
|
135
135
|
|
|
136
136
|
---
|
|
137
137
|
|
|
138
|
-
## Quick
|
|
138
|
+
## Quick Start
|
|
139
139
|
|
|
140
|
-
**
|
|
140
|
+
**Prerequisites:** Node.js 20+, plus at least one official Agent CLI installed and authenticated on your system:
|
|
141
141
|
|
|
142
142
|
- [`claude`](https://docs.anthropic.com/en/docs/claude-code) (Claude Code)
|
|
143
143
|
- [`codex`](https://github.com/openai/codex) (Codex CLI)
|
|
@@ -153,147 +153,147 @@ npx pikiclaw@latest
|
|
|
153
153
|
|
|
154
154
|
<p align="center"><img src="docs/promo-install.gif" alt="One-command install" width="780"></p>
|
|
155
155
|
|
|
156
|
-
|
|
156
|
+
This instantly opens the **Web Dashboard** at `http://localhost:3939`. From there, you can drive sessions in the browser, connect IM channels, configure agents and models, install MCP servers and skills, and manage system permissions. Everything else is just one click away.
|
|
157
157
|
|
|
158
158
|
<details>
|
|
159
|
-
<summary><b>Prefer the terminal?
|
|
159
|
+
<summary><b>Prefer the terminal? We have a setup wizard.</b></summary>
|
|
160
160
|
|
|
161
161
|
```bash
|
|
162
|
-
npx pikiclaw@latest --setup #
|
|
163
|
-
npx pikiclaw@latest --doctor #
|
|
162
|
+
npx pikiclaw@latest --setup # Interactive terminal setup wizard
|
|
163
|
+
npx pikiclaw@latest --doctor # Environment health check only
|
|
164
164
|
```
|
|
165
165
|
|
|
166
166
|
</details>
|
|
167
167
|
|
|
168
168
|
---
|
|
169
169
|
|
|
170
|
-
##
|
|
170
|
+
## How People Are Using It
|
|
171
171
|
|
|
172
|
-
- **Run a
|
|
173
|
-
- **Self-
|
|
174
|
-
- **Walk-
|
|
175
|
-
- **Multi-
|
|
176
|
-
- **Domestic
|
|
177
|
-
- **Group
|
|
178
|
-
- **Computer-
|
|
179
|
-
- **Skill-
|
|
172
|
+
- **Run a Swarm in Parallel** — Open N sessions in N dashboard panes (or N IM threads), each running a different agent on a different workspace, all executing simultaneously. One person, many agents, one unified cockpit. Steer any of them at any moment.
|
|
173
|
+
- **Self-Hosted Dev Loop** — pikiclaw was built using pikiclaw. The dev workflow *is* the product: drive the orchestrator from your phone, write code, ship a release, and iterate.
|
|
174
|
+
- **Walk-Away Coding** — Kick off a massive refactoring task, close your laptop, and monitor/steer it from your phone over Telegram. The agent continues running locally, streaming results back to your chat.
|
|
175
|
+
- **Multi-Agent Tag Team** — Let Claude Code draft an initial implementation, switch to Codex for an in-depth review, and finally hand it over to Gemini for a fresh perspective. Same files, same continuous session history.
|
|
176
|
+
- **Domestic Model Routing** — When latency, cost, or compliance demands a non-frontier model, use a wrapper driver to run Claude Code effortlessly on DeepSeek or Doubao.
|
|
177
|
+
- **The Group Chat Agent** — Drop pikiclaw into a Feishu, Slack, Discord, or WeCom workgroup. The entire team shares one orchestrator, one project workspace, and a unified set of powerful skills.
|
|
178
|
+
- **Computer-Use, Controlled by You** — Enable the managed Chrome (Playwright) and macOS desktop (Peekaboo, via Accessibility + ScreenCaptureKit) capabilities. The agent can suddenly `see` the screen, click, type, and manage windows, menus, and the Dock—while you steer it from your phone. Book a meeting, scrape a complex dashboard, run end-to-end tests, or drive any native macOS application.
|
|
179
|
+
- **Skill-Driven Workflows** — Install community skills (`promote`, `snipe`, `review`, `security-review`, etc.) once, and trigger them instantly from any connected terminal using `/sk_<name>`.
|
|
180
180
|
|
|
181
181
|
---
|
|
182
182
|
|
|
183
|
-
## Features
|
|
183
|
+
## Core Features
|
|
184
184
|
|
|
185
|
-
### Terminal
|
|
185
|
+
### Terminal Layer
|
|
186
186
|
|
|
187
|
-
- **Seven IM
|
|
188
|
-
- **Web Dashboard** —
|
|
189
|
-
- **Live
|
|
187
|
+
- **Seven Native IM Channels** — Telegram, Feishu, WeChat (personal), Slack, Discord, DingTalk, and WeCom. Run one, several, or all of them simultaneously. Each channel is strictly isolated at the code level; adding a new one (like WhatsApp or a mobile app) requires zero changes to the others.
|
|
188
|
+
- **Web Dashboard** — Drive sessions directly from your browser with the exact same conversational flow, tool-use tracing, and streaming experience as IM. Enjoy a multi-pane workspace (1/2/3/6 panes), light/dark themes, and full EN/中文 i18n support.
|
|
189
|
+
- **Live Streaming Preview** — Watch messages update in place as the agent thinks. Long text auto-splits beautifully; images and files stream back to the UI in real time.
|
|
190
190
|
|
|
191
|
-
### Agent
|
|
191
|
+
### Agent Layer
|
|
192
192
|
|
|
193
|
-
- **Official CLIs as
|
|
194
|
-
- **ACP-
|
|
195
|
-
- **Pluggable
|
|
196
|
-
- **Per-
|
|
197
|
-
- **Steer** —
|
|
198
|
-
- **Codex
|
|
199
|
-
- **Persistent
|
|
193
|
+
- **Official CLIs as Drivers** — Powered directly by Claude Code, Codex CLI, Gemini CLI, and Hermes (via ACP). We don't rewrite the agent core—you inherit upstream capabilities and Day-0 updates automatically.
|
|
194
|
+
- **ACP-Native Architecture** — Hermes integrates natively through the [Agent Client Protocol](https://agentclientprotocol.com), spawning `hermes acp` over JSON-RPC stdio. Any future ACP-compatible agent plugs in the exact same way.
|
|
195
|
+
- **Pluggable Driver Registry** — The only contract is `src/agent/driver.ts`. New CLI- or ACP-based agents can drop right in alongside our four built-in drivers.
|
|
196
|
+
- **Per-Session Agent Switching** — Swap the "brain" on the fly without leaving your workspace.
|
|
197
|
+
- **Steer & Interrupt** — Interrupt a heavy running task and force a queued message to the front of the line.
|
|
198
|
+
- **Codex Human-in-the-Loop** — When Codex pauses to ask you a question, it forwards the prompt interactively to your IM. Reply directly in the chat, and the task resumes seamlessly.
|
|
199
|
+
- **Persistent Goals** — Use `/goal` to set a long-running, session-scoped objective complete with a token budget. Supports pause/resume, and the agent will autonomously self-terminate only when it verifies the goal is complete.
|
|
200
200
|
|
|
201
|
-
### Model
|
|
201
|
+
### Model Layer
|
|
202
202
|
|
|
203
|
-
- **Frontier +
|
|
204
|
-
- **Providers
|
|
205
|
-
- **Per-
|
|
206
|
-
- **Per-
|
|
203
|
+
- **Frontier + Domestic + Proxies** — Supports the Claude 4 family, GPT-5 / Codex, Gemini, DeepSeek, Doubao, MiMo, MiniMax, OpenRouter, and any custom OpenAI-compatible proxy endpoint.
|
|
204
|
+
- **Providers & Profiles Vault** — A first-class data model that securely isolates credentials in `~/.pikiclaw/setting.json`. Browse a read-only models.dev catalog, validate keys with real provider probes, and bind a profile to an agent for automatic environment injection at spawn-time.
|
|
205
|
+
- **Per-Session Model & Reasoning Effort** — Switch models or adjust reasoning capabilities dynamically via the Dashboard, `/models`, or `/mode`.
|
|
206
|
+
- **Per-Agent Deep Injection** — `resolveAgentInjection(agentId)` forces the active profile's environment variables down at spawn time. This means you can run Claude Code on top of DeepSeek or Doubao without ever touching the upstream client's config.
|
|
207
207
|
|
|
208
|
-
### Tool
|
|
208
|
+
### Tool Layer
|
|
209
209
|
|
|
210
|
-
- **Skills** —
|
|
211
|
-
- **MCP
|
|
212
|
-
- **CLI
|
|
213
|
-
- **Session-
|
|
214
|
-
- **Two-
|
|
210
|
+
- **Robust Skills System** — Project-specific skills live safely in `.pikiclaw/skills/*/SKILL.md` (and we fully support legacy `.claude/commands/*.md` formats). Install community packages with one click from GitHub (`owner/repo`) or browse our curated packs (like Anthropic Official, Vercel Agent Skills, etc.). Trigger them anywhere with `/skills` and `/sk_<name>`.
|
|
211
|
+
- **Massive MCP Server Ecosystem** — Browse the [MCP Registry](https://registry.modelcontextprotocol.io), add custom stdio or HTTP servers, enforce real handshake health-checks, and utilize OAuth 2.1 with Dynamic Client Registration. Our recommended catalog flawlessly covers GitHub, Atlassian, Notion, Linear, Sentry, Cloudflare, Slack, Feishu/Lark, Stripe, Hugging Face, Gamma, Brave Search, Perplexity, Filesystem, SQLite, and PostgreSQL. Furthermore, we ship with two built-in, hyper-powerful computer-use servers: `pikiclaw-browser` (driving Chrome via Playwright) and `peekaboo` (driving the macOS GUI via Peekaboo).
|
|
212
|
+
- **Seamless CLI Tool Integration** — Auto-detects versions and authentication states for popular CLIs. We natively support OAuth-web login handoffs for browser-based authentications, routing everything smoothly through the agent's standard tool surface.
|
|
213
|
+
- **Session-Scoped MCP Bridge** — Foundational tools like `im_list_files`, `im_send_file`, `im_ask_user`, alongside the managed browser and macOS desktop tools (when enabled), are automatically injected deep into every single session you launch.
|
|
214
|
+
- **Two-Tier Merge Resolution** — Tool scopes follow a simple rule: `global < workspace < built-in`. The engine automatically resolves and merges these, applying them silently to every session.
|
|
215
215
|
|
|
216
216
|
<p align="center"><img src="docs/promo-dashboard-extensions-add.png" alt="Add MCP server" width="780"></p>
|
|
217
217
|
|
|
218
|
-
### Runtime &
|
|
218
|
+
### Runtime & Developer Experience
|
|
219
219
|
|
|
220
|
-
- **Session
|
|
221
|
-
- **Resume,
|
|
222
|
-
- **
|
|
223
|
-
- **Computer-
|
|
224
|
-
- **Computer-
|
|
225
|
-
- **Long
|
|
220
|
+
- **Dedicated Session Workspaces** — Every session gets its own isolated directory; file attachments and generated assets drop there automatically.
|
|
221
|
+
- **Resume, Switch, and Classify** — Flawless multi-turn conversation support with smart session classification (identifying answers, proposals, implementations, or blocked states).
|
|
222
|
+
- **Auto-Injected Base Tools** — Core MCP tools like file listing, sending, user prompting, and goal tracking are hard-wired into every stream.
|
|
223
|
+
- **Computer-Use (Browser Engine)** — The built-in `pikiclaw-browser` MCP is a hyper-charged wrapper over `@playwright/mcp`. It includes a process-level supervisor and shares an isolated Chrome profile. Log in to your tools once, and reuse those authenticated sessions across all future tasks!
|
|
224
|
+
- **Computer-Use (macOS Desktop)** — Enable the `peekaboo` MCP built-in server (macOS only) to unleash the [Peekaboo](https://peekaboo.sh/) framework over Accessibility and ScreenCaptureKit APIs. It exposes a god-mode suite of tools: `see`, `click`, `type`, `scroll`, `window`, `menu`, `app`, and `dock`. Requires explicit OS-level permissions but grants unprecedented control.
|
|
225
|
+
- **Hardened for Long Tasks** — Built with sleep prevention, watchdog timers, auto-restarts, daemon modes, and a robust channel supervisor. You can walk away knowing your marathon tasks are protected by an ironclad runtime.
|
|
226
226
|
|
|
227
227
|
---
|
|
228
228
|
|
|
229
|
-
## How
|
|
229
|
+
## How Is This Different?
|
|
230
230
|
|
|
231
|
-
| | pikiclaw | IDE
|
|
231
|
+
| Feature | pikiclaw | IDE Assistants<br>(Cursor / Windsurf / Aider) | Cloud Agents<br>(Devin / Web Claude) | Single-Agent IM Bots |
|
|
232
232
|
|---|---|---|---|---|
|
|
233
|
-
| **Terminal** | 7 IM channels + Web +
|
|
234
|
-
| **
|
|
235
|
-
| **Agent
|
|
236
|
-
| **Model
|
|
237
|
-
| **
|
|
238
|
-
| **Files
|
|
239
|
-
| **
|
|
240
|
-
| **
|
|
241
|
-
| **Self-
|
|
242
|
-
|
|
243
|
-
The shape that matters: **
|
|
233
|
+
| **Terminal Access** | 7 IM channels + Web + Extensible | Locked inside the IDE | Confined to a Web app | One specific IM app |
|
|
234
|
+
| **Execution Environment** | Your local machine | Your local machine | Vendor's remote sandbox | Usually vendor servers |
|
|
235
|
+
| **Agent Flexibility** | Claude Code, Codex, Gemini, Hermes (ACP), etc. | Locked in | Single | Single |
|
|
236
|
+
| **Model Freedom** | Frontier models, domestic giants, OpenAI-proxies | Controlled by the platform | Controlled by the vendor | Single, hardcoded |
|
|
237
|
+
| **Concurrency Power** | **N Agents × N Windows × N Workspaces** | One agent per IDE window | Strictly sequential | Single thread |
|
|
238
|
+
| **Files & Tools Access** | Your entire local disk, your MCPs, your CLIs | Local project files | Heavily sandboxed | None or extremely limited |
|
|
239
|
+
| **Add a New Terminal** | Drop in a simple `Channel` class | Impossible | Impossible | Requires a hard fork |
|
|
240
|
+
| **Add a New Agent** | Implement a simple `AgentDriver` (CLI or ACP) | Impossible | Impossible | Requires a hard fork |
|
|
241
|
+
| **Self-Bootstrapping** | **Yes — completely built using itself** | No | No | No |
|
|
242
|
+
|
|
243
|
+
The shape that truly matters: **You never have to leave your preferred environment, you retain total choice over the "brain", you can drive a massive swarm in parallel, and the orchestrator is the exact same tool we use to build the orchestrator.**
|
|
244
244
|
|
|
245
245
|
---
|
|
246
246
|
|
|
247
|
-
##
|
|
247
|
+
## Command Reference
|
|
248
248
|
|
|
249
249
|
| Command | Description |
|
|
250
250
|
|---|---|
|
|
251
|
-
| `/start` |
|
|
252
|
-
| `/sessions` | View, switch, or create sessions |
|
|
253
|
-
| `/agents` | Switch
|
|
254
|
-
| `/models` | View and switch model
|
|
255
|
-
| `/mode` | Toggle plan mode
|
|
256
|
-
| `/switch` | Browse and switch working directory |
|
|
251
|
+
| `/start` | View entry info, the active agent, and your working directory |
|
|
252
|
+
| `/sessions` | View, switch, or create new sessions |
|
|
253
|
+
| `/agents` | Switch the active Agent (Claude · Codex · Gemini · Hermes) |
|
|
254
|
+
| `/models` | View and switch the model or reasoning effort for the session |
|
|
255
|
+
| `/mode` | Toggle plan mode / reasoning effort |
|
|
256
|
+
| `/switch` | Browse and switch the working directory |
|
|
257
257
|
| `/workspaces` | Pick a saved workspace from the Dashboard's quick-pick list |
|
|
258
258
|
| `/goal` | Set or inspect a long-running, self-terminating session goal |
|
|
259
|
-
| `/stop` |
|
|
260
|
-
| `/status` |
|
|
261
|
-
| `/host` |
|
|
262
|
-
| `/skills` | Browse project skills |
|
|
263
|
-
| `/ext` |
|
|
264
|
-
| `/restart` | Restart and re-launch
|
|
265
|
-
| `/sk_<name>` |
|
|
259
|
+
| `/stop` | Force-stop the current session |
|
|
260
|
+
| `/status` | Check runtime status, token usage, resource consumption, and session info |
|
|
261
|
+
| `/host` | Monitor host CPU, memory, disk, and battery levels |
|
|
262
|
+
| `/skills` | Browse available project skills |
|
|
263
|
+
| `/ext` | View the extensions overview |
|
|
264
|
+
| `/restart` | Restart and re-launch the underlying Bot service |
|
|
265
|
+
| `/sk_<name>` | Instantly run a specific project skill |
|
|
266
266
|
|
|
267
|
-
Plain text is forwarded to the current agent
|
|
267
|
+
*Note: Plain text without a slash is forwarded directly to the current agent.*
|
|
268
268
|
|
|
269
269
|
---
|
|
270
270
|
|
|
271
271
|
## Configuration
|
|
272
272
|
|
|
273
|
-
- Persistent
|
|
274
|
-
- The Dashboard is the primary configuration
|
|
275
|
-
- Global MCP extensions
|
|
276
|
-
- Workspace MCP extensions
|
|
277
|
-
- Project skills
|
|
273
|
+
- **Persistent Configuration:** `~/.pikiclaw/setting.json` stores your channels, agents, Providers/Profiles, workspaces, and MCP extensions.
|
|
274
|
+
- The **Dashboard** is the primary UI for configuration. The terminal wizard (`--setup`) and the doctor script (`--doctor`) are available for headless or CLI-first users.
|
|
275
|
+
- Global MCP extensions are stored under the `extensions.mcp` key in the setting file.
|
|
276
|
+
- Workspace MCP extensions follow standard conventions and are read from `.mcp.json` in the project root.
|
|
277
|
+
- Project skills are loaded automatically from `.pikiclaw/skills/*/SKILL.md` (and we also support legacy `.claude/commands/*.md` formats).
|
|
278
278
|
|
|
279
|
-
**Computer-
|
|
279
|
+
**Computer-Use Toggles** (managed via the Extensions dashboard):
|
|
280
280
|
|
|
281
|
-
- `browserEnabled` — managed Chrome (Playwright).
|
|
282
|
-
- `peekabooEnabled` — macOS desktop (Peekaboo).
|
|
281
|
+
- `browserEnabled` — Enables managed Chrome (Playwright). Upon first use, pikiclaw creates a dedicated profile in `~/.pikiclaw` and reuses it for subsequent sessions. Log in once, and never scan a QR code or enter a password for those tools again.
|
|
282
|
+
- `peekabooEnabled` — Enables macOS desktop automation (Peekaboo). Available on macOS only. Activating this launches `@steipete/peekaboo`'s `peekaboo-mcp` binary and injects its UI-controlling tools. *Note: You must grant your terminal **Accessibility** and **Screen Recording** permissions in System Settings → Privacy & Security before enabling this.*
|
|
283
283
|
|
|
284
284
|
---
|
|
285
285
|
|
|
286
286
|
## Roadmap
|
|
287
287
|
|
|
288
|
-
Already
|
|
288
|
+
**Already Shipped:** Hermes driver integration · ACP (Agent Client Protocol) · Secure Provider/Profile vault · Seven native IM channels · Computer-use via Playwright and Peekaboo (macOS).
|
|
289
289
|
|
|
290
|
-
- **More ACP
|
|
291
|
-
- **
|
|
292
|
-
- **Deeper
|
|
293
|
-
- **
|
|
294
|
-
- **Cross-
|
|
290
|
+
- **More ACP Agents** — Ensuring any new ACP-compatible agent can drop in with zero code changes.
|
|
291
|
+
- **Broader Terminal Ecosystem** — Adding support for WhatsApp, a dedicated mobile app, and voice interfaces.
|
|
292
|
+
- **Deeper Model Wrapping** — Building agent-on-arbitrary-model wrappers to support a wider array of domestic and open-source models seamlessly.
|
|
293
|
+
- **Richer Tool Ecosystem** — Releasing official MCP packs, skill templates, and a community marketplace.
|
|
294
|
+
- **Cross-Platform Computer-Use** — Extending desktop control drivers beyond macOS to support Windows and Linux.
|
|
295
295
|
|
|
296
|
-
|
|
296
|
+
For protocol-level insights, see our [ACP Migration Plan](docs/acp-migration.md).
|
|
297
297
|
|
|
298
298
|
---
|
|
299
299
|
|
|
@@ -308,43 +308,43 @@ npm test
|
|
|
308
308
|
```
|
|
309
309
|
|
|
310
310
|
```bash
|
|
311
|
-
npm run dev # local dev (--no-daemon, logs to ~/.pikiclaw/dev/dev.log)
|
|
312
|
-
npm run build #
|
|
313
|
-
npm test #
|
|
314
|
-
npx pikiclaw@latest --doctor #
|
|
311
|
+
npm run dev # Start local dev server (--no-daemon, logs to ~/.pikiclaw/dev/dev.log)
|
|
312
|
+
npm run build # Production build (Dashboard + tsc)
|
|
313
|
+
npm test # Run Vitest suite
|
|
314
|
+
npx pikiclaw@latest --doctor # Environment health check
|
|
315
315
|
```
|
|
316
316
|
|
|
317
|
-
|
|
317
|
+
For deep dives into the architecture and integration, see: [ARCHITECTURE.md](ARCHITECTURE.md) · [INTEGRATION.md](INTEGRATION.md) · [TESTING.md](TESTING.md).
|
|
318
318
|
|
|
319
319
|
---
|
|
320
320
|
|
|
321
321
|
## Contributing
|
|
322
322
|
|
|
323
|
-
|
|
323
|
+
Every layer of this project was designed from the ground up to be **extended**. Adding a new terminal, writing a new agent driver, wrapping a new model, or building a killer MCP tool—these are all first-class contributions.
|
|
324
324
|
|
|
325
|
-
- Read the **[Contributing Guide](CONTRIBUTING.md)** to get started
|
|
326
|
-
-
|
|
327
|
-
-
|
|
325
|
+
- Read the **[Contributing Guide](CONTRIBUTING.md)** to get started.
|
|
326
|
+
- Check out issues tagged with [`good first issue`](https://github.com/xiaotonng/pikiclaw/labels/good%20first%20issue) and [`help wanted`](https://github.com/xiaotonng/pikiclaw/labels/help%20wanted).
|
|
327
|
+
- For major architectural changes, please open an issue first to align on the technical approach.
|
|
328
328
|
|
|
329
|
-
|
|
|
329
|
+
| Module | What You Can Extend |
|
|
330
330
|
|---|---|
|
|
331
|
-
| `src/agent/driver.ts`, `src/agent/drivers/*.ts`, `src/agent/acp-client.ts` |
|
|
332
|
-
| `src/channels/base.ts`, `src/channels/*/` |
|
|
333
|
-
| `src/model/`, `src/model/injector.ts` |
|
|
334
|
-
| `src/dashboard/routes/*.ts` |
|
|
335
|
-
| `src/agent/mcp/tools/*.ts`, `src/agent/mcp/bridge.ts` |
|
|
336
|
-
| `src/catalog/*.ts` |
|
|
331
|
+
| `src/agent/driver.ts`, `src/agent/drivers/*.ts`, `src/agent/acp-client.ts` | Add a new Agent Driver (CLI-based or ACP-compatible) |
|
|
332
|
+
| `src/channels/base.ts`, `src/channels/*/` | Integrate a new Terminal or IM channel |
|
|
333
|
+
| `src/model/`, `src/model/injector.ts` | Add a new model provider or customize agent environment injection rules |
|
|
334
|
+
| `src/dashboard/routes/*.ts` | Expand the Dashboard backend API |
|
|
335
|
+
| `src/agent/mcp/tools/*.ts`, `src/agent/mcp/bridge.ts` | Add new session-scoped MCP tools |
|
|
336
|
+
| `src/catalog/*.ts` | Recommend high-quality MCP servers, CLI tools, or Skill repositories |
|
|
337
337
|
|
|
338
338
|
---
|
|
339
339
|
|
|
340
|
-
## Star
|
|
340
|
+
## Star History
|
|
341
341
|
|
|
342
342
|
<a href="https://www.star-history.com/#xiaotonng/pikiclaw&Date">
|
|
343
|
-
<img src="https://api.star-history.com/svg?repos=xiaotonng/pikiclaw&type=Date" alt="Star
|
|
343
|
+
<img src="https://api.star-history.com/svg?repos=xiaotonng/pikiclaw&type=Date" alt="Star History" width="640">
|
|
344
344
|
</a>
|
|
345
345
|
|
|
346
346
|
---
|
|
347
347
|
|
|
348
348
|
## License
|
|
349
349
|
|
|
350
|
-
[MIT](LICENSE) —
|
|
350
|
+
[MIT](LICENSE) — Built in the open. Use it, fork it, and plug in your own layers.
|