@pixelbyte-software/pixcode 1.51.2 → 1.51.3
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/CODE_OF_CONDUCT.md +41 -41
- package/CONTRIBUTING.md +155 -155
- package/LICENSE +718 -718
- package/README.de.md +169 -169
- package/README.ja.md +167 -167
- package/README.ko.md +167 -167
- package/README.md +419 -419
- package/README.ru.md +169 -169
- package/README.tr.md +298 -298
- package/README.zh-CN.md +167 -167
- package/SECURITY.md +46 -46
- package/dist/api-automation.html +110 -110
- package/dist/api-docs.html +548 -548
- package/dist/assets/{index-EN9ngyxf.js → index-17CwxHSZ.js} +185 -185
- package/dist/assets/index-B9N-gfOQ.css +32 -0
- package/dist/clear-cache.html +85 -85
- package/dist/convert-icons.md +52 -52
- package/dist/docs.html +308 -308
- package/dist/favicon.svg +8 -8
- package/dist/features.html +133 -133
- package/dist/generate-icons.js +48 -48
- package/dist/humans.txt +15 -15
- package/dist/icons/codex-white.svg +3 -3
- package/dist/icons/codex.svg +3 -3
- package/dist/icons/cursor-white.svg +11 -11
- package/dist/icons/icon-128x128.svg +9 -9
- package/dist/icons/icon-144x144.svg +9 -9
- package/dist/icons/icon-152x152.svg +9 -9
- package/dist/icons/icon-192x192.svg +9 -9
- package/dist/icons/icon-384x384.svg +9 -9
- package/dist/icons/icon-512x512.svg +9 -9
- package/dist/icons/icon-72x72.svg +9 -9
- package/dist/icons/icon-96x96.svg +9 -9
- package/dist/icons/icon-template.svg +9 -9
- package/dist/icons/qwen-logo.svg +14 -14
- package/dist/index.html +59 -59
- package/dist/landing.html +268 -268
- package/dist/llms-full.txt +119 -119
- package/dist/llms.txt +53 -53
- package/dist/logo.svg +12 -12
- package/dist/manifest.json +60 -60
- package/dist/openapi.yaml +1696 -1696
- package/dist/orchestration.html +125 -125
- package/dist/robots.txt +4 -4
- package/dist/site.css +692 -692
- package/dist/sitemap.xml +51 -51
- package/dist/sw.js +132 -132
- package/dist-server/server/cli.js +96 -96
- package/dist-server/server/daemon/manager.js +33 -33
- package/dist-server/server/daemon-manager.js +64 -64
- package/dist-server/server/index.js +122 -3
- package/dist-server/server/index.js.map +1 -1
- package/dist-server/server/modules/orchestration/a2a/adapters/json-event.adapter.js +84 -0
- package/dist-server/server/modules/orchestration/a2a/adapters/json-event.adapter.js.map +1 -0
- package/dist-server/server/modules/orchestration/a2a/adapters/json-event.adapter.test.js +43 -0
- package/dist-server/server/modules/orchestration/a2a/adapters/json-event.adapter.test.js.map +1 -0
- package/dist-server/server/modules/orchestration/hermes/hermes.routes.js +55 -1
- package/dist-server/server/modules/orchestration/hermes/hermes.routes.js.map +1 -1
- package/dist-server/server/modules/orchestration/index.js +1 -0
- package/dist-server/server/modules/orchestration/index.js.map +1 -1
- package/dist-server/server/routes/commands.js +25 -25
- package/dist-server/server/routes/git.js +17 -17
- package/dist-server/server/routes/live-view.js +46 -46
- package/dist-server/server/services/hermes-gateway.js +310 -0
- package/dist-server/server/services/hermes-gateway.js.map +1 -1
- package/dist-server/server/services/public-api-manifest.js +59 -51
- package/dist-server/server/services/public-api-manifest.js.map +1 -1
- package/package.json +222 -222
- package/scripts/fix-node-pty.js +67 -67
- package/scripts/github/create-v1.38-issues.mjs +351 -351
- package/scripts/github/create-vscode-workbench-issues.mjs +121 -121
- package/scripts/hermes/configure-pixcode-mcp.mjs +165 -163
- package/scripts/hermes/pixcode-mcp-server.mjs +1009 -958
- package/scripts/smoke/changes-panel-layout.mjs +48 -48
- package/scripts/smoke/chat-composer-fixed-layout.mjs +55 -55
- package/scripts/smoke/chat-message-timeline-order.mjs +41 -41
- package/scripts/smoke/chat-realtime-hydration.mjs +44 -44
- package/scripts/smoke/chat-session-provider-pools.mjs +35 -35
- package/scripts/smoke/chat-session-state.mjs +19 -19
- package/scripts/smoke/code-editor-theme.mjs +55 -55
- package/scripts/smoke/code-editor-vscode-engine.mjs +91 -91
- package/scripts/smoke/command-center-agent-writes.mjs +79 -79
- package/scripts/smoke/command-center-non-git.mjs +46 -46
- package/scripts/smoke/context-packet.mjs +43 -43
- package/scripts/smoke/control-room-ux-redesign.mjs +91 -91
- package/scripts/smoke/daemon-entrypoint.mjs +20 -20
- package/scripts/smoke/default-landing-routing.mjs +33 -33
- package/scripts/smoke/desktop-native-notifications.mjs +30 -30
- package/scripts/smoke/desktop-tray-icon.mjs +33 -33
- package/scripts/smoke/discord-release-workflow.mjs +24 -24
- package/scripts/smoke/git-install-update.mjs +255 -255
- package/scripts/smoke/handoff-artifact-protocol.mjs +50 -50
- package/scripts/smoke/hermes-api-install.mjs +56 -56
- package/scripts/smoke/hermes-gateway-persistence.mjs +104 -104
- package/scripts/smoke/hermes-mcp-pixcode-roundtrip.mjs +426 -367
- package/scripts/smoke/hermes-rest-chat-api.mjs +162 -162
- package/scripts/smoke/hermes-rest-chat-live.mjs +45 -45
- package/scripts/smoke/hermes-rest-codex-launch.mjs +209 -209
- package/scripts/smoke/hermes-rest-gateway.mjs +79 -70
- package/scripts/smoke/hermes-rest-live.mjs +42 -42
- package/scripts/smoke/hermes-roundtrip.mjs +167 -167
- package/scripts/smoke/hermes-settings-commands.mjs +349 -346
- package/scripts/smoke/hermes-smoke-launcher-guard.mjs +34 -34
- package/scripts/smoke/live-view-diagnostics.mjs +53 -53
- package/scripts/smoke/live-view-environment.mjs +92 -92
- package/scripts/smoke/live-view-integration.mjs +450 -450
- package/scripts/smoke/mac-desktop-runtime.mjs +37 -37
- package/scripts/smoke/mobile-tunnel-guidance.mjs +29 -29
- package/scripts/smoke/model-registry.mjs +36 -36
- package/scripts/smoke/multi-project-ui.mjs +45 -45
- package/scripts/smoke/multi-worker-slots.mjs +42 -42
- package/scripts/smoke/notification-center.mjs +87 -87
- package/scripts/smoke/notification-inapp-preference.mjs +23 -23
- package/scripts/smoke/notification-taxonomy.mjs +58 -58
- package/scripts/smoke/orchestration-api.mjs +172 -172
- package/scripts/smoke/orchestration-execution-dashboard.mjs +33 -33
- package/scripts/smoke/orchestration-live-run.mjs +176 -176
- package/scripts/smoke/orchestration-mobile-scroll.mjs +29 -29
- package/scripts/smoke/orchestration-model-sync.mjs +30 -30
- package/scripts/smoke/orchestration-permission-fallback.mjs +34 -34
- package/scripts/smoke/orchestration-runtime-guards.mjs +48 -48
- package/scripts/smoke/orchestration-user-facing-output.mjs +25 -25
- package/scripts/smoke/permission-policy.mjs +50 -50
- package/scripts/smoke/pixcode-workbench-1-48.mjs +167 -167
- package/scripts/smoke/provider-models-opencode-live.mjs +66 -66
- package/scripts/smoke/provider-rest-api.mjs +124 -124
- package/scripts/smoke/provider-selection-status.mjs +52 -52
- package/scripts/smoke/run-state-refresh.mjs +52 -52
- package/scripts/smoke/runtime-manager.mjs +99 -99
- package/scripts/smoke/shell-manual-disconnect.mjs +30 -30
- package/scripts/smoke/side-panel-editor-layout.mjs +34 -34
- package/scripts/smoke/static-root-routing.mjs +21 -21
- package/scripts/smoke/strict-handoff-compact.mjs +60 -60
- package/scripts/smoke/taskmaster-config.mjs +24 -24
- package/scripts/smoke/taskmaster-execution-telegram.mjs +3 -3
- package/scripts/smoke/taskmaster-onboarding.mjs +3 -3
- package/scripts/smoke/taskmaster-run-graph.mjs +3 -3
- package/scripts/smoke/telegram-control.mjs +242 -242
- package/scripts/smoke/tunnel-persistence.mjs +56 -56
- package/scripts/smoke/update-issue-progress.mjs +69 -69
- package/scripts/smoke/update-ux.mjs +55 -55
- package/scripts/smoke/v138-completion.mjs +132 -132
- package/scripts/smoke/v138-desktop-release-hardening.mjs +69 -69
- package/scripts/smoke/v138-diagnostics.mjs +63 -63
- package/scripts/smoke/v138-issue-planner.mjs +33 -33
- package/scripts/smoke/v143-remote-control.mjs +76 -76
- package/scripts/smoke/v144-production-loop.mjs +47 -47
- package/scripts/smoke/v145-platformization.mjs +46 -46
- package/scripts/smoke/v146-control-room-ui.mjs +150 -150
- package/scripts/smoke/version-modal-autoshow.mjs +29 -29
- package/scripts/smoke/vscode-workbench-layout.mjs +63 -63
- package/scripts/smoke/vscode-workbench-polish.mjs +461 -436
- package/scripts/smoke/workflow-fallback-replay.mjs +56 -56
- package/scripts/smoke/workflow-templates.mjs +43 -43
- package/scripts/smoke/workflow-trace-timeline.mjs +46 -46
- package/scripts/update-git-install.mjs +293 -293
- package/server/claude-sdk.js +920 -920
- package/server/cli.js +1039 -1039
- package/server/constants/config.js +4 -4
- package/server/cursor-cli.js +344 -344
- package/server/daemon/manager.js +563 -563
- package/server/daemon-manager.js +964 -964
- package/server/database/db.js +921 -921
- package/server/database/json-store.js +197 -197
- package/server/gemini-cli.js +550 -550
- package/server/gemini-response-handler.js +79 -79
- package/server/index.js +128 -2
- package/server/load-env.js +35 -35
- package/server/middleware/auth.js +175 -175
- package/server/modules/orchestration/a2a/adapter-registry.ts +108 -108
- package/server/modules/orchestration/a2a/adapters/abstract-a2a.adapter.ts +63 -63
- package/server/modules/orchestration/a2a/adapters/claude-code.adapter.ts +286 -286
- package/server/modules/orchestration/a2a/adapters/codex.adapter.ts +244 -244
- package/server/modules/orchestration/a2a/adapters/cursor.adapter.ts +249 -249
- package/server/modules/orchestration/a2a/adapters/gemini.adapter.ts +248 -248
- package/server/modules/orchestration/a2a/adapters/json-event.adapter.test.ts +60 -0
- package/server/modules/orchestration/a2a/adapters/json-event.adapter.ts +101 -0
- package/server/modules/orchestration/a2a/adapters/opencode.adapter.ts +248 -248
- package/server/modules/orchestration/a2a/adapters/qwen.adapter.ts +248 -248
- package/server/modules/orchestration/a2a/agent-card.ts +55 -55
- package/server/modules/orchestration/a2a/routes.ts +590 -590
- package/server/modules/orchestration/a2a/task-store.ts +178 -178
- package/server/modules/orchestration/a2a/types.ts +126 -126
- package/server/modules/orchestration/a2a/validator.ts +113 -113
- package/server/modules/orchestration/hermes/hermes.routes.ts +642 -583
- package/server/modules/orchestration/index.ts +101 -100
- package/server/modules/orchestration/preview/port-watcher.ts +112 -112
- package/server/modules/orchestration/preview/preview-proxy.ts +60 -60
- package/server/modules/orchestration/preview/types.ts +19 -19
- package/server/modules/orchestration/security/permission-policy.ts +401 -401
- package/server/modules/orchestration/tasks/orchestration-task-store.ts +41 -41
- package/server/modules/orchestration/tasks/orchestration-task.routes.ts +64 -64
- package/server/modules/orchestration/tasks/orchestration-task.service.ts +209 -209
- package/server/modules/orchestration/tasks/orchestration-task.types.ts +40 -40
- package/server/modules/orchestration/tasks/task-run-graph.ts +155 -155
- package/server/modules/orchestration/workflows/approval-queue.ts +106 -106
- package/server/modules/orchestration/workflows/built-in-workflows.ts +127 -127
- package/server/modules/orchestration/workflows/context-packet.ts +186 -186
- package/server/modules/orchestration/workflows/handoff-artifact.ts +175 -175
- package/server/modules/orchestration/workflows/workflow-fallback-policy.ts +161 -161
- package/server/modules/orchestration/workflows/workflow-replay.ts +254 -254
- package/server/modules/orchestration/workflows/workflow-runner.ts +2070 -2070
- package/server/modules/orchestration/workflows/workflow-store.ts +97 -97
- package/server/modules/orchestration/workflows/workflow-templates.ts +272 -272
- package/server/modules/orchestration/workflows/workflow-trace.ts +424 -424
- package/server/modules/orchestration/workflows/workflow.routes.ts +586 -586
- package/server/modules/orchestration/workflows/workflow.types.ts +111 -111
- package/server/modules/orchestration/workflows/workspace-target.ts +122 -122
- package/server/modules/orchestration/workspace/docker-workspace.ts +136 -136
- package/server/modules/orchestration/workspace/path-safety.ts +55 -55
- package/server/modules/orchestration/workspace/types.ts +52 -52
- package/server/modules/orchestration/workspace/workspace-manager.ts +102 -102
- package/server/modules/orchestration/workspace/worktree-workspace.ts +126 -126
- package/server/modules/providers/index.ts +2 -2
- package/server/modules/providers/list/claude/claude-auth.provider.ts +146 -146
- package/server/modules/providers/list/claude/claude-mcp.provider.ts +135 -135
- package/server/modules/providers/list/claude/claude-sessions.provider.ts +306 -306
- package/server/modules/providers/list/claude/claude.provider.ts +15 -15
- package/server/modules/providers/list/codex/codex-auth.provider.ts +117 -117
- package/server/modules/providers/list/codex/codex-mcp.provider.ts +135 -135
- package/server/modules/providers/list/codex/codex-sessions.provider.ts +319 -319
- package/server/modules/providers/list/codex/codex.provider.ts +15 -15
- package/server/modules/providers/list/cursor/cursor-auth.provider.ts +147 -147
- package/server/modules/providers/list/cursor/cursor-mcp.provider.ts +108 -108
- package/server/modules/providers/list/cursor/cursor-sessions.provider.ts +421 -421
- package/server/modules/providers/list/cursor/cursor.provider.ts +15 -15
- package/server/modules/providers/list/gemini/gemini-auth.provider.ts +173 -173
- package/server/modules/providers/list/gemini/gemini-mcp.provider.ts +110 -110
- package/server/modules/providers/list/gemini/gemini-sessions.provider.ts +227 -227
- package/server/modules/providers/list/gemini/gemini.provider.ts +15 -15
- package/server/modules/providers/list/opencode/opencode-auth.provider.ts +131 -131
- package/server/modules/providers/list/opencode/opencode-mcp.provider.ts +126 -126
- package/server/modules/providers/list/opencode/opencode-sessions.provider.ts +286 -286
- package/server/modules/providers/list/opencode/opencode.provider.ts +29 -29
- package/server/modules/providers/list/qwen/qwen-auth.provider.ts +146 -146
- package/server/modules/providers/list/qwen/qwen-mcp.provider.ts +114 -114
- package/server/modules/providers/list/qwen/qwen-sessions.provider.ts +265 -265
- package/server/modules/providers/list/qwen/qwen.provider.ts +21 -21
- package/server/modules/providers/provider.registry.ts +40 -40
- package/server/modules/providers/provider.routes.ts +944 -944
- package/server/modules/providers/services/mcp.service.ts +86 -86
- package/server/modules/providers/services/provider-auth.service.ts +26 -26
- package/server/modules/providers/services/sessions.service.ts +45 -45
- package/server/modules/providers/shared/base/abstract.provider.ts +20 -20
- package/server/modules/providers/shared/mcp/mcp.provider.ts +151 -151
- package/server/modules/providers/shared/provider-configs.ts +142 -142
- package/server/modules/providers/tests/mcp.test.ts +293 -293
- package/server/openai-codex.js +462 -462
- package/server/opencode-cli.js +491 -491
- package/server/opencode-response-handler.js +111 -111
- package/server/projects.js +3008 -3008
- package/server/qwen-code-cli.js +410 -410
- package/server/qwen-response-handler.js +73 -73
- package/server/routes/agent.js +1435 -1435
- package/server/routes/auth.js +159 -159
- package/server/routes/codex.js +20 -20
- package/server/routes/commands.js +570 -570
- package/server/routes/cursor.js +61 -61
- package/server/routes/diagnostics.js +41 -41
- package/server/routes/gemini.js +25 -25
- package/server/routes/git.js +1650 -1650
- package/server/routes/live-view.js +411 -411
- package/server/routes/mcp-utils.js +13 -13
- package/server/routes/messages.js +62 -62
- package/server/routes/network.js +125 -125
- package/server/routes/platformization.js +212 -212
- package/server/routes/plugins.js +320 -320
- package/server/routes/production-agent-loop.js +90 -90
- package/server/routes/projects.js +917 -917
- package/server/routes/public-api.js +34 -34
- package/server/routes/qwen.js +27 -27
- package/server/routes/remote.js +55 -55
- package/server/routes/settings.js +321 -321
- package/server/routes/telegram.js +140 -140
- package/server/routes/user.js +125 -125
- package/server/routes/webhooks.js +63 -63
- package/server/services/control-room.js +102 -102
- package/server/services/diagnostics.js +165 -165
- package/server/services/external-access.js +375 -375
- package/server/services/hermes-gateway.js +1562 -1247
- package/server/services/hermes-install-jobs.js +729 -729
- package/server/services/install-jobs.js +715 -715
- package/server/services/live-view.js +956 -956
- package/server/services/managed-runtimes.js +493 -493
- package/server/services/model-registry.js +144 -144
- package/server/services/notification-orchestrator.js +365 -365
- package/server/services/notification-taxonomy.js +204 -204
- package/server/services/platformization.js +815 -815
- package/server/services/production-agent-loop.js +248 -248
- package/server/services/provider-cli-versions.js +149 -149
- package/server/services/provider-credentials.js +189 -189
- package/server/services/provider-models.js +396 -396
- package/server/services/public-api-manifest.js +190 -182
- package/server/services/remote-connection.js +127 -127
- package/server/services/runtime-manager.js +323 -323
- package/server/services/startup-update.js +234 -234
- package/server/services/telegram/bot.js +331 -331
- package/server/services/telegram/control-center.js +979 -979
- package/server/services/telegram/telegram-http-client.js +151 -151
- package/server/services/telegram/translations.js +340 -340
- package/server/services/vapid-keys.js +36 -36
- package/server/services/webhooks.js +216 -216
- package/server/sessionManager.js +225 -225
- package/server/shared/interfaces.ts +54 -54
- package/server/shared/types.ts +172 -172
- package/server/shared/utils.ts +193 -193
- package/server/tsconfig.json +36 -36
- package/server/utils/colors.js +21 -21
- package/server/utils/commandParser.js +305 -305
- package/server/utils/frontmatter.js +18 -18
- package/server/utils/gitConfig.js +34 -34
- package/server/utils/plugin-loader.js +457 -457
- package/server/utils/plugin-process-manager.js +185 -185
- package/server/utils/port-access.js +209 -209
- package/server/utils/runtime-paths.js +37 -37
- package/server/utils/url-detection.js +71 -71
- package/server/vite-daemon.js +79 -79
- package/shared/modelConstants.js +161 -161
- package/shared/networkHosts.js +22 -22
- package/dist/assets/index-DMz0zv6T.css +0 -32
package/README.zh-CN.md
CHANGED
|
@@ -1,167 +1,167 @@
|
|
|
1
|
-
<div align="center">
|
|
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="https://buymeacoffee.com/alicomert" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Buy%20me%20a%20coffee-support%20Pixcode-ffdd00?style=for-the-badge&logo=buymeacoffee&logoColor=000000" alt="Buy me a coffee" /></a>
|
|
10
|
-
</p>
|
|
11
|
-
<p>
|
|
12
|
-
<a href="README.md">English</a> ·
|
|
13
|
-
<a href="README.tr.md">Türkçe</a> ·
|
|
14
|
-
<a href="README.de.md">Deutsch</a> ·
|
|
15
|
-
<a href="README.ru.md">Русский</a> ·
|
|
16
|
-
<a href="README.ja.md">日本語</a> ·
|
|
17
|
-
<a href="README.ko.md">한국어</a>
|
|
18
|
-
</p>
|
|
19
|
-
</div>
|
|
20
|
-
|
|
21
|
-
## Pixcode 是什么?
|
|
22
|
-
|
|
23
|
-
Pixcode 可以把你的本机、工作站或 Linux 服务器变成浏览器里的 AI development cockpit。你不需要在多个 terminal、CLI logs、file explorer、Git UI、provider settings 之间切换,Pixcode 把 coding-agent workflow 放在一个本地 Web App 里。
|
|
24
|
-
|
|
25
|
-
常见使用方式:
|
|
26
|
-
|
|
27
|
-
- **Local workstation**:在自己的电脑上运行 Pixcode,用更好的 UI 操作已有 CLI。
|
|
28
|
-
- **Always-on server**:在 Linux/VDS 上以 daemon 方式运行,从 laptop、tablet、phone 访问。
|
|
29
|
-
- **Desktop app**:使用 GitHub Releases 中的 Windows `.exe`、macOS `.dmg`、Linux build。
|
|
30
|
-
|
|
31
|
-
Pixcode 不是 hosted cloud IDE。Projects、credentials、CLI sessions、local files、Git state、MCP config 默认都保留在你的机器上。
|
|
32
|
-
|
|
33
|
-
## Screenshots
|
|
34
|
-
|
|
35
|
-
| Workspace | Mobile chat |
|
|
36
|
-
| --- | --- |
|
|
37
|
-
| <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" /> |
|
|
38
|
-
|
|
39
|
-
| CLI selection | Tools and MCP |
|
|
40
|
-
| --- | --- |
|
|
41
|
-
| <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" /> |
|
|
42
|
-
|
|
43
|
-
## 功能亮点
|
|
44
|
-
|
|
45
|
-
### 多个 CLI,一个界面
|
|
46
|
-
|
|
47
|
-
- Claude Code、Cursor CLI、Codex、Gemini CLI、Qwen Code、OpenCode。
|
|
48
|
-
- Settings 中管理 provider auth、API key credentials、OAuth paste、install status、model list、CLI version status。
|
|
49
|
-
- Pixcode 不替代 native CLI,而是在其上增加 session management、WebSocket streaming、notifications、file context、project controls。
|
|
50
|
-
- UI 会显示 CLI 是在 thinking、tool execution、approval waiting 还是 output streaming。
|
|
51
|
-
|
|
52
|
-
### Chat、files、shell、source control
|
|
53
|
-
|
|
54
|
-
- Project-aware chat sessions 和 history。
|
|
55
|
-
- Prompt composer 固定在 chat/project screen 底部。
|
|
56
|
-
- Shell panel 在 desktop 上可作为 split panel 或 full panel 打开。
|
|
57
|
-
- File browser 支持 edit、upload、rename、delete、detailed view。
|
|
58
|
-
- Source Control 支持 Git status、diff、branch、commit、changed files。
|
|
59
|
-
- Split panels 提供 icon controls、close button、mobile-friendly responsive behavior。
|
|
60
|
-
|
|
61
|
-
### Changed files Command Center
|
|
62
|
-
|
|
63
|
-
Pixcode 会跟踪 local working tree 的变化。Quick Settings 中的 Command Center 可以即时显示 changed files,高亮新的改动,并跳转到相关 file/line。这样 AI agent 修改文件时,你可以看到它改了什么,同时保持 chat/orchestration view 不被关闭。
|
|
64
|
-
|
|
65
|
-
### Multi-agent orchestration
|
|
66
|
-
|
|
67
|
-
Orchestration 可以让多个 CLI agents 围绕同一个 goal 协作。
|
|
68
|
-
|
|
69
|
-
- **Agent Team**:按 frontend、backend、review、docs、custom role 拆分任务。
|
|
70
|
-
- **Multi-model Review**:用多个 provider/model 检查同一改动。
|
|
71
|
-
- **Sequential Handoff**:按阶段交接任务。
|
|
72
|
-
- **Decision Debate**:实现前比较不同 approach。
|
|
73
|
-
|
|
74
|
-
Controls:
|
|
75
|
-
|
|
76
|
-
- 按 run enable/disable agents,
|
|
77
|
-
- 同一个 provider 可创建多个 worker,
|
|
78
|
-
- agent 级 role、stage、label、instruction,
|
|
79
|
-
- agent 级 model selection,包含 OpenCode model,
|
|
80
|
-
- failed step 的 fallback CLI agent,
|
|
81
|
-
- workflow DAG preview,
|
|
82
|
-
- event streaming 和 cancel,
|
|
83
|
-
- resizable orchestration panes。
|
|
84
|
-
|
|
85
|
-
### API、Telegram、notifications
|
|
86
|
-
|
|
87
|
-
Pixcode frontend 本身使用 REST/WebSocket API。External automation 也可以用 Pixcode API key 使用同一个 control plane。新的 API keys 以 `px_` 开头,旧的 `ck_` keys 仍然兼容。
|
|
88
|
-
|
|
89
|
-
```bash
|
|
90
|
-
curl http://localhost:3001/api/projects \
|
|
91
|
-
-H "Authorization: Bearer px_your_key_here"
|
|
92
|
-
```
|
|
93
|
-
|
|
94
|
-
- `POST /api/agent` for one-shot agent runs.
|
|
95
|
-
- `/api/orchestration/workflows/*` for preview, start, stream, cancel.
|
|
96
|
-
- Browser push notifications.
|
|
97
|
-
- Telegram pairing、task notifications、optional prompt bridge。
|
|
98
|
-
|
|
99
|
-
OpenAPI: [`public/openapi.yaml`](public/openapi.yaml)
|
|
100
|
-
|
|
101
|
-
### Themes、plugins、MCP
|
|
102
|
-
|
|
103
|
-
- Dark/light mode。
|
|
104
|
-
- Emerald、VS Code-like accent palettes。
|
|
105
|
-
- Custom light/dark accent colors。
|
|
106
|
-
- Token-based styling for buttons、focus rings、navigation、active states。
|
|
107
|
-
- MCP server management。
|
|
108
|
-
- Plugin system with frontend tabs and optional backend services。
|
|
109
|
-
|
|
110
|
-
## Installation
|
|
111
|
-
|
|
112
|
-
需要 Node.js 22+。
|
|
113
|
-
|
|
114
|
-
```bash
|
|
115
|
-
npx @pixelbyte-software/pixcode
|
|
116
|
-
```
|
|
117
|
-
|
|
118
|
-
Global install:
|
|
119
|
-
|
|
120
|
-
```bash
|
|
121
|
-
npm install -g @pixelbyte-software/pixcode
|
|
122
|
-
pixcode
|
|
123
|
-
```
|
|
124
|
-
|
|
125
|
-
Open:
|
|
126
|
-
|
|
127
|
-
```text
|
|
128
|
-
http://localhost:3001
|
|
129
|
-
```
|
|
130
|
-
|
|
131
|
-
Desktop installers are available in GitHub Releases: Windows `.exe`, macOS `.dmg`, Linux AppImage/packages.
|
|
132
|
-
|
|
133
|
-
## Linux daemon
|
|
134
|
-
|
|
135
|
-
```bash
|
|
136
|
-
pixcode daemon install --mode auto --port 3001
|
|
137
|
-
pixcode daemon status --mode auto
|
|
138
|
-
pixcode daemon logs --mode auto
|
|
139
|
-
pixcode daemon restart --mode auto
|
|
140
|
-
```
|
|
141
|
-
|
|
142
|
-
Foreground:
|
|
143
|
-
|
|
144
|
-
```bash
|
|
145
|
-
pixcode --no-daemon
|
|
146
|
-
```
|
|
147
|
-
|
|
148
|
-
## Development
|
|
149
|
-
|
|
150
|
-
```bash
|
|
151
|
-
npm install
|
|
152
|
-
npm run typecheck
|
|
153
|
-
npm run lint
|
|
154
|
-
npm run build
|
|
155
|
-
```
|
|
156
|
-
|
|
157
|
-
Notes:
|
|
158
|
-
|
|
159
|
-
- `npm run dev` uses the daemon manager on Linux.
|
|
160
|
-
- Use `npm run client` only for Vite frontend development.
|
|
161
|
-
- Normal runtime uses port `3001`; `5173` is for separate Vite dev.
|
|
162
|
-
|
|
163
|
-
## Links
|
|
164
|
-
|
|
165
|
-
- npm: <https://www.npmjs.com/package/@pixelbyte-software/pixcode>
|
|
166
|
-
- GitHub: <https://github.com/alicomert/pixcode>
|
|
167
|
-
- Releases: <https://github.com/alicomert/pixcode/releases/latest>
|
|
1
|
+
<div align="center">
|
|
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="https://buymeacoffee.com/alicomert" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Buy%20me%20a%20coffee-support%20Pixcode-ffdd00?style=for-the-badge&logo=buymeacoffee&logoColor=000000" alt="Buy me a coffee" /></a>
|
|
10
|
+
</p>
|
|
11
|
+
<p>
|
|
12
|
+
<a href="README.md">English</a> ·
|
|
13
|
+
<a href="README.tr.md">Türkçe</a> ·
|
|
14
|
+
<a href="README.de.md">Deutsch</a> ·
|
|
15
|
+
<a href="README.ru.md">Русский</a> ·
|
|
16
|
+
<a href="README.ja.md">日本語</a> ·
|
|
17
|
+
<a href="README.ko.md">한국어</a>
|
|
18
|
+
</p>
|
|
19
|
+
</div>
|
|
20
|
+
|
|
21
|
+
## Pixcode 是什么?
|
|
22
|
+
|
|
23
|
+
Pixcode 可以把你的本机、工作站或 Linux 服务器变成浏览器里的 AI development cockpit。你不需要在多个 terminal、CLI logs、file explorer、Git UI、provider settings 之间切换,Pixcode 把 coding-agent workflow 放在一个本地 Web App 里。
|
|
24
|
+
|
|
25
|
+
常见使用方式:
|
|
26
|
+
|
|
27
|
+
- **Local workstation**:在自己的电脑上运行 Pixcode,用更好的 UI 操作已有 CLI。
|
|
28
|
+
- **Always-on server**:在 Linux/VDS 上以 daemon 方式运行,从 laptop、tablet、phone 访问。
|
|
29
|
+
- **Desktop app**:使用 GitHub Releases 中的 Windows `.exe`、macOS `.dmg`、Linux build。
|
|
30
|
+
|
|
31
|
+
Pixcode 不是 hosted cloud IDE。Projects、credentials、CLI sessions、local files、Git state、MCP config 默认都保留在你的机器上。
|
|
32
|
+
|
|
33
|
+
## Screenshots
|
|
34
|
+
|
|
35
|
+
| Workspace | Mobile chat |
|
|
36
|
+
| --- | --- |
|
|
37
|
+
| <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" /> |
|
|
38
|
+
|
|
39
|
+
| CLI selection | Tools and MCP |
|
|
40
|
+
| --- | --- |
|
|
41
|
+
| <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" /> |
|
|
42
|
+
|
|
43
|
+
## 功能亮点
|
|
44
|
+
|
|
45
|
+
### 多个 CLI,一个界面
|
|
46
|
+
|
|
47
|
+
- Claude Code、Cursor CLI、Codex、Gemini CLI、Qwen Code、OpenCode。
|
|
48
|
+
- Settings 中管理 provider auth、API key credentials、OAuth paste、install status、model list、CLI version status。
|
|
49
|
+
- Pixcode 不替代 native CLI,而是在其上增加 session management、WebSocket streaming、notifications、file context、project controls。
|
|
50
|
+
- UI 会显示 CLI 是在 thinking、tool execution、approval waiting 还是 output streaming。
|
|
51
|
+
|
|
52
|
+
### Chat、files、shell、source control
|
|
53
|
+
|
|
54
|
+
- Project-aware chat sessions 和 history。
|
|
55
|
+
- Prompt composer 固定在 chat/project screen 底部。
|
|
56
|
+
- Shell panel 在 desktop 上可作为 split panel 或 full panel 打开。
|
|
57
|
+
- File browser 支持 edit、upload、rename、delete、detailed view。
|
|
58
|
+
- Source Control 支持 Git status、diff、branch、commit、changed files。
|
|
59
|
+
- Split panels 提供 icon controls、close button、mobile-friendly responsive behavior。
|
|
60
|
+
|
|
61
|
+
### Changed files Command Center
|
|
62
|
+
|
|
63
|
+
Pixcode 会跟踪 local working tree 的变化。Quick Settings 中的 Command Center 可以即时显示 changed files,高亮新的改动,并跳转到相关 file/line。这样 AI agent 修改文件时,你可以看到它改了什么,同时保持 chat/orchestration view 不被关闭。
|
|
64
|
+
|
|
65
|
+
### Multi-agent orchestration
|
|
66
|
+
|
|
67
|
+
Orchestration 可以让多个 CLI agents 围绕同一个 goal 协作。
|
|
68
|
+
|
|
69
|
+
- **Agent Team**:按 frontend、backend、review、docs、custom role 拆分任务。
|
|
70
|
+
- **Multi-model Review**:用多个 provider/model 检查同一改动。
|
|
71
|
+
- **Sequential Handoff**:按阶段交接任务。
|
|
72
|
+
- **Decision Debate**:实现前比较不同 approach。
|
|
73
|
+
|
|
74
|
+
Controls:
|
|
75
|
+
|
|
76
|
+
- 按 run enable/disable agents,
|
|
77
|
+
- 同一个 provider 可创建多个 worker,
|
|
78
|
+
- agent 级 role、stage、label、instruction,
|
|
79
|
+
- agent 级 model selection,包含 OpenCode model,
|
|
80
|
+
- failed step 的 fallback CLI agent,
|
|
81
|
+
- workflow DAG preview,
|
|
82
|
+
- event streaming 和 cancel,
|
|
83
|
+
- resizable orchestration panes。
|
|
84
|
+
|
|
85
|
+
### API、Telegram、notifications
|
|
86
|
+
|
|
87
|
+
Pixcode frontend 本身使用 REST/WebSocket API。External automation 也可以用 Pixcode API key 使用同一个 control plane。新的 API keys 以 `px_` 开头,旧的 `ck_` keys 仍然兼容。
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
curl http://localhost:3001/api/projects \
|
|
91
|
+
-H "Authorization: Bearer px_your_key_here"
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
- `POST /api/agent` for one-shot agent runs.
|
|
95
|
+
- `/api/orchestration/workflows/*` for preview, start, stream, cancel.
|
|
96
|
+
- Browser push notifications.
|
|
97
|
+
- Telegram pairing、task notifications、optional prompt bridge。
|
|
98
|
+
|
|
99
|
+
OpenAPI: [`public/openapi.yaml`](public/openapi.yaml)
|
|
100
|
+
|
|
101
|
+
### Themes、plugins、MCP
|
|
102
|
+
|
|
103
|
+
- Dark/light mode。
|
|
104
|
+
- Emerald、VS Code-like accent palettes。
|
|
105
|
+
- Custom light/dark accent colors。
|
|
106
|
+
- Token-based styling for buttons、focus rings、navigation、active states。
|
|
107
|
+
- MCP server management。
|
|
108
|
+
- Plugin system with frontend tabs and optional backend services。
|
|
109
|
+
|
|
110
|
+
## Installation
|
|
111
|
+
|
|
112
|
+
需要 Node.js 22+。
|
|
113
|
+
|
|
114
|
+
```bash
|
|
115
|
+
npx @pixelbyte-software/pixcode
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
Global install:
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
npm install -g @pixelbyte-software/pixcode
|
|
122
|
+
pixcode
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
Open:
|
|
126
|
+
|
|
127
|
+
```text
|
|
128
|
+
http://localhost:3001
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
Desktop installers are available in GitHub Releases: Windows `.exe`, macOS `.dmg`, Linux AppImage/packages.
|
|
132
|
+
|
|
133
|
+
## Linux daemon
|
|
134
|
+
|
|
135
|
+
```bash
|
|
136
|
+
pixcode daemon install --mode auto --port 3001
|
|
137
|
+
pixcode daemon status --mode auto
|
|
138
|
+
pixcode daemon logs --mode auto
|
|
139
|
+
pixcode daemon restart --mode auto
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
Foreground:
|
|
143
|
+
|
|
144
|
+
```bash
|
|
145
|
+
pixcode --no-daemon
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
## Development
|
|
149
|
+
|
|
150
|
+
```bash
|
|
151
|
+
npm install
|
|
152
|
+
npm run typecheck
|
|
153
|
+
npm run lint
|
|
154
|
+
npm run build
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
Notes:
|
|
158
|
+
|
|
159
|
+
- `npm run dev` uses the daemon manager on Linux.
|
|
160
|
+
- Use `npm run client` only for Vite frontend development.
|
|
161
|
+
- Normal runtime uses port `3001`; `5173` is for separate Vite dev.
|
|
162
|
+
|
|
163
|
+
## Links
|
|
164
|
+
|
|
165
|
+
- npm: <https://www.npmjs.com/package/@pixelbyte-software/pixcode>
|
|
166
|
+
- GitHub: <https://github.com/alicomert/pixcode>
|
|
167
|
+
- Releases: <https://github.com/alicomert/pixcode/releases/latest>
|
package/SECURITY.md
CHANGED
|
@@ -1,46 +1,46 @@
|
|
|
1
|
-
# Security Policy
|
|
2
|
-
|
|
3
|
-
Pixcode is a self-hosted control plane for local projects, provider CLIs, API
|
|
4
|
-
keys, Telegram pairing, shell access, files, Git state, and agent sessions. Treat
|
|
5
|
-
it like sensitive developer infrastructure.
|
|
6
|
-
|
|
7
|
-
## Supported Versions
|
|
8
|
-
|
|
9
|
-
Security fixes are targeted at the latest published release and the current
|
|
10
|
-
`main` branch.
|
|
11
|
-
|
|
12
|
-
| Version | Supported |
|
|
13
|
-
| --- | --- |
|
|
14
|
-
| Latest release | Yes |
|
|
15
|
-
| Older releases | Best effort |
|
|
16
|
-
|
|
17
|
-
## Reporting a Vulnerability
|
|
18
|
-
|
|
19
|
-
Please do not open a public issue for private vulnerabilities, leaked tokens, or
|
|
20
|
-
exploit details.
|
|
21
|
-
|
|
22
|
-
Use GitHub Security Advisories for this repository when available. If advisory
|
|
23
|
-
reporting is not available, contact the repository owner privately through
|
|
24
|
-
GitHub and include:
|
|
25
|
-
|
|
26
|
-
- affected Pixcode version or commit,
|
|
27
|
-
- operating system and deployment mode,
|
|
28
|
-
- reproduction steps,
|
|
29
|
-
- expected impact,
|
|
30
|
-
- relevant logs with secrets removed.
|
|
31
|
-
|
|
32
|
-
## Deployment Guidance
|
|
33
|
-
|
|
34
|
-
- Do not expose Pixcode directly to the public internet without a trusted reverse
|
|
35
|
-
proxy, VPN, firewall, or equivalent access control.
|
|
36
|
-
- Use strong local account credentials.
|
|
37
|
-
- Rotate `px_` API keys and provider tokens if they are exposed.
|
|
38
|
-
- Do not paste production provider tokens into public issues or screenshots.
|
|
39
|
-
- Keep desktop installers and npm packages updated from official Pixcode
|
|
40
|
-
releases.
|
|
41
|
-
|
|
42
|
-
## Scope
|
|
43
|
-
|
|
44
|
-
Reports are most useful when they involve Pixcode application code, API
|
|
45
|
-
authorization, session isolation, secret handling, desktop packaging, update
|
|
46
|
-
behavior, or unsafe shell/file access.
|
|
1
|
+
# Security Policy
|
|
2
|
+
|
|
3
|
+
Pixcode is a self-hosted control plane for local projects, provider CLIs, API
|
|
4
|
+
keys, Telegram pairing, shell access, files, Git state, and agent sessions. Treat
|
|
5
|
+
it like sensitive developer infrastructure.
|
|
6
|
+
|
|
7
|
+
## Supported Versions
|
|
8
|
+
|
|
9
|
+
Security fixes are targeted at the latest published release and the current
|
|
10
|
+
`main` branch.
|
|
11
|
+
|
|
12
|
+
| Version | Supported |
|
|
13
|
+
| --- | --- |
|
|
14
|
+
| Latest release | Yes |
|
|
15
|
+
| Older releases | Best effort |
|
|
16
|
+
|
|
17
|
+
## Reporting a Vulnerability
|
|
18
|
+
|
|
19
|
+
Please do not open a public issue for private vulnerabilities, leaked tokens, or
|
|
20
|
+
exploit details.
|
|
21
|
+
|
|
22
|
+
Use GitHub Security Advisories for this repository when available. If advisory
|
|
23
|
+
reporting is not available, contact the repository owner privately through
|
|
24
|
+
GitHub and include:
|
|
25
|
+
|
|
26
|
+
- affected Pixcode version or commit,
|
|
27
|
+
- operating system and deployment mode,
|
|
28
|
+
- reproduction steps,
|
|
29
|
+
- expected impact,
|
|
30
|
+
- relevant logs with secrets removed.
|
|
31
|
+
|
|
32
|
+
## Deployment Guidance
|
|
33
|
+
|
|
34
|
+
- Do not expose Pixcode directly to the public internet without a trusted reverse
|
|
35
|
+
proxy, VPN, firewall, or equivalent access control.
|
|
36
|
+
- Use strong local account credentials.
|
|
37
|
+
- Rotate `px_` API keys and provider tokens if they are exposed.
|
|
38
|
+
- Do not paste production provider tokens into public issues or screenshots.
|
|
39
|
+
- Keep desktop installers and npm packages updated from official Pixcode
|
|
40
|
+
releases.
|
|
41
|
+
|
|
42
|
+
## Scope
|
|
43
|
+
|
|
44
|
+
Reports are most useful when they involve Pixcode application code, API
|
|
45
|
+
authorization, session isolation, secret handling, desktop packaging, update
|
|
46
|
+
behavior, or unsafe shell/file access.
|
package/dist/api-automation.html
CHANGED
|
@@ -1,110 +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, Hermes 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>
|
|
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, Hermes 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>
|