@pixelbyte-software/pixcode 1.35.5 → 1.36.0
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.de.md +116 -198
- package/README.ja.md +116 -192
- package/README.ko.md +116 -192
- package/README.md +201 -223
- package/README.ru.md +116 -198
- package/README.tr.md +205 -175
- package/README.zh-CN.md +116 -192
- package/dist/api-automation.html +110 -0
- package/dist/api-docs.html +18 -18
- package/dist/assets/index-BzRaZegN.css +32 -0
- package/dist/assets/{index-BnoShb9v.js → index-OkHfhUMk.js} +181 -180
- package/dist/docs.html +294 -0
- package/dist/features.html +112 -0
- package/dist/humans.txt +15 -0
- package/dist/index.html +2 -2
- package/dist/landing.html +217 -0
- package/dist/llms-full.txt +117 -0
- package/dist/llms.txt +53 -0
- package/dist/openapi.yaml +12 -9
- package/dist/orchestration.html +125 -0
- package/dist/robots.txt +4 -0
- package/dist/site.css +536 -0
- package/dist/sitemap.xml +51 -0
- package/dist-server/server/cli.js +51 -2
- package/dist-server/server/cli.js.map +1 -1
- package/dist-server/server/daemon/manager.js +0 -1
- package/dist-server/server/daemon/manager.js.map +1 -1
- package/dist-server/server/database/db.js +3 -2
- package/dist-server/server/database/db.js.map +1 -1
- package/dist-server/server/middleware/auth.js +9 -8
- package/dist-server/server/middleware/auth.js.map +1 -1
- package/dist-server/server/modules/orchestration/workflows/workflow-runner.js +156 -32
- package/dist-server/server/modules/orchestration/workflows/workflow-runner.js.map +1 -1
- package/dist-server/server/modules/providers/provider.routes.js +8 -1
- package/dist-server/server/modules/providers/provider.routes.js.map +1 -1
- package/dist-server/server/routes/agent.js +72 -11
- package/dist-server/server/routes/agent.js.map +1 -1
- package/dist-server/server/services/notification-orchestrator.js +11 -2
- package/dist-server/server/services/notification-orchestrator.js.map +1 -1
- package/dist-server/server/services/provider-cli-versions.js +142 -0
- package/dist-server/server/services/provider-cli-versions.js.map +1 -0
- package/dist-server/server/services/startup-update.js +208 -0
- package/dist-server/server/services/startup-update.js.map +1 -0
- package/package.json +35 -10
- package/server/cli.js +58 -3
- package/server/daemon/manager.js +0 -1
- package/server/database/db.js +3 -2
- package/server/middleware/auth.js +9 -8
- package/server/modules/orchestration/workflows/workflow-runner.ts +172 -32
- package/server/modules/providers/provider.routes.ts +8 -1
- package/server/routes/agent.js +75 -10
- package/server/services/notification-orchestrator.js +11 -2
- package/server/services/provider-cli-versions.js +149 -0
- package/server/services/startup-update.js +234 -0
- package/dist/assets/index-Btxg-Dbl.css +0 -32
package/README.zh-CN.md
CHANGED
|
@@ -1,240 +1,164 @@
|
|
|
1
1
|
<div align="center">
|
|
2
|
-
<img src="public/logo.
|
|
3
|
-
<h1>
|
|
4
|
-
<p><
|
|
2
|
+
<img src="public/logo.png" alt="Pixcode logo" width="96" height="96" />
|
|
3
|
+
<h1>Pixcode</h1>
|
|
4
|
+
<p><strong>面向 AI coding agent 的 self-hosted control room。</strong></p>
|
|
5
|
+
<p>
|
|
6
|
+
在一个 Web UI 中使用 Claude Code、Cursor CLI、Codex、Gemini CLI、Qwen Code 和 OpenCode,并集成 chat、shell、files、Git、orchestration、API keys、plugins、notifications、Telegram、desktop/server deployment。
|
|
7
|
+
</p>
|
|
8
|
+
<p>
|
|
9
|
+
<a href="README.md">English</a> ·
|
|
10
|
+
<a href="README.tr.md">Türkçe</a> ·
|
|
11
|
+
<a href="README.de.md">Deutsch</a> ·
|
|
12
|
+
<a href="README.ru.md">Русский</a> ·
|
|
13
|
+
<a href="README.ja.md">日本語</a> ·
|
|
14
|
+
<a href="README.ko.md">한국어</a>
|
|
15
|
+
</p>
|
|
5
16
|
</div>
|
|
6
17
|
|
|
7
|
-
|
|
8
|
-
<a href="https://github.com/alicomert/pixcode">Pixcode</a> · <a href="https://github.com/alicomert/pixcode">文档</a> · <a href="https://discord.gg/buxwujPNRE">Discord</a> · <a href="https://github.com/alicomert/pixcode/issues">Bug 报告</a> · <a href="CONTRIBUTING.md">贡献指南</a>
|
|
9
|
-
</p>
|
|
18
|
+
## Pixcode 是什么?
|
|
10
19
|
|
|
11
|
-
|
|
12
|
-
<a href="https://github.com/alicomert/pixcode"><img src="https://img.shields.io/badge/☁️_Pixcode_Cloud-Try_Now-0066FF?style=for-the-badge" alt="Pixcode"></a>
|
|
13
|
-
<a href="https://discord.gg/buxwujPNRE"><img src="https://img.shields.io/badge/Discord-Join%20Community-5865F2?style=for-the-badge&logo=discord&logoColor=white" alt="加入 Discord 社区"></a>
|
|
14
|
-
</p>
|
|
20
|
+
Pixcode 可以把你的本机、工作站或 Linux 服务器变成浏览器里的 AI development cockpit。你不需要在多个 terminal、CLI logs、file explorer、Git UI、provider settings 之间切换,Pixcode 把 coding-agent workflow 放在一个本地 Web App 里。
|
|
15
21
|
|
|
16
|
-
|
|
22
|
+
常见使用方式:
|
|
17
23
|
|
|
18
|
-
|
|
24
|
+
- **Local workstation**:在自己的电脑上运行 Pixcode,用更好的 UI 操作已有 CLI。
|
|
25
|
+
- **Always-on server**:在 Linux/VDS 上以 daemon 方式运行,从 laptop、tablet、phone 访问。
|
|
26
|
+
- **Desktop app**:使用 GitHub Releases 中的 Windows `.exe`、macOS `.dmg`、Linux build。
|
|
19
27
|
|
|
20
|
-
|
|
28
|
+
Pixcode 不是 hosted cloud IDE。Projects、credentials、CLI sessions、local files、Git state、MCP config 默认都保留在你的机器上。
|
|
21
29
|
|
|
22
|
-
|
|
30
|
+
## Screenshots
|
|
23
31
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
<
|
|
27
|
-
<h3>桌面视图</h3>
|
|
28
|
-
<img src="public/screenshots/desktop-main.png" alt="桌面界面" width="400">
|
|
29
|
-
<br>
|
|
30
|
-
<em>显示项目概览和聊天的主界面</em>
|
|
31
|
-
</td>
|
|
32
|
-
<td align="center">
|
|
33
|
-
<h3>移动体验</h3>
|
|
34
|
-
<img src="public/screenshots/mobile-chat.png" alt="移动界面" width="250">
|
|
35
|
-
<br>
|
|
36
|
-
<em>具有触控导航的响应式移动设计</em>
|
|
37
|
-
</td>
|
|
38
|
-
</tr>
|
|
39
|
-
<tr>
|
|
40
|
-
<td align="center" colspan="2">
|
|
41
|
-
<h3>CLI 选择</h3>
|
|
42
|
-
<img src="public/screenshots/cli-selection.png" alt="CLI 选择" width="400">
|
|
43
|
-
<br>
|
|
44
|
-
<em>在 Claude Code、Gemini、Cursor CLI 与 Codex 之间进行选择</em>
|
|
45
|
-
</td>
|
|
46
|
-
</tr>
|
|
47
|
-
</table>
|
|
32
|
+
| Workspace | Mobile chat |
|
|
33
|
+
| --- | --- |
|
|
34
|
+
| <img src="public/screenshots/desktop-main.png" alt="Pixcode desktop workspace" width="480" /> | <img src="public/screenshots/mobile-chat.png" alt="Pixcode mobile chat" width="260" /> |
|
|
48
35
|
|
|
49
|
-
|
|
36
|
+
| CLI selection | Tools and MCP |
|
|
37
|
+
| --- | --- |
|
|
38
|
+
| <img src="public/screenshots/cli-selection.png" alt="Pixcode CLI selection" width="420" /> | <img src="public/screenshots/tools-modal.png" alt="Pixcode tools modal" width="420" /> |
|
|
50
39
|
|
|
51
|
-
##
|
|
40
|
+
## 功能亮点
|
|
52
41
|
|
|
53
|
-
|
|
54
|
-
- **交互聊天界面** - 内置聊天 UI,轻松与 Agents 交流
|
|
55
|
-
- **集成 Shell 终端** - 通过内置 shell 功能直接访问 Agents CLI
|
|
56
|
-
- **文件浏览器** - 交互式文件树,支持语法高亮与实时编辑
|
|
57
|
-
- **Git 浏览器** - 查看、暂存并提交更改,还可切换分支
|
|
58
|
-
- **会话管理** - 恢复对话、管理多个会话并跟踪历史记录
|
|
59
|
-
- **插件系统** - 通过自定义选项卡、后端服务与集成扩展 Pixcode。 [开始构建 →](https://github.com/alicomert/pixcode)
|
|
60
|
-
- **TaskMaster AI 集成** *(可选)* - 结合 AI 任务规划、PRD 分析与工作流自动化,实现高级项目管理
|
|
61
|
-
- **模型兼容性** - 支持 Claude、GPT、Gemini 模型家族(完整支持列表见 [`shared/modelConstants.js`](shared/modelConstants.js))
|
|
42
|
+
### 多个 CLI,一个界面
|
|
62
43
|
|
|
63
|
-
|
|
44
|
+
- Claude Code、Cursor CLI、Codex、Gemini CLI、Qwen Code、OpenCode。
|
|
45
|
+
- Settings 中管理 provider auth、API key credentials、OAuth paste、install status、model list、CLI version status。
|
|
46
|
+
- Pixcode 不替代 native CLI,而是在其上增加 session management、WebSocket streaming、notifications、file context、project controls。
|
|
47
|
+
- UI 会显示 CLI 是在 thinking、tool execution、approval waiting 还是 output streaming。
|
|
64
48
|
|
|
65
|
-
###
|
|
49
|
+
### Chat、files、shell、source control
|
|
66
50
|
|
|
67
|
-
|
|
51
|
+
- Project-aware chat sessions 和 history。
|
|
52
|
+
- Prompt composer 固定在 chat/project screen 底部。
|
|
53
|
+
- Shell panel 在 desktop 上可作为 split panel 或 full panel 打开。
|
|
54
|
+
- File browser 支持 edit、upload、rename、delete、detailed view。
|
|
55
|
+
- Source Control 支持 Git status、diff、branch、commit、changed files。
|
|
56
|
+
- Split panels 提供 icon controls、close button、mobile-friendly responsive behavior。
|
|
68
57
|
|
|
69
|
-
|
|
58
|
+
### Changed files Command Center
|
|
70
59
|
|
|
71
|
-
|
|
60
|
+
Pixcode 会跟踪 local working tree 的变化。Quick Settings 中的 Command Center 可以即时显示 changed files,高亮新的改动,并跳转到相关 file/line。这样 AI agent 修改文件时,你可以看到它改了什么,同时保持 chat/orchestration view 不被关闭。
|
|
72
61
|
|
|
73
|
-
|
|
62
|
+
### Multi-agent orchestration
|
|
74
63
|
|
|
75
|
-
|
|
64
|
+
Orchestration 可以让多个 CLI agents 围绕同一个 goal 协作。
|
|
76
65
|
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
66
|
+
- **Agent Team**:按 frontend、backend、review、docs、custom role 拆分任务。
|
|
67
|
+
- **Multi-model Review**:用多个 provider/model 检查同一改动。
|
|
68
|
+
- **Sequential Handoff**:按阶段交接任务。
|
|
69
|
+
- **Decision Debate**:实现前比较不同 approach。
|
|
80
70
|
|
|
81
|
-
|
|
71
|
+
Controls:
|
|
82
72
|
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
73
|
+
- 按 run enable/disable agents,
|
|
74
|
+
- 同一个 provider 可创建多个 worker,
|
|
75
|
+
- agent 级 role、stage、label、instruction,
|
|
76
|
+
- agent 级 model selection,包含 OpenCode model,
|
|
77
|
+
- failed step 的 fallback CLI agent,
|
|
78
|
+
- workflow DAG preview,
|
|
79
|
+
- event streaming 和 cancel,
|
|
80
|
+
- resizable orchestration panes。
|
|
89
81
|
|
|
90
|
-
|
|
82
|
+
### API、Telegram、notifications
|
|
91
83
|
|
|
92
|
-
|
|
84
|
+
Pixcode frontend 本身使用 REST/WebSocket API。External automation 也可以用 Pixcode API key 使用同一个 control plane。新的 API keys 以 `px_` 开头,旧的 `ck_` keys 仍然兼容。
|
|
93
85
|
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
npx @pixelbyte-software/pixcode@latest sandbox ~/my-project
|
|
86
|
+
```bash
|
|
87
|
+
curl http://localhost:3001/api/projects \
|
|
88
|
+
-H "Authorization: Bearer px_your_key_here"
|
|
98
89
|
```
|
|
99
90
|
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
## 哪个选项更适合你?
|
|
105
|
-
|
|
106
|
-
Pixcode 是 Pixcode 的开源 UI 层。你可以在本地机器上自托管它,也可以使用提供团队功能与深入集成的 Pixcode。
|
|
107
|
-
|
|
108
|
-
| | Pixcode(自托管) | Pixcode |
|
|
109
|
-
|---|---|---|
|
|
110
|
-
| **适合对象** | 需要为本地代理会话提供完整 UI 的开发者 | 需要部署在云端,随时从任何地方访问代理的团队与开发者 |
|
|
111
|
-
| **访问方式** | 通过 `[yourip]:port` 在浏览器中访问 | 浏览器、任意 IDE、REST API、n8n |
|
|
112
|
-
| **设置** | `npx @pixelbyte-software/pixcode` | 无需设置 |
|
|
113
|
-
| **机器需保持开机吗** | 是 | 否 |
|
|
114
|
-
| **移动端访问** | 网络内任意浏览器 | 任意设备(原生应用即将推出) |
|
|
115
|
-
| **可用会话** | 自动发现 `~/.claude` 中的所有会话 | 云端环境内的会话 |
|
|
116
|
-
| **支持的 Agents** | Claude Code、Cursor CLI、Codex、Gemini CLI | Claude Code、Cursor CLI、Codex、Gemini CLI |
|
|
117
|
-
| **文件浏览与 Git** | 内置于 UI | 内置于 UI |
|
|
118
|
-
| **MCP 配置** | UI 管理,与本地 `~/.claude` 配置同步 | UI 管理 |
|
|
119
|
-
| **IDE 访问** | 本地 IDE | 任何连接到云环境的 IDE |
|
|
120
|
-
| **REST API** | 是 | 是 |
|
|
121
|
-
| **n8n 节点** | 否 | 是 |
|
|
122
|
-
| **团队共享** | 否 | 是 |
|
|
123
|
-
| **平台费用** | 免费开源 | 起价 $7/月 |
|
|
124
|
-
|
|
125
|
-
> 两种方式都使用你自己的 AI 订阅(Claude、Cursor 等)— Pixcode 提供环境,而非 AI。
|
|
126
|
-
|
|
127
|
-
---
|
|
128
|
-
|
|
129
|
-
## 安全与工具配置
|
|
130
|
-
|
|
131
|
-
**🔒 重要提示**: 所有 Claude Code 工具默认**禁用**,可防止潜在的有害操作自动运行。
|
|
132
|
-
|
|
133
|
-
### 启用工具
|
|
134
|
-
|
|
135
|
-
1. **打开工具设置** - 点击侧边栏齿轮图标
|
|
136
|
-
2. **选择性启用** - 仅启用所需工具
|
|
137
|
-
3. **应用设置** - 偏好设置保存在本地
|
|
138
|
-
|
|
139
|
-
<div align="center">
|
|
140
|
-
|
|
141
|
-

|
|
142
|
-
*工具设置界面 - 只启用你需要的内容*
|
|
143
|
-
|
|
144
|
-
</div>
|
|
145
|
-
|
|
146
|
-
**推荐做法**: 先启用基础工具,再根据需要添加其他工具。随时可以调整。
|
|
91
|
+
- `POST /api/agent` for one-shot agent runs.
|
|
92
|
+
- `/api/orchestration/workflows/*` for preview, start, stream, cancel.
|
|
93
|
+
- Browser push notifications.
|
|
94
|
+
- Telegram pairing、task notifications、optional prompt bridge。
|
|
147
95
|
|
|
148
|
-
|
|
96
|
+
OpenAPI: [`public/openapi.yaml`](public/openapi.yaml)
|
|
149
97
|
|
|
150
|
-
|
|
98
|
+
### Themes、plugins、MCP
|
|
151
99
|
|
|
152
|
-
|
|
100
|
+
- Dark/light mode。
|
|
101
|
+
- Emerald、VS Code-like accent palettes。
|
|
102
|
+
- Custom light/dark accent colors。
|
|
103
|
+
- Token-based styling for buttons、focus rings、navigation、active states。
|
|
104
|
+
- MCP server management。
|
|
105
|
+
- Plugin system with frontend tabs and optional backend services。
|
|
153
106
|
|
|
154
|
-
|
|
107
|
+
## Installation
|
|
155
108
|
|
|
156
|
-
|
|
157
|
-
|---|---|
|
|
158
|
-
| **[Project Stats](https://github.com/alicomert/pixcode)** | 展示当前项目的文件数、代码行数、文件类型分布、最大文件以及最近修改的文件 |
|
|
109
|
+
需要 Node.js 22+。
|
|
159
110
|
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
**[插件文档 →](https://github.com/alicomert/pixcode)** — 提供插件 API、清单格式、安全模型等完整指南。
|
|
165
|
-
|
|
166
|
-
---
|
|
167
|
-
|
|
168
|
-
## 常见问题
|
|
169
|
-
|
|
170
|
-
<details>
|
|
171
|
-
<summary>与 Claude Code Remote Control 有何不同?</summary>
|
|
172
|
-
|
|
173
|
-
Claude Code Remote Control 让你发送消息到本地终端中已经运行的会话。该方式要求你的机器保持开机,终端保持开启,断开网络后约 10 分钟会话会超时。
|
|
174
|
-
|
|
175
|
-
Pixcode 与 Pixcode 是对 Claude Code 的扩展,而非旁观 — MCP 服务器、权限、设置、会话与 Claude Code 完全一致。
|
|
176
|
-
|
|
177
|
-
- **覆盖全部会话** — Pixcode 会自动扫描 `~/.claude` 文件夹中的每个会话。Remote Control 只暴露当前活动的会话。
|
|
178
|
-
- **设置统一** — 在 Pixcode 中修改的 MCP、工具权限等设置会立即写入 Claude Code。
|
|
179
|
-
- **支持更多 Agents** — Claude Code、Cursor CLI、Codex、Gemini CLI。
|
|
180
|
-
- **完整 UI** — 除了聊天界面,还包括文件浏览器、Git 集成、MCP 管理和 Shell 终端。
|
|
181
|
-
- **Pixcode 保持运行于云端** — 关闭本地设备也不会中断代理运行,无需监控终端。
|
|
182
|
-
|
|
183
|
-
</details>
|
|
184
|
-
|
|
185
|
-
<details>
|
|
186
|
-
<summary>需要额外购买 AI 订阅吗?</summary>
|
|
187
|
-
|
|
188
|
-
需要。Pixcode 只提供环境。你仍需自行获取 Claude、Cursor、Codex 或 Gemini 订阅。Pixcode 从 $7/月起提供托管环境。
|
|
189
|
-
|
|
190
|
-
</details>
|
|
191
|
-
|
|
192
|
-
<details>
|
|
193
|
-
<summary>能在手机上使用 Pixcode 吗?</summary>
|
|
111
|
+
```bash
|
|
112
|
+
npx @pixelbyte-software/pixcode
|
|
113
|
+
```
|
|
194
114
|
|
|
195
|
-
|
|
115
|
+
Global install:
|
|
196
116
|
|
|
197
|
-
|
|
117
|
+
```bash
|
|
118
|
+
npm install -g @pixelbyte-software/pixcode
|
|
119
|
+
pixcode
|
|
120
|
+
```
|
|
198
121
|
|
|
199
|
-
|
|
200
|
-
<summary>UI 中的更改会影响本地 Claude Code 配置吗?</summary>
|
|
122
|
+
Open:
|
|
201
123
|
|
|
202
|
-
|
|
124
|
+
```text
|
|
125
|
+
http://localhost:3001
|
|
126
|
+
```
|
|
203
127
|
|
|
204
|
-
|
|
128
|
+
Desktop installers are available in GitHub Releases: Windows `.exe`, macOS `.dmg`, Linux AppImage/packages.
|
|
205
129
|
|
|
206
|
-
|
|
130
|
+
## Linux daemon
|
|
207
131
|
|
|
208
|
-
|
|
132
|
+
```bash
|
|
133
|
+
pixcode daemon install --mode auto --port 3001
|
|
134
|
+
pixcode daemon status --mode auto
|
|
135
|
+
pixcode daemon logs --mode auto
|
|
136
|
+
pixcode daemon restart --mode auto
|
|
137
|
+
```
|
|
209
138
|
|
|
210
|
-
|
|
211
|
-
- **[Discord](https://discord.gg/buxwujPNRE)** — 获取帮助并与社区交流
|
|
212
|
-
- **[GitHub Issues](https://github.com/alicomert/pixcode/issues)** — 报告 Bug 与建议功能
|
|
213
|
-
- **[贡献指南](CONTRIBUTING.md)** — 如何参与项目贡献
|
|
139
|
+
Foreground:
|
|
214
140
|
|
|
215
|
-
|
|
141
|
+
```bash
|
|
142
|
+
pixcode --no-daemon
|
|
143
|
+
```
|
|
216
144
|
|
|
217
|
-
|
|
145
|
+
## Development
|
|
218
146
|
|
|
219
|
-
|
|
147
|
+
```bash
|
|
148
|
+
npm install
|
|
149
|
+
npm run typecheck
|
|
150
|
+
npm run lint
|
|
151
|
+
npm run build
|
|
152
|
+
```
|
|
220
153
|
|
|
221
|
-
|
|
154
|
+
Notes:
|
|
222
155
|
|
|
223
|
-
|
|
224
|
-
-
|
|
225
|
-
-
|
|
226
|
-
- **[Codex](https://developers.openai.com/codex)** - OpenAI Codex
|
|
227
|
-
- **[Gemini-CLI](https://geminicli.com/)** - Google Gemini CLI
|
|
228
|
-
- **[React](https://react.dev/)** - 用户界面库
|
|
229
|
-
- **[Vite](https://vitejs.dev/)** - 快速构建工具与开发服务器
|
|
230
|
-
- **[Tailwind CSS](https://tailwindcss.com/)** - 实用先行 CSS 框架
|
|
231
|
-
- **[CodeMirror](https://codemirror.net/)** - 高级代码编辑器
|
|
232
|
-
- **[TaskMaster AI](https://github.com/eyaltoledano/claude-task-master)** *(可选)* - AI 驱动的项目管理与任务规划
|
|
156
|
+
- `npm run dev` uses the daemon manager on Linux.
|
|
157
|
+
- Use `npm run client` only for Vite frontend development.
|
|
158
|
+
- Normal runtime uses port `3001`; `5173` is for separate Vite dev.
|
|
233
159
|
|
|
234
|
-
|
|
235
|
-
- [Siteboon - AI powered website builder](https://siteboon.ai)
|
|
236
|
-
---
|
|
160
|
+
## Links
|
|
237
161
|
|
|
238
|
-
<
|
|
239
|
-
|
|
240
|
-
|
|
162
|
+
- npm: <https://www.npmjs.com/package/@pixelbyte-software/pixcode>
|
|
163
|
+
- GitHub: <https://github.com/alicomert/pixcode>
|
|
164
|
+
- Releases: <https://github.com/alicomert/pixcode/releases/latest>
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
<!doctype html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8" />
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
6
|
+
<title>Pixcode API Automation - px_ API Keys, Agent Runs and Workflow Control</title>
|
|
7
|
+
<meta
|
|
8
|
+
name="description"
|
|
9
|
+
content="Use Pixcode API automation with px_ API keys to list projects, run Claude Code, Codex, Cursor CLI, Gemini CLI, Qwen Code, and OpenCode tasks, preview orchestration workflows, start runs, stream events, cancel runs, and integrate Telegram or external tools."
|
|
10
|
+
/>
|
|
11
|
+
<meta
|
|
12
|
+
name="keywords"
|
|
13
|
+
content="Pixcode API, px API key, AI coding agent API, Codex API automation, Claude Code automation, OpenCode automation, orchestration REST API, self-hosted developer automation, coding agent webhook"
|
|
14
|
+
/>
|
|
15
|
+
<meta name="robots" content="index,follow,max-image-preview:large,max-snippet:-1" />
|
|
16
|
+
<link rel="canonical" href="https://alicomert.github.io/pixcode/api-automation.html" />
|
|
17
|
+
<link rel="icon" href="favicon.png" />
|
|
18
|
+
<link rel="stylesheet" href="site.css" />
|
|
19
|
+
</head>
|
|
20
|
+
<body>
|
|
21
|
+
<nav class="site-nav" aria-label="Main navigation">
|
|
22
|
+
<a class="brand" href="landing.html">
|
|
23
|
+
<img src="logo.png" alt="" />
|
|
24
|
+
<span>Pixcode</span>
|
|
25
|
+
</a>
|
|
26
|
+
<div class="nav-links">
|
|
27
|
+
<a href="docs.html">Documentation</a>
|
|
28
|
+
<a href="features.html">Features</a>
|
|
29
|
+
<a href="orchestration.html">Orchestration</a>
|
|
30
|
+
<a href="api-automation.html">API</a>
|
|
31
|
+
<a href="https://github.com/alicomert/pixcode">GitHub</a>
|
|
32
|
+
</div>
|
|
33
|
+
</nav>
|
|
34
|
+
|
|
35
|
+
<header class="hero docs-hero">
|
|
36
|
+
<div>
|
|
37
|
+
<div class="eyebrow">API automation</div>
|
|
38
|
+
<h1>Control Pixcode from scripts, dashboards, CI, and remote tools.</h1>
|
|
39
|
+
<p class="lead">
|
|
40
|
+
Pixcode exposes REST and WebSocket-powered workflows. Generate a `px_` API key, then trigger provider tasks, inspect projects, preview orchestration, start workflow runs, stream output, and cancel work from external clients.
|
|
41
|
+
</p>
|
|
42
|
+
</div>
|
|
43
|
+
<div class="image-slot">
|
|
44
|
+
<span><strong>API dashboard slot</strong>Recommended: 1400 x 1000. Show API keys, OpenAPI docs, and an automation request/result.</span>
|
|
45
|
+
</div>
|
|
46
|
+
</header>
|
|
47
|
+
|
|
48
|
+
<main>
|
|
49
|
+
<section class="section">
|
|
50
|
+
<h2>Authentication</h2>
|
|
51
|
+
<p class="sublead">
|
|
52
|
+
New Pixcode API keys start with `px_`. Older `ck_` keys remain accepted for compatibility, but new documentation and examples should use `px_`.
|
|
53
|
+
</p>
|
|
54
|
+
<div class="grid two">
|
|
55
|
+
<div class="code-panel"><pre><code>curl http://localhost:3001/api/projects \
|
|
56
|
+
-H "Authorization: Bearer px_your_key_here"</code></pre></div>
|
|
57
|
+
<div class="code-panel"><pre><code>curl http://localhost:3001/api/projects \
|
|
58
|
+
-H "X-API-Key: px_your_key_here"</code></pre></div>
|
|
59
|
+
</div>
|
|
60
|
+
</section>
|
|
61
|
+
|
|
62
|
+
<section class="section alt">
|
|
63
|
+
<h2>Run a one-shot agent task</h2>
|
|
64
|
+
<p class="sublead">
|
|
65
|
+
`POST /api/agent` is the external REST entry point for non-interactive automation. It can run a provider against a project path, optionally stream events, and optionally return buffered JSON with `stream: false`.
|
|
66
|
+
</p>
|
|
67
|
+
<div class="code-panel"><pre><code>curl http://localhost:3001/api/agent \
|
|
68
|
+
-H "Authorization: Bearer px_your_key_here" \
|
|
69
|
+
-H "Content-Type: application/json" \
|
|
70
|
+
-d '{
|
|
71
|
+
"provider": "codex",
|
|
72
|
+
"projectPath": "/home/me/project",
|
|
73
|
+
"message": "Review the current diff and list release risks.",
|
|
74
|
+
"stream": false
|
|
75
|
+
}'</code></pre></div>
|
|
76
|
+
</section>
|
|
77
|
+
|
|
78
|
+
<section class="section warm">
|
|
79
|
+
<h2>Workflow automation</h2>
|
|
80
|
+
<p class="sublead">
|
|
81
|
+
Orchestration endpoints can list workflow modes, preview expanded DAGs, start runs, read run state, stream events, and cancel active work.
|
|
82
|
+
</p>
|
|
83
|
+
<div class="grid two">
|
|
84
|
+
<div class="card"><strong>Preview</strong><p>Validate agent metadata and inspect the node graph before running child agents.</p></div>
|
|
85
|
+
<div class="card"><strong>Run</strong><p>Start the workflow and track node runs, A2A task IDs, status, events, and output.</p></div>
|
|
86
|
+
<div class="card"><strong>Stream</strong><p>Use run event endpoints to follow progress in dashboards or CLI scripts.</p></div>
|
|
87
|
+
<div class="card"><strong>Cancel</strong><p>Stop active orchestration runs when the user changes direction or detects bad output.</p></div>
|
|
88
|
+
</div>
|
|
89
|
+
</section>
|
|
90
|
+
|
|
91
|
+
<section class="section">
|
|
92
|
+
<h2>Common integration ideas</h2>
|
|
93
|
+
<ul class="feature-list">
|
|
94
|
+
<li>Ask Codex or Claude Code to review a Git diff from a CI job before release.</li>
|
|
95
|
+
<li>Trigger OpenCode or Gemini CLI from a custom internal dashboard.</li>
|
|
96
|
+
<li>Build a Telegram command that starts a Pixcode agent run on an always-on server.</li>
|
|
97
|
+
<li>Run multi-agent review on a branch before creating a tag or npm publish.</li>
|
|
98
|
+
<li>Expose a safe internal tool that lists projects and starts approved workflows.</li>
|
|
99
|
+
</ul>
|
|
100
|
+
<p>
|
|
101
|
+
Full OpenAPI reference: <a href="openapi.yaml">openapi.yaml</a>.
|
|
102
|
+
</p>
|
|
103
|
+
</section>
|
|
104
|
+
</main>
|
|
105
|
+
|
|
106
|
+
<footer class="footer">
|
|
107
|
+
<strong>Pixcode API automation</strong> · <a href="docs.html">Documentation</a> · <a href="openapi.yaml">OpenAPI</a> · <a href="llms.txt">llms.txt</a>
|
|
108
|
+
</footer>
|
|
109
|
+
</body>
|
|
110
|
+
</html>
|
package/dist/api-docs.html
CHANGED
|
@@ -214,7 +214,7 @@
|
|
|
214
214
|
<a href="/" class="topbar-brand">
|
|
215
215
|
<img src="/logo.svg" alt="Pixcode" />
|
|
216
216
|
<span data-i18n="title">Pixcode API</span>
|
|
217
|
-
<span class="badge" data-i18n="badge">v1.
|
|
217
|
+
<span class="badge" data-i18n="badge">v1.36</span>
|
|
218
218
|
</a>
|
|
219
219
|
<div class="topbar-spacer"></div>
|
|
220
220
|
<div class="topbar-actions">
|
|
@@ -275,7 +275,7 @@
|
|
|
275
275
|
</div>
|
|
276
276
|
</div>
|
|
277
277
|
</div>
|
|
278
|
-
<pre class="curl-box"><code data-i18n="guide.curl">curl -H "Authorization: Bearer
|
|
278
|
+
<pre class="curl-box"><code data-i18n="guide.curl">curl -H "Authorization: Bearer px_..." \
|
|
279
279
|
-H "content-type: application/json" \
|
|
280
280
|
-d '{"metadata":{"agents":[{"adapterId":"codex","role":"frontend"},{"adapterId":"codex","role":"backend"},{"adapterId":"codex","role":"review"}]}}' \
|
|
281
281
|
/api/orchestration/workflows/agent_team/preview</code></pre>
|
|
@@ -296,7 +296,7 @@
|
|
|
296
296
|
const I18N = {
|
|
297
297
|
en: {
|
|
298
298
|
title: 'Pixcode API',
|
|
299
|
-
badge: 'v1.
|
|
299
|
+
badge: 'v1.36',
|
|
300
300
|
downloadSpec: 'Download spec',
|
|
301
301
|
backToApp: 'Back to app',
|
|
302
302
|
'apiKey.label': 'API key',
|
|
@@ -309,12 +309,12 @@
|
|
|
309
309
|
'guide.run': 'Start run',
|
|
310
310
|
'guide.stream': 'Stream run',
|
|
311
311
|
'guide.context': 'Execution context',
|
|
312
|
-
'guide.curl': 'curl -H "Authorization: Bearer
|
|
312
|
+
'guide.curl': 'curl -H "Authorization: Bearer px_..." \\\n -H "content-type: application/json" \\\n -d \'{"metadata":{"agents":[{"adapterId":"codex","role":"frontend"},{"adapterId":"codex","role":"backend"},{"adapterId":"codex","role":"review"}]}}\' \\\n /api/orchestration/workflows/agent_team/preview',
|
|
313
313
|
loading: 'Loading API reference…',
|
|
314
314
|
},
|
|
315
315
|
tr: {
|
|
316
316
|
title: 'Pixcode API',
|
|
317
|
-
badge: 'v1.
|
|
317
|
+
badge: 'v1.36',
|
|
318
318
|
downloadSpec: 'Spec\'i indir',
|
|
319
319
|
backToApp: 'Uygulamaya dön',
|
|
320
320
|
'apiKey.label': 'API anahtarı',
|
|
@@ -327,12 +327,12 @@
|
|
|
327
327
|
'guide.run': 'Run başlat',
|
|
328
328
|
'guide.stream': 'Run izle',
|
|
329
329
|
'guide.context': 'Çalışma bağlamı',
|
|
330
|
-
'guide.curl': 'curl -H "Authorization: Bearer
|
|
330
|
+
'guide.curl': 'curl -H "Authorization: Bearer px_..." \\\n -H "content-type: application/json" \\\n -d \'{"metadata":{"agents":[{"adapterId":"codex","role":"frontend"},{"adapterId":"codex","role":"backend"},{"adapterId":"codex","role":"review"}]}}\' \\\n /api/orchestration/workflows/agent_team/preview',
|
|
331
331
|
loading: 'API referansı yükleniyor…',
|
|
332
332
|
},
|
|
333
333
|
de: {
|
|
334
334
|
title: 'Pixcode API',
|
|
335
|
-
badge: 'v1.
|
|
335
|
+
badge: 'v1.36',
|
|
336
336
|
downloadSpec: 'Spezifikation laden',
|
|
337
337
|
backToApp: 'Zurück zur App',
|
|
338
338
|
'apiKey.label': 'API-Schlüssel',
|
|
@@ -345,12 +345,12 @@
|
|
|
345
345
|
'guide.run': 'Run starten',
|
|
346
346
|
'guide.stream': 'Run streamen',
|
|
347
347
|
'guide.context': 'Ausführungskontext',
|
|
348
|
-
'guide.curl': 'curl -H "Authorization: Bearer
|
|
348
|
+
'guide.curl': 'curl -H "Authorization: Bearer px_..." \\\n -H "content-type: application/json" \\\n -d \'{"metadata":{"agents":[{"adapterId":"codex","role":"frontend"},{"adapterId":"codex","role":"backend"},{"adapterId":"codex","role":"review"}]}}\' \\\n /api/orchestration/workflows/agent_team/preview',
|
|
349
349
|
loading: 'API-Referenz wird geladen…',
|
|
350
350
|
},
|
|
351
351
|
it: {
|
|
352
352
|
title: 'Pixcode API',
|
|
353
|
-
badge: 'v1.
|
|
353
|
+
badge: 'v1.36',
|
|
354
354
|
downloadSpec: 'Scarica specifica',
|
|
355
355
|
backToApp: "Torna all'app",
|
|
356
356
|
'apiKey.label': 'Chiave API',
|
|
@@ -363,12 +363,12 @@
|
|
|
363
363
|
'guide.run': 'Avvia run',
|
|
364
364
|
'guide.stream': 'Stream run',
|
|
365
365
|
'guide.context': 'Contesto di esecuzione',
|
|
366
|
-
'guide.curl': 'curl -H "Authorization: Bearer
|
|
366
|
+
'guide.curl': 'curl -H "Authorization: Bearer px_..." \\\n -H "content-type: application/json" \\\n -d \'{"metadata":{"agents":[{"adapterId":"codex","role":"frontend"},{"adapterId":"codex","role":"backend"},{"adapterId":"codex","role":"review"}]}}\' \\\n /api/orchestration/workflows/agent_team/preview',
|
|
367
367
|
loading: 'Caricamento riferimento API…',
|
|
368
368
|
},
|
|
369
369
|
ja: {
|
|
370
370
|
title: 'Pixcode API',
|
|
371
|
-
badge: 'v1.
|
|
371
|
+
badge: 'v1.36',
|
|
372
372
|
downloadSpec: '仕様をダウンロード',
|
|
373
373
|
backToApp: 'アプリに戻る',
|
|
374
374
|
'apiKey.label': 'API キー',
|
|
@@ -381,12 +381,12 @@
|
|
|
381
381
|
'guide.run': 'Run を開始',
|
|
382
382
|
'guide.stream': 'Run をストリーム',
|
|
383
383
|
'guide.context': '実行コンテキスト',
|
|
384
|
-
'guide.curl': 'curl -H "Authorization: Bearer
|
|
384
|
+
'guide.curl': 'curl -H "Authorization: Bearer px_..." \\\n -H "content-type: application/json" \\\n -d \'{"metadata":{"agents":[{"adapterId":"codex","role":"frontend"},{"adapterId":"codex","role":"backend"},{"adapterId":"codex","role":"review"}]}}\' \\\n /api/orchestration/workflows/agent_team/preview',
|
|
385
385
|
loading: 'API リファレンスを読み込み中…',
|
|
386
386
|
},
|
|
387
387
|
ko: {
|
|
388
388
|
title: 'Pixcode API',
|
|
389
|
-
badge: 'v1.
|
|
389
|
+
badge: 'v1.36',
|
|
390
390
|
downloadSpec: '스펙 다운로드',
|
|
391
391
|
backToApp: '앱으로 돌아가기',
|
|
392
392
|
'apiKey.label': 'API 키',
|
|
@@ -399,12 +399,12 @@
|
|
|
399
399
|
'guide.run': 'Run 시작',
|
|
400
400
|
'guide.stream': 'Run 스트림',
|
|
401
401
|
'guide.context': '실행 컨텍스트',
|
|
402
|
-
'guide.curl': 'curl -H "Authorization: Bearer
|
|
402
|
+
'guide.curl': 'curl -H "Authorization: Bearer px_..." \\\n -H "content-type: application/json" \\\n -d \'{"metadata":{"agents":[{"adapterId":"codex","role":"frontend"},{"adapterId":"codex","role":"backend"},{"adapterId":"codex","role":"review"}]}}\' \\\n /api/orchestration/workflows/agent_team/preview',
|
|
403
403
|
loading: 'API 참조 로드 중…',
|
|
404
404
|
},
|
|
405
405
|
ru: {
|
|
406
406
|
title: 'Pixcode API',
|
|
407
|
-
badge: 'v1.
|
|
407
|
+
badge: 'v1.36',
|
|
408
408
|
downloadSpec: 'Скачать спецификацию',
|
|
409
409
|
backToApp: 'Вернуться в приложение',
|
|
410
410
|
'apiKey.label': 'API-ключ',
|
|
@@ -417,12 +417,12 @@
|
|
|
417
417
|
'guide.run': 'Запустить run',
|
|
418
418
|
'guide.stream': 'Стрим run',
|
|
419
419
|
'guide.context': 'Контекст выполнения',
|
|
420
|
-
'guide.curl': 'curl -H "Authorization: Bearer
|
|
420
|
+
'guide.curl': 'curl -H "Authorization: Bearer px_..." \\\n -H "content-type: application/json" \\\n -d \'{"metadata":{"agents":[{"adapterId":"codex","role":"frontend"},{"adapterId":"codex","role":"backend"},{"adapterId":"codex","role":"review"}]}}\' \\\n /api/orchestration/workflows/agent_team/preview',
|
|
421
421
|
loading: 'Загрузка справочника API…',
|
|
422
422
|
},
|
|
423
423
|
'zh-CN': {
|
|
424
424
|
title: 'Pixcode API',
|
|
425
|
-
badge: 'v1.
|
|
425
|
+
badge: 'v1.36',
|
|
426
426
|
downloadSpec: '下载规范',
|
|
427
427
|
backToApp: '返回应用',
|
|
428
428
|
'apiKey.label': 'API 密钥',
|
|
@@ -435,7 +435,7 @@
|
|
|
435
435
|
'guide.run': '启动 run',
|
|
436
436
|
'guide.stream': '流式 run',
|
|
437
437
|
'guide.context': '执行上下文',
|
|
438
|
-
'guide.curl': 'curl -H "Authorization: Bearer
|
|
438
|
+
'guide.curl': 'curl -H "Authorization: Bearer px_..." \\\n -H "content-type: application/json" \\\n -d \'{"metadata":{"agents":[{"adapterId":"codex","role":"frontend"},{"adapterId":"codex","role":"backend"},{"adapterId":"codex","role":"review"}]}}\' \\\n /api/orchestration/workflows/agent_team/preview',
|
|
439
439
|
loading: '正在加载 API 参考…',
|
|
440
440
|
},
|
|
441
441
|
};
|