@pixelbyte-software/pixcode 1.51.8 → 1.52.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.
Files changed (307) hide show
  1. package/CODE_OF_CONDUCT.md +41 -41
  2. package/CONTRIBUTING.md +155 -155
  3. package/LICENSE +718 -718
  4. package/README.de.md +169 -169
  5. package/README.ja.md +167 -167
  6. package/README.ko.md +167 -167
  7. package/README.md +419 -419
  8. package/README.ru.md +169 -169
  9. package/README.tr.md +298 -298
  10. package/README.zh-CN.md +167 -167
  11. package/SECURITY.md +46 -46
  12. package/dist/api-automation.html +110 -110
  13. package/dist/api-docs.html +548 -548
  14. package/dist/assets/{index--kNEhygZ.js → index-HFIf2iQq.js} +153 -153
  15. package/dist/clear-cache.html +85 -85
  16. package/dist/convert-icons.md +52 -52
  17. package/dist/docs.html +308 -308
  18. package/dist/favicon.svg +8 -8
  19. package/dist/features.html +133 -133
  20. package/dist/generate-icons.js +48 -48
  21. package/dist/humans.txt +15 -15
  22. package/dist/icons/codex-white.svg +3 -3
  23. package/dist/icons/codex.svg +3 -3
  24. package/dist/icons/cursor-white.svg +11 -11
  25. package/dist/icons/icon-128x128.svg +9 -9
  26. package/dist/icons/icon-144x144.svg +9 -9
  27. package/dist/icons/icon-152x152.svg +9 -9
  28. package/dist/icons/icon-192x192.svg +9 -9
  29. package/dist/icons/icon-384x384.svg +9 -9
  30. package/dist/icons/icon-512x512.svg +9 -9
  31. package/dist/icons/icon-72x72.svg +9 -9
  32. package/dist/icons/icon-96x96.svg +9 -9
  33. package/dist/icons/icon-template.svg +9 -9
  34. package/dist/icons/qwen-logo.svg +14 -14
  35. package/dist/index.html +58 -58
  36. package/dist/landing.html +268 -268
  37. package/dist/llms-full.txt +119 -119
  38. package/dist/llms.txt +53 -53
  39. package/dist/logo.svg +12 -12
  40. package/dist/manifest.json +60 -60
  41. package/dist/openapi.yaml +1696 -1696
  42. package/dist/orchestration.html +125 -125
  43. package/dist/robots.txt +4 -4
  44. package/dist/site.css +692 -692
  45. package/dist/sitemap.xml +51 -51
  46. package/dist/sw.js +132 -132
  47. package/dist-server/server/cli.js +96 -96
  48. package/dist-server/server/daemon/manager.js +33 -33
  49. package/dist-server/server/daemon-manager.js +64 -64
  50. package/dist-server/server/index.js +91 -65
  51. package/dist-server/server/index.js.map +1 -1
  52. package/dist-server/server/routes/commands.js +25 -25
  53. package/dist-server/server/routes/git.js +17 -17
  54. package/dist-server/server/routes/live-view.js +46 -46
  55. package/dist-server/server/services/hermes-gateway.js +5 -5
  56. package/dist-server/server/services/public-api-manifest.js +51 -51
  57. package/package.json +222 -222
  58. package/scripts/fix-node-pty.js +67 -67
  59. package/scripts/github/create-v1.38-issues.mjs +351 -351
  60. package/scripts/github/create-vscode-workbench-issues.mjs +121 -121
  61. package/scripts/hermes/configure-pixcode-mcp.mjs +165 -165
  62. package/scripts/hermes/pixcode-mcp-server.mjs +1009 -1009
  63. package/scripts/smoke/changes-panel-layout.mjs +48 -48
  64. package/scripts/smoke/chat-composer-fixed-layout.mjs +55 -55
  65. package/scripts/smoke/chat-message-timeline-order.mjs +41 -41
  66. package/scripts/smoke/chat-realtime-hydration.mjs +44 -44
  67. package/scripts/smoke/chat-session-provider-pools.mjs +35 -35
  68. package/scripts/smoke/chat-session-state.mjs +19 -19
  69. package/scripts/smoke/code-editor-theme.mjs +55 -55
  70. package/scripts/smoke/code-editor-vscode-engine.mjs +91 -91
  71. package/scripts/smoke/command-center-agent-writes.mjs +79 -79
  72. package/scripts/smoke/command-center-non-git.mjs +46 -46
  73. package/scripts/smoke/context-packet.mjs +43 -43
  74. package/scripts/smoke/control-room-ux-redesign.mjs +91 -91
  75. package/scripts/smoke/daemon-entrypoint.mjs +20 -20
  76. package/scripts/smoke/default-landing-routing.mjs +33 -33
  77. package/scripts/smoke/desktop-native-notifications.mjs +30 -30
  78. package/scripts/smoke/desktop-tray-icon.mjs +33 -33
  79. package/scripts/smoke/discord-release-workflow.mjs +24 -24
  80. package/scripts/smoke/git-install-update.mjs +255 -255
  81. package/scripts/smoke/handoff-artifact-protocol.mjs +50 -50
  82. package/scripts/smoke/hermes-api-install.mjs +56 -56
  83. package/scripts/smoke/hermes-gateway-persistence.mjs +104 -104
  84. package/scripts/smoke/hermes-mcp-pixcode-roundtrip.mjs +426 -426
  85. package/scripts/smoke/hermes-rest-chat-api.mjs +162 -162
  86. package/scripts/smoke/hermes-rest-chat-live.mjs +45 -45
  87. package/scripts/smoke/hermes-rest-codex-launch.mjs +209 -209
  88. package/scripts/smoke/hermes-rest-gateway.mjs +79 -79
  89. package/scripts/smoke/hermes-rest-live.mjs +42 -42
  90. package/scripts/smoke/hermes-roundtrip.mjs +167 -167
  91. package/scripts/smoke/hermes-settings-commands.mjs +349 -349
  92. package/scripts/smoke/hermes-smoke-launcher-guard.mjs +34 -34
  93. package/scripts/smoke/live-view-diagnostics.mjs +53 -53
  94. package/scripts/smoke/live-view-environment.mjs +92 -92
  95. package/scripts/smoke/live-view-integration.mjs +450 -450
  96. package/scripts/smoke/mac-desktop-runtime.mjs +37 -37
  97. package/scripts/smoke/mobile-tunnel-guidance.mjs +29 -29
  98. package/scripts/smoke/model-registry.mjs +36 -36
  99. package/scripts/smoke/multi-project-ui.mjs +45 -45
  100. package/scripts/smoke/multi-worker-slots.mjs +42 -42
  101. package/scripts/smoke/notification-center.mjs +87 -87
  102. package/scripts/smoke/notification-inapp-preference.mjs +23 -23
  103. package/scripts/smoke/notification-taxonomy.mjs +58 -58
  104. package/scripts/smoke/orchestration-api.mjs +172 -172
  105. package/scripts/smoke/orchestration-execution-dashboard.mjs +33 -33
  106. package/scripts/smoke/orchestration-live-run.mjs +176 -176
  107. package/scripts/smoke/orchestration-mobile-scroll.mjs +29 -29
  108. package/scripts/smoke/orchestration-model-sync.mjs +30 -30
  109. package/scripts/smoke/orchestration-permission-fallback.mjs +34 -34
  110. package/scripts/smoke/orchestration-runtime-guards.mjs +48 -48
  111. package/scripts/smoke/orchestration-user-facing-output.mjs +25 -25
  112. package/scripts/smoke/permission-policy.mjs +50 -50
  113. package/scripts/smoke/pixcode-workbench-1-48.mjs +167 -167
  114. package/scripts/smoke/provider-models-opencode-live.mjs +66 -66
  115. package/scripts/smoke/provider-rest-api.mjs +124 -124
  116. package/scripts/smoke/provider-selection-status.mjs +52 -52
  117. package/scripts/smoke/run-state-refresh.mjs +52 -52
  118. package/scripts/smoke/runtime-manager.mjs +99 -99
  119. package/scripts/smoke/shell-manual-disconnect.mjs +30 -30
  120. package/scripts/smoke/side-panel-editor-layout.mjs +34 -34
  121. package/scripts/smoke/static-root-routing.mjs +21 -21
  122. package/scripts/smoke/strict-handoff-compact.mjs +60 -60
  123. package/scripts/smoke/taskmaster-config.mjs +24 -24
  124. package/scripts/smoke/taskmaster-execution-telegram.mjs +3 -3
  125. package/scripts/smoke/taskmaster-onboarding.mjs +3 -3
  126. package/scripts/smoke/taskmaster-run-graph.mjs +3 -3
  127. package/scripts/smoke/telegram-control.mjs +242 -242
  128. package/scripts/smoke/tunnel-persistence.mjs +56 -56
  129. package/scripts/smoke/update-issue-progress.mjs +69 -69
  130. package/scripts/smoke/update-ux.mjs +55 -55
  131. package/scripts/smoke/v138-completion.mjs +132 -132
  132. package/scripts/smoke/v138-desktop-release-hardening.mjs +69 -69
  133. package/scripts/smoke/v138-diagnostics.mjs +63 -63
  134. package/scripts/smoke/v138-issue-planner.mjs +33 -33
  135. package/scripts/smoke/v143-remote-control.mjs +76 -76
  136. package/scripts/smoke/v144-production-loop.mjs +47 -47
  137. package/scripts/smoke/v145-platformization.mjs +46 -46
  138. package/scripts/smoke/v146-control-room-ui.mjs +150 -150
  139. package/scripts/smoke/version-modal-autoshow.mjs +29 -29
  140. package/scripts/smoke/vscode-workbench-layout.mjs +63 -63
  141. package/scripts/smoke/vscode-workbench-polish.mjs +461 -461
  142. package/scripts/smoke/workflow-fallback-replay.mjs +56 -56
  143. package/scripts/smoke/workflow-templates.mjs +43 -43
  144. package/scripts/smoke/workflow-trace-timeline.mjs +46 -46
  145. package/scripts/update-git-install.mjs +283 -283
  146. package/server/claude-sdk.js +920 -920
  147. package/server/cli.js +1035 -1035
  148. package/server/constants/config.js +4 -4
  149. package/server/cursor-cli.js +344 -344
  150. package/server/daemon/manager.js +563 -563
  151. package/server/daemon-manager.js +964 -964
  152. package/server/database/db.js +895 -895
  153. package/server/database/json-store.js +197 -197
  154. package/server/gemini-cli.js +550 -550
  155. package/server/gemini-response-handler.js +79 -79
  156. package/server/index.js +111 -81
  157. package/server/load-env.js +35 -35
  158. package/server/middleware/auth.js +155 -155
  159. package/server/modules/orchestration/a2a/adapter-registry.ts +108 -108
  160. package/server/modules/orchestration/a2a/adapters/abstract-a2a.adapter.ts +63 -63
  161. package/server/modules/orchestration/a2a/adapters/claude-code.adapter.ts +286 -286
  162. package/server/modules/orchestration/a2a/adapters/codex.adapter.ts +244 -244
  163. package/server/modules/orchestration/a2a/adapters/cursor.adapter.ts +249 -249
  164. package/server/modules/orchestration/a2a/adapters/gemini.adapter.ts +248 -248
  165. package/server/modules/orchestration/a2a/adapters/json-event.adapter.ts +100 -100
  166. package/server/modules/orchestration/a2a/adapters/opencode.adapter.ts +248 -248
  167. package/server/modules/orchestration/a2a/adapters/qwen.adapter.ts +248 -248
  168. package/server/modules/orchestration/a2a/agent-card.ts +55 -55
  169. package/server/modules/orchestration/a2a/routes.ts +590 -590
  170. package/server/modules/orchestration/a2a/task-store.ts +178 -178
  171. package/server/modules/orchestration/a2a/types.ts +126 -126
  172. package/server/modules/orchestration/a2a/validator.ts +113 -113
  173. package/server/modules/orchestration/hermes/hermes.routes.ts +642 -642
  174. package/server/modules/orchestration/index.ts +101 -101
  175. package/server/modules/orchestration/preview/port-watcher.ts +112 -112
  176. package/server/modules/orchestration/preview/preview-proxy.ts +60 -60
  177. package/server/modules/orchestration/preview/types.ts +19 -19
  178. package/server/modules/orchestration/security/permission-policy.ts +401 -401
  179. package/server/modules/orchestration/tasks/orchestration-task-store.ts +41 -41
  180. package/server/modules/orchestration/tasks/orchestration-task.routes.ts +64 -64
  181. package/server/modules/orchestration/tasks/orchestration-task.service.ts +209 -209
  182. package/server/modules/orchestration/tasks/orchestration-task.types.ts +40 -40
  183. package/server/modules/orchestration/tasks/task-run-graph.ts +155 -155
  184. package/server/modules/orchestration/workflows/approval-queue.ts +106 -106
  185. package/server/modules/orchestration/workflows/built-in-workflows.ts +127 -127
  186. package/server/modules/orchestration/workflows/context-packet.ts +186 -186
  187. package/server/modules/orchestration/workflows/handoff-artifact.ts +175 -175
  188. package/server/modules/orchestration/workflows/workflow-fallback-policy.ts +161 -161
  189. package/server/modules/orchestration/workflows/workflow-replay.ts +254 -254
  190. package/server/modules/orchestration/workflows/workflow-runner.ts +2070 -2070
  191. package/server/modules/orchestration/workflows/workflow-store.ts +97 -97
  192. package/server/modules/orchestration/workflows/workflow-templates.ts +272 -272
  193. package/server/modules/orchestration/workflows/workflow-trace.ts +424 -424
  194. package/server/modules/orchestration/workflows/workflow.routes.ts +586 -586
  195. package/server/modules/orchestration/workflows/workflow.types.ts +111 -111
  196. package/server/modules/orchestration/workflows/workspace-target.ts +122 -122
  197. package/server/modules/orchestration/workspace/docker-workspace.ts +136 -136
  198. package/server/modules/orchestration/workspace/path-safety.ts +55 -55
  199. package/server/modules/orchestration/workspace/types.ts +52 -52
  200. package/server/modules/orchestration/workspace/workspace-manager.ts +102 -102
  201. package/server/modules/orchestration/workspace/worktree-workspace.ts +126 -126
  202. package/server/modules/providers/index.ts +2 -2
  203. package/server/modules/providers/list/claude/claude-auth.provider.ts +146 -146
  204. package/server/modules/providers/list/claude/claude-mcp.provider.ts +135 -135
  205. package/server/modules/providers/list/claude/claude-sessions.provider.ts +306 -306
  206. package/server/modules/providers/list/claude/claude.provider.ts +15 -15
  207. package/server/modules/providers/list/codex/codex-auth.provider.ts +117 -117
  208. package/server/modules/providers/list/codex/codex-mcp.provider.ts +135 -135
  209. package/server/modules/providers/list/codex/codex-sessions.provider.ts +319 -319
  210. package/server/modules/providers/list/codex/codex.provider.ts +15 -15
  211. package/server/modules/providers/list/cursor/cursor-auth.provider.ts +147 -147
  212. package/server/modules/providers/list/cursor/cursor-mcp.provider.ts +108 -108
  213. package/server/modules/providers/list/cursor/cursor-sessions.provider.ts +421 -421
  214. package/server/modules/providers/list/cursor/cursor.provider.ts +15 -15
  215. package/server/modules/providers/list/gemini/gemini-auth.provider.ts +173 -173
  216. package/server/modules/providers/list/gemini/gemini-mcp.provider.ts +110 -110
  217. package/server/modules/providers/list/gemini/gemini-sessions.provider.ts +227 -227
  218. package/server/modules/providers/list/gemini/gemini.provider.ts +15 -15
  219. package/server/modules/providers/list/opencode/opencode-auth.provider.ts +131 -131
  220. package/server/modules/providers/list/opencode/opencode-mcp.provider.ts +126 -126
  221. package/server/modules/providers/list/opencode/opencode-sessions.provider.ts +286 -286
  222. package/server/modules/providers/list/opencode/opencode.provider.ts +29 -29
  223. package/server/modules/providers/list/qwen/qwen-auth.provider.ts +146 -146
  224. package/server/modules/providers/list/qwen/qwen-mcp.provider.ts +114 -114
  225. package/server/modules/providers/list/qwen/qwen-sessions.provider.ts +265 -265
  226. package/server/modules/providers/list/qwen/qwen.provider.ts +21 -21
  227. package/server/modules/providers/provider.registry.ts +40 -40
  228. package/server/modules/providers/provider.routes.ts +891 -891
  229. package/server/modules/providers/services/mcp.service.ts +86 -86
  230. package/server/modules/providers/services/provider-auth.service.ts +26 -26
  231. package/server/modules/providers/services/sessions.service.ts +45 -45
  232. package/server/modules/providers/shared/base/abstract.provider.ts +20 -20
  233. package/server/modules/providers/shared/mcp/mcp.provider.ts +151 -151
  234. package/server/modules/providers/shared/provider-configs.ts +142 -142
  235. package/server/modules/providers/tests/mcp.test.ts +293 -293
  236. package/server/openai-codex.js +462 -462
  237. package/server/opencode-cli.js +491 -491
  238. package/server/opencode-response-handler.js +111 -111
  239. package/server/projects.js +3008 -3008
  240. package/server/qwen-code-cli.js +410 -410
  241. package/server/qwen-response-handler.js +73 -73
  242. package/server/routes/agent.js +1435 -1435
  243. package/server/routes/auth.js +142 -142
  244. package/server/routes/codex.js +20 -20
  245. package/server/routes/commands.js +538 -538
  246. package/server/routes/cursor.js +61 -61
  247. package/server/routes/diagnostics.js +41 -41
  248. package/server/routes/gemini.js +25 -25
  249. package/server/routes/git.js +1641 -1641
  250. package/server/routes/live-view.js +387 -387
  251. package/server/routes/mcp-utils.js +13 -13
  252. package/server/routes/messages.js +50 -50
  253. package/server/routes/network.js +117 -117
  254. package/server/routes/platformization.js +182 -182
  255. package/server/routes/plugins.js +320 -320
  256. package/server/routes/production-agent-loop.js +90 -90
  257. package/server/routes/projects.js +911 -911
  258. package/server/routes/public-api.js +34 -34
  259. package/server/routes/qwen.js +27 -27
  260. package/server/routes/remote.js +50 -50
  261. package/server/routes/settings.js +321 -321
  262. package/server/routes/telegram.js +140 -140
  263. package/server/routes/user.js +125 -125
  264. package/server/routes/webhooks.js +63 -63
  265. package/server/services/control-room.js +102 -102
  266. package/server/services/diagnostics.js +165 -165
  267. package/server/services/external-access.js +375 -375
  268. package/server/services/hermes-gateway.js +1562 -1562
  269. package/server/services/hermes-install-jobs.js +729 -729
  270. package/server/services/install-jobs.js +715 -715
  271. package/server/services/live-view.js +956 -956
  272. package/server/services/managed-runtimes.js +493 -493
  273. package/server/services/model-registry.js +144 -144
  274. package/server/services/notification-orchestrator.js +365 -365
  275. package/server/services/notification-taxonomy.js +204 -204
  276. package/server/services/platformization.js +773 -773
  277. package/server/services/production-agent-loop.js +248 -248
  278. package/server/services/provider-cli-versions.js +149 -149
  279. package/server/services/provider-credentials.js +189 -189
  280. package/server/services/provider-models.js +396 -396
  281. package/server/services/public-api-manifest.js +190 -190
  282. package/server/services/remote-connection.js +127 -127
  283. package/server/services/runtime-manager.js +323 -323
  284. package/server/services/startup-update.js +234 -234
  285. package/server/services/telegram/bot.js +331 -331
  286. package/server/services/telegram/control-center.js +979 -979
  287. package/server/services/telegram/telegram-http-client.js +151 -151
  288. package/server/services/telegram/translations.js +340 -340
  289. package/server/services/vapid-keys.js +36 -36
  290. package/server/services/webhooks.js +216 -216
  291. package/server/sessionManager.js +225 -225
  292. package/server/shared/interfaces.ts +54 -54
  293. package/server/shared/types.ts +172 -172
  294. package/server/shared/utils.ts +193 -193
  295. package/server/tsconfig.json +36 -36
  296. package/server/utils/colors.js +21 -21
  297. package/server/utils/commandParser.js +305 -305
  298. package/server/utils/frontmatter.js +18 -18
  299. package/server/utils/gitConfig.js +34 -34
  300. package/server/utils/plugin-loader.js +457 -457
  301. package/server/utils/plugin-process-manager.js +185 -185
  302. package/server/utils/port-access.js +209 -209
  303. package/server/utils/runtime-paths.js +37 -37
  304. package/server/utils/url-detection.js +71 -71
  305. package/server/vite-daemon.js +79 -79
  306. package/shared/modelConstants.js +161 -161
  307. package/shared/networkHosts.js +22 -22
package/dist/docs.html CHANGED
@@ -1,308 +1,308 @@
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 Documentation - Complete Self-hosted AI Coding Agent Guide</title>
7
- <meta
8
- name="description"
9
- content="Complete Pixcode documentation covering Claude Code, Cursor CLI, OpenAI Codex, Gemini CLI, Qwen Code, OpenCode, VS Code-style workspaces, files, terminal panels, Git/local changes, Hermes orchestration, API keys, Telegram, notifications, MCP, plugins, themes, desktop installers, and Linux server deployment."
10
- />
11
- <meta
12
- name="keywords"
13
- content="Pixcode documentation, Claude Code web UI documentation, Codex UI documentation, Cursor CLI web interface, AI coding agent orchestration docs, Hermes Agent, OpenCode UI docs, MCP server manager, local AI coding assistant, self-hosted coding agent dashboard"
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/docs.html" />
17
- <link rel="icon" href="favicon.png" />
18
- <link rel="stylesheet" href="site.css" />
19
- <meta property="og:title" content="Pixcode Documentation" />
20
- <meta property="og:description" content="A complete guide to Pixcode features, setup, orchestration, API automation, providers, plugins, MCP, Telegram, themes, and deployment." />
21
- <meta property="og:image" content="screenshots/desktop-main.png" />
22
- <script type="application/ld+json">
23
- {
24
- "@context": "https://schema.org",
25
- "@type": "TechArticle",
26
- "headline": "Pixcode Documentation",
27
- "about": [
28
- "AI coding agents",
29
- "Claude Code UI",
30
- "OpenAI Codex UI",
31
- "multi-agent orchestration",
32
- "self-hosted developer tools"
33
- ],
34
- "description": "Complete documentation for Pixcode, a self-hosted AI coding agent control room.",
35
- "author": {
36
- "@type": "Organization",
37
- "name": "Pixcode Contributors"
38
- }
39
- }
40
- </script>
41
- </head>
42
- <body>
43
- <nav class="site-nav" aria-label="Main navigation">
44
- <a class="brand" href="landing.html">
45
- <img src="logo.png" alt="" />
46
- <span>Pixcode</span>
47
- </a>
48
- <div class="nav-links">
49
- <a href="docs.html">Documentation</a>
50
- <a href="features.html">Features</a>
51
- <a href="orchestration.html">Orchestration</a>
52
- <a href="api-automation.html">API</a>
53
- <a href="https://github.com/alicomert/pixcode">GitHub</a>
54
- </div>
55
- </nav>
56
-
57
- <header class="hero docs-hero">
58
- <div>
59
- <div class="eyebrow">Complete documentation</div>
60
- <h1>Pixcode from start to finish.</h1>
61
- <p class="lead">
62
- Pixcode is a self-hosted control plane for AI coding agents. This page explains the full system: providers, chat, files, shell, source control, orchestration, API keys, Telegram, notifications, plugins, MCP, themes, desktop builds, Linux daemon mode, and development workflow.
63
- </p>
64
- </div>
65
- <div class="image-slot">
66
- <span><strong>Documentation hero image slot</strong>Recommended: 1400 x 1000. Show a clean overview of Pixcode with chat, panels, provider status, and orchestration.</span>
67
- </div>
68
- </header>
69
-
70
- <main class="section">
71
- <div class="grid sidebar">
72
- <aside class="toc" aria-label="Documentation table of contents">
73
- <a href="#overview">Overview</a>
74
- <a href="#providers">Provider support</a>
75
- <a href="#workspace">Workspace UI</a>
76
- <a href="#command-center">Changed files</a>
77
- <a href="#orchestration">Orchestration</a>
78
- <a href="#hermes">Hermes Agent</a>
79
- <a href="#api">API and automation</a>
80
- <a href="#telegram">Notifications and Telegram</a>
81
- <a href="#plugins">Plugins and MCP</a>
82
- <a href="#themes">Themes</a>
83
- <a href="#install">Install and deployment</a>
84
- <a href="#security">Security</a>
85
- <a href="#development">Development</a>
86
- </aside>
87
-
88
- <div class="doc-content">
89
- <section id="overview" class="doc-section">
90
- <h2>Overview</h2>
91
- <p>
92
- Pixcode gives developers one browser-based workspace for AI coding CLIs. The app runs locally or on a server, serves a React/Vite frontend, and exposes an Express/WebSocket backend that controls provider processes, project files, Git state, shell sessions, notifications, and orchestration workflows.
93
- </p>
94
- <p>
95
- The core idea is simple: keep the provider-native command line tools, but add a serious control surface around them. A coding agent can edit files, run commands, wait for permissions, fail, recover, or hand work to another model. Pixcode is designed to make those states visible and manageable instead of hiding them behind a blank terminal.
96
- </p>
97
- <div class="grid two">
98
- <div class="card">
99
- <strong>Who it is for</strong>
100
- <p>Developers, solo builders, teams, educators, and automation-heavy users who want to run AI coding agents on their own machine or server.</p>
101
- </div>
102
- <div class="card">
103
- <strong>What it is not</strong>
104
- <p>Pixcode is not a hosted cloud IDE and not an official OpenAI, Anthropic, Google, Cursor, Qwen, or OpenCode product.</p>
105
- </div>
106
- </div>
107
- </section>
108
-
109
- <section id="providers" class="doc-section">
110
- <h2>Provider support</h2>
111
- <p>
112
- Pixcode currently targets Claude Code, Cursor CLI, OpenAI Codex, Gemini CLI, Qwen Code, and OpenCode. Each provider can have its own authentication flow, model list, session handling, MCP behavior, CLI installation status, and runtime output style.
113
- </p>
114
- <ul class="feature-list">
115
- <li>Claude Code support with sessions, hooks, notifications, and MCP-related provider settings.</li>
116
- <li>Codex support for OpenAI-backed coding workflows and REST-triggered automation.</li>
117
- <li>Cursor CLI support for developers who already keep Cursor CLI in their local workflow.</li>
118
- <li>Gemini CLI support for Google model workflows.</li>
119
- <li>Qwen Code support for Qwen-based coding flows.</li>
120
- <li>OpenCode support with model selection and free/open provider use cases.</li>
121
- </ul>
122
- <div class="image-slot wide">
123
- <span><strong>Provider settings image slot</strong>Recommended: 1600 x 900. Show provider auth status, model refresh, API key/base URL fields, and CLI version update notices.</span>
124
- </div>
125
- </section>
126
-
127
- <section id="workspace" class="doc-section">
128
- <h2>Workspace UI</h2>
129
- <p>
130
- The Pixcode workspace is organized around the active project. The main area can be a chat screen or the orchestration system, depending on what the user is doing. Supporting panels such as Shell, Files, and Source Control can open alongside the main view, so the user does not lose context.
131
- </p>
132
- <h3>Chat</h3>
133
- <p>
134
- Chat is project-aware and session-based. The prompt composer stays fixed at the bottom of the screen in the main chat/project view. Users can switch providers and modes, send multiline messages, use slash commands, and review tool output in structured components.
135
- </p>
136
- <h3>Shell</h3>
137
- <p>
138
- The shell panel gives direct project terminal access from inside the browser. On desktop, the panel can open as a split view first and expand to a full panel if needed. On mobile, the layout avoids desktop-only split behavior and adapts to the smaller screen.
139
- </p>
140
- <h3>Files</h3>
141
- <p>
142
- The file browser supports project navigation, file opening, editing, upload, rename, delete, and detailed metadata. Narrow-panel behavior is tuned so long names and permissions do not consume the entire view.
143
- </p>
144
- <h3>Source Control</h3>
145
- <p>
146
- Source Control shows Git status, changed files, diffs, branches, commits, and repository actions. It is designed to be close to agent work, because code-generating agents must be reviewed through actual diffs, not only through chat summaries.
147
- </p>
148
- <div class="screen-grid">
149
- <img src="screenshots/desktop-main.png" alt="Pixcode workspace screenshot" />
150
- <img src="screenshots/mobile-chat.png" alt="Pixcode mobile chat screenshot" />
151
- </div>
152
- </section>
153
-
154
- <section id="command-center" class="doc-section">
155
- <h2>Changed files command center</h2>
156
- <p>
157
- Pixcode can watch Git changes or local filesystem changes. In Quick Settings, the Command Center view can show changed files as they appear, highlight newly modified paths, and open the related file location. This helps users keep control when an AI agent edits multiple files quickly, even when the project is not a Git repository.
158
- </p>
159
- <p>
160
- The important design point is that this does not depend on GitHub pushes. It works with local changes, so the user can review the agent's work before committing, pushing, tagging, or publishing.
161
- </p>
162
- <div class="image-slot">
163
- <span><strong>Changed files image slot</strong>Recommended: 1200 x 900. Show Quick Settings with changed file list, green highlight, and right panel file preview.</span>
164
- </div>
165
- </section>
166
-
167
- <section id="orchestration" class="doc-section">
168
- <h2>Multi-agent orchestration</h2>
169
- <p>
170
- Pixcode orchestration coordinates multiple child agents around one goal. The workflow layer uses adapter-backed tasks, shared context, per-agent metadata, run events, preview endpoints, cancellation, and a UI that lets users resize the setup and output panes.
171
- </p>
172
- <ul class="feature-list">
173
- <li>Agent Team for role-based work distribution.</li>
174
- <li>Multi-model Review for independent review from different providers or models.</li>
175
- <li>Sequential Handoff for ordered workflows where later steps depend on earlier output.</li>
176
- <li>Decision Debate for comparing approaches before implementation.</li>
177
- <li>Per-agent label, role, model, instruction, and fallback CLI selection.</li>
178
- <li>Workflow DAG preview before execution.</li>
179
- <li>Run event streaming and cancellation.</li>
180
- </ul>
181
- <p>
182
- For deeper orchestration details, see <a href="orchestration.html">orchestration.html</a>.
183
- </p>
184
- </section>
185
-
186
- <section id="hermes" class="doc-section">
187
- <h2>Hermes Agent orchestration</h2>
188
- <p>
189
- Pixcode uses Hermes Agent for project-aware background workflow, review, and verification tasks. Hermes runs inside the current Pixcode instance, understands the selected project, and routes work to the configured CLI provider.
190
- </p>
191
- <p>
192
- Hermes APIs expose agent status, context, project-scoped task history, streamed task output, and artifacts under the authenticated orchestration endpoints.
193
- </p>
194
- <div class="code-panel"><pre><code>GET /api/orchestration/hermes/status
195
- GET /api/orchestration/hermes/agents
196
- GET /api/orchestration/hermes/tasks/:id</code></pre></div>
197
- </section>
198
-
199
- <section id="api" class="doc-section">
200
- <h2>API and automation</h2>
201
- <p>
202
- Pixcode is API-first internally: the frontend communicates with the backend through REST and WebSocket APIs. External tools can use Pixcode API keys for automation. New keys use the `px_` prefix, while older `ck_` keys remain accepted for compatibility.
203
- </p>
204
- <div class="code-panel"><pre><code>curl http://localhost:3001/api/projects \
205
- -H "Authorization: Bearer px_your_key_here"</code></pre></div>
206
- <p>
207
- Automation can list projects, run one-shot provider tasks, preview orchestration graphs, start workflow runs, stream events, cancel work, and integrate Pixcode into CI, scripts, dashboards, or Telegram-style bridges.
208
- </p>
209
- <p>
210
- See <a href="api-automation.html">api-automation.html</a> and <a href="openapi.yaml">openapi.yaml</a>.
211
- </p>
212
- </section>
213
-
214
- <section id="telegram" class="doc-section">
215
- <h2>Notifications and Telegram</h2>
216
- <p>
217
- Long-running agent tasks should report back. Pixcode includes browser push notification support and a Telegram pairing flow. Users can receive notifications when sessions complete, fail, or require action. Telegram bridge behavior can route messages back into the Pixcode instance when enabled.
218
- </p>
219
- <div class="image-slot">
220
- <span><strong>Telegram and notification image slot</strong>Recommended: 1200 x 900. Show notification settings, Telegram pairing code, and a task completion notification.</span>
221
- </div>
222
- </section>
223
-
224
- <section id="plugins" class="doc-section">
225
- <h2>Plugins and MCP</h2>
226
- <p>
227
- Pixcode includes extension points for provider tools, MCP server management, and plugins. Provider-specific settings can manage MCP configuration, sessions, API-key credentials, OAuth paste flows, install jobs, and model catalogs. Plugins can add frontend tabs and optional backend services.
228
- </p>
229
- <ul class="feature-list">
230
- <li>MCP server management for supported providers.</li>
231
- <li>Provider auth and session panels.</li>
232
- <li>Model refresh and CLI install status.</li>
233
- <li>Plugin loader support for UI tabs and backend integrations.</li>
234
- </ul>
235
- </section>
236
-
237
- <section id="themes" class="doc-section">
238
- <h2>Themes and appearance</h2>
239
- <p>
240
- Pixcode supports dark/light mode, built-in accent palettes, VS Code-like colors, emerald command-style colors, and custom accent values for dark and light modes. Theme tokens affect buttons, active states, focus rings, navigation, and other high-emphasis UI parts together.
241
- </p>
242
- <div class="grid two">
243
- <div class="image-slot">
244
- <span><strong>Dark theme slot</strong>Recommended: 1200 x 900. Show a terminal-like dark UI with emerald or amber accents.</span>
245
- </div>
246
- <div class="image-slot">
247
- <span><strong>Light theme slot</strong>Recommended: 1200 x 900. Show custom accent color and readable light mode.</span>
248
- </div>
249
- </div>
250
- </section>
251
-
252
- <section id="install" class="doc-section">
253
- <h2>Install and deployment</h2>
254
- <p>
255
- Pixcode targets Node.js 22+. The recommended quick start is npx or a global npm installation. Normal installed runtime serves the backend and built frontend through port 3001. Vite port 5173 is only for separate frontend development.
256
- </p>
257
- <div class="grid three">
258
- <div class="code-panel"><pre><code>npx @pixelbyte-software/pixcode</code></pre></div>
259
- <div class="code-panel"><pre><code>npm install -g @pixelbyte-software/pixcode
260
- pixcode</code></pre></div>
261
- <div class="code-panel"><pre><code>pixcode daemon install --mode auto --port 3001
262
- pixcode daemon status --mode auto</code></pre></div>
263
- </div>
264
- <p>
265
- Desktop installers are published from GitHub releases for Windows `.exe`, macOS `.dmg`, and Linux package/AppImage-style assets depending on the release.
266
- </p>
267
- </section>
268
-
269
- <section id="security" class="doc-section">
270
- <h2>Security model</h2>
271
- <p>
272
- Pixcode can control project files, shell sessions, Git state, provider CLIs, API keys, and external notification channels. Treat it like a powerful local admin interface. Use strong account credentials, rotate exposed API keys, and put public server deployments behind trusted network controls such as a reverse proxy, firewall, or VPN.
273
- </p>
274
- <ul class="feature-list">
275
- <li>Local account login protects the web UI.</li>
276
- <li>API keys are for automation and should be scoped operationally by where they are stored.</li>
277
- <li>Provider secrets should not be exposed in logs, screenshots, public pages, or issue reports.</li>
278
- <li>Remote deployments should be treated as sensitive developer infrastructure.</li>
279
- </ul>
280
- </section>
281
-
282
- <section id="development" class="doc-section">
283
- <h2>Development workflow</h2>
284
- <p>
285
- The frontend is React + Vite. The backend is Express + WebSocket with provider routes, orchestration modules, SQLite-backed auth data, and CLI adapter files. There is no unit test suite configured today; use typecheck, lint, build, and targeted manual smoke checks.
286
- </p>
287
- <div class="code-panel"><pre><code>npm install
288
- npm run typecheck
289
- npm run lint
290
- npm run build</code></pre></div>
291
- <p>
292
- Important: `npm run dev` starts the daemon manager on Linux. For separate frontend development, use `npm run client`. For built backend runtime, rebuild before `npm run server`.
293
- </p>
294
- </section>
295
- </div>
296
- </div>
297
- </main>
298
-
299
- <footer class="footer">
300
- <strong>Pixcode documentation</strong> ·
301
- <a href="landing.html">Home</a> ·
302
- <a href="features.html">Features</a> ·
303
- <a href="orchestration.html">Orchestration</a> ·
304
- <a href="api-automation.html">API</a> ·
305
- <a href="llms.txt">llms.txt</a>
306
- </footer>
307
- </body>
308
- </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 Documentation - Complete Self-hosted AI Coding Agent Guide</title>
7
+ <meta
8
+ name="description"
9
+ content="Complete Pixcode documentation covering Claude Code, Cursor CLI, OpenAI Codex, Gemini CLI, Qwen Code, OpenCode, VS Code-style workspaces, files, terminal panels, Git/local changes, Hermes orchestration, API keys, Telegram, notifications, MCP, plugins, themes, desktop installers, and Linux server deployment."
10
+ />
11
+ <meta
12
+ name="keywords"
13
+ content="Pixcode documentation, Claude Code web UI documentation, Codex UI documentation, Cursor CLI web interface, AI coding agent orchestration docs, Hermes Agent, OpenCode UI docs, MCP server manager, local AI coding assistant, self-hosted coding agent dashboard"
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/docs.html" />
17
+ <link rel="icon" href="favicon.png" />
18
+ <link rel="stylesheet" href="site.css" />
19
+ <meta property="og:title" content="Pixcode Documentation" />
20
+ <meta property="og:description" content="A complete guide to Pixcode features, setup, orchestration, API automation, providers, plugins, MCP, Telegram, themes, and deployment." />
21
+ <meta property="og:image" content="screenshots/desktop-main.png" />
22
+ <script type="application/ld+json">
23
+ {
24
+ "@context": "https://schema.org",
25
+ "@type": "TechArticle",
26
+ "headline": "Pixcode Documentation",
27
+ "about": [
28
+ "AI coding agents",
29
+ "Claude Code UI",
30
+ "OpenAI Codex UI",
31
+ "multi-agent orchestration",
32
+ "self-hosted developer tools"
33
+ ],
34
+ "description": "Complete documentation for Pixcode, a self-hosted AI coding agent control room.",
35
+ "author": {
36
+ "@type": "Organization",
37
+ "name": "Pixcode Contributors"
38
+ }
39
+ }
40
+ </script>
41
+ </head>
42
+ <body>
43
+ <nav class="site-nav" aria-label="Main navigation">
44
+ <a class="brand" href="landing.html">
45
+ <img src="logo.png" alt="" />
46
+ <span>Pixcode</span>
47
+ </a>
48
+ <div class="nav-links">
49
+ <a href="docs.html">Documentation</a>
50
+ <a href="features.html">Features</a>
51
+ <a href="orchestration.html">Orchestration</a>
52
+ <a href="api-automation.html">API</a>
53
+ <a href="https://github.com/alicomert/pixcode">GitHub</a>
54
+ </div>
55
+ </nav>
56
+
57
+ <header class="hero docs-hero">
58
+ <div>
59
+ <div class="eyebrow">Complete documentation</div>
60
+ <h1>Pixcode from start to finish.</h1>
61
+ <p class="lead">
62
+ Pixcode is a self-hosted control plane for AI coding agents. This page explains the full system: providers, chat, files, shell, source control, orchestration, API keys, Telegram, notifications, plugins, MCP, themes, desktop builds, Linux daemon mode, and development workflow.
63
+ </p>
64
+ </div>
65
+ <div class="image-slot">
66
+ <span><strong>Documentation hero image slot</strong>Recommended: 1400 x 1000. Show a clean overview of Pixcode with chat, panels, provider status, and orchestration.</span>
67
+ </div>
68
+ </header>
69
+
70
+ <main class="section">
71
+ <div class="grid sidebar">
72
+ <aside class="toc" aria-label="Documentation table of contents">
73
+ <a href="#overview">Overview</a>
74
+ <a href="#providers">Provider support</a>
75
+ <a href="#workspace">Workspace UI</a>
76
+ <a href="#command-center">Changed files</a>
77
+ <a href="#orchestration">Orchestration</a>
78
+ <a href="#hermes">Hermes Agent</a>
79
+ <a href="#api">API and automation</a>
80
+ <a href="#telegram">Notifications and Telegram</a>
81
+ <a href="#plugins">Plugins and MCP</a>
82
+ <a href="#themes">Themes</a>
83
+ <a href="#install">Install and deployment</a>
84
+ <a href="#security">Security</a>
85
+ <a href="#development">Development</a>
86
+ </aside>
87
+
88
+ <div class="doc-content">
89
+ <section id="overview" class="doc-section">
90
+ <h2>Overview</h2>
91
+ <p>
92
+ Pixcode gives developers one browser-based workspace for AI coding CLIs. The app runs locally or on a server, serves a React/Vite frontend, and exposes an Express/WebSocket backend that controls provider processes, project files, Git state, shell sessions, notifications, and orchestration workflows.
93
+ </p>
94
+ <p>
95
+ The core idea is simple: keep the provider-native command line tools, but add a serious control surface around them. A coding agent can edit files, run commands, wait for permissions, fail, recover, or hand work to another model. Pixcode is designed to make those states visible and manageable instead of hiding them behind a blank terminal.
96
+ </p>
97
+ <div class="grid two">
98
+ <div class="card">
99
+ <strong>Who it is for</strong>
100
+ <p>Developers, solo builders, teams, educators, and automation-heavy users who want to run AI coding agents on their own machine or server.</p>
101
+ </div>
102
+ <div class="card">
103
+ <strong>What it is not</strong>
104
+ <p>Pixcode is not a hosted cloud IDE and not an official OpenAI, Anthropic, Google, Cursor, Qwen, or OpenCode product.</p>
105
+ </div>
106
+ </div>
107
+ </section>
108
+
109
+ <section id="providers" class="doc-section">
110
+ <h2>Provider support</h2>
111
+ <p>
112
+ Pixcode currently targets Claude Code, Cursor CLI, OpenAI Codex, Gemini CLI, Qwen Code, and OpenCode. Each provider can have its own authentication flow, model list, session handling, MCP behavior, CLI installation status, and runtime output style.
113
+ </p>
114
+ <ul class="feature-list">
115
+ <li>Claude Code support with sessions, hooks, notifications, and MCP-related provider settings.</li>
116
+ <li>Codex support for OpenAI-backed coding workflows and REST-triggered automation.</li>
117
+ <li>Cursor CLI support for developers who already keep Cursor CLI in their local workflow.</li>
118
+ <li>Gemini CLI support for Google model workflows.</li>
119
+ <li>Qwen Code support for Qwen-based coding flows.</li>
120
+ <li>OpenCode support with model selection and free/open provider use cases.</li>
121
+ </ul>
122
+ <div class="image-slot wide">
123
+ <span><strong>Provider settings image slot</strong>Recommended: 1600 x 900. Show provider auth status, model refresh, API key/base URL fields, and CLI version update notices.</span>
124
+ </div>
125
+ </section>
126
+
127
+ <section id="workspace" class="doc-section">
128
+ <h2>Workspace UI</h2>
129
+ <p>
130
+ The Pixcode workspace is organized around the active project. The main area can be a chat screen or the orchestration system, depending on what the user is doing. Supporting panels such as Shell, Files, and Source Control can open alongside the main view, so the user does not lose context.
131
+ </p>
132
+ <h3>Chat</h3>
133
+ <p>
134
+ Chat is project-aware and session-based. The prompt composer stays fixed at the bottom of the screen in the main chat/project view. Users can switch providers and modes, send multiline messages, use slash commands, and review tool output in structured components.
135
+ </p>
136
+ <h3>Shell</h3>
137
+ <p>
138
+ The shell panel gives direct project terminal access from inside the browser. On desktop, the panel can open as a split view first and expand to a full panel if needed. On mobile, the layout avoids desktop-only split behavior and adapts to the smaller screen.
139
+ </p>
140
+ <h3>Files</h3>
141
+ <p>
142
+ The file browser supports project navigation, file opening, editing, upload, rename, delete, and detailed metadata. Narrow-panel behavior is tuned so long names and permissions do not consume the entire view.
143
+ </p>
144
+ <h3>Source Control</h3>
145
+ <p>
146
+ Source Control shows Git status, changed files, diffs, branches, commits, and repository actions. It is designed to be close to agent work, because code-generating agents must be reviewed through actual diffs, not only through chat summaries.
147
+ </p>
148
+ <div class="screen-grid">
149
+ <img src="screenshots/desktop-main.png" alt="Pixcode workspace screenshot" />
150
+ <img src="screenshots/mobile-chat.png" alt="Pixcode mobile chat screenshot" />
151
+ </div>
152
+ </section>
153
+
154
+ <section id="command-center" class="doc-section">
155
+ <h2>Changed files command center</h2>
156
+ <p>
157
+ Pixcode can watch Git changes or local filesystem changes. In Quick Settings, the Command Center view can show changed files as they appear, highlight newly modified paths, and open the related file location. This helps users keep control when an AI agent edits multiple files quickly, even when the project is not a Git repository.
158
+ </p>
159
+ <p>
160
+ The important design point is that this does not depend on GitHub pushes. It works with local changes, so the user can review the agent's work before committing, pushing, tagging, or publishing.
161
+ </p>
162
+ <div class="image-slot">
163
+ <span><strong>Changed files image slot</strong>Recommended: 1200 x 900. Show Quick Settings with changed file list, green highlight, and right panel file preview.</span>
164
+ </div>
165
+ </section>
166
+
167
+ <section id="orchestration" class="doc-section">
168
+ <h2>Multi-agent orchestration</h2>
169
+ <p>
170
+ Pixcode orchestration coordinates multiple child agents around one goal. The workflow layer uses adapter-backed tasks, shared context, per-agent metadata, run events, preview endpoints, cancellation, and a UI that lets users resize the setup and output panes.
171
+ </p>
172
+ <ul class="feature-list">
173
+ <li>Agent Team for role-based work distribution.</li>
174
+ <li>Multi-model Review for independent review from different providers or models.</li>
175
+ <li>Sequential Handoff for ordered workflows where later steps depend on earlier output.</li>
176
+ <li>Decision Debate for comparing approaches before implementation.</li>
177
+ <li>Per-agent label, role, model, instruction, and fallback CLI selection.</li>
178
+ <li>Workflow DAG preview before execution.</li>
179
+ <li>Run event streaming and cancellation.</li>
180
+ </ul>
181
+ <p>
182
+ For deeper orchestration details, see <a href="orchestration.html">orchestration.html</a>.
183
+ </p>
184
+ </section>
185
+
186
+ <section id="hermes" class="doc-section">
187
+ <h2>Hermes Agent orchestration</h2>
188
+ <p>
189
+ Pixcode uses Hermes Agent for project-aware background workflow, review, and verification tasks. Hermes runs inside the current Pixcode instance, understands the selected project, and routes work to the configured CLI provider.
190
+ </p>
191
+ <p>
192
+ Hermes APIs expose agent status, context, project-scoped task history, streamed task output, and artifacts under the authenticated orchestration endpoints.
193
+ </p>
194
+ <div class="code-panel"><pre><code>GET /api/orchestration/hermes/status
195
+ GET /api/orchestration/hermes/agents
196
+ GET /api/orchestration/hermes/tasks/:id</code></pre></div>
197
+ </section>
198
+
199
+ <section id="api" class="doc-section">
200
+ <h2>API and automation</h2>
201
+ <p>
202
+ Pixcode is API-first internally: the frontend communicates with the backend through REST and WebSocket APIs. External tools can use Pixcode API keys for automation. New keys use the `px_` prefix, while older `ck_` keys remain accepted for compatibility.
203
+ </p>
204
+ <div class="code-panel"><pre><code>curl http://localhost:3001/api/projects \
205
+ -H "Authorization: Bearer px_your_key_here"</code></pre></div>
206
+ <p>
207
+ Automation can list projects, run one-shot provider tasks, preview orchestration graphs, start workflow runs, stream events, cancel work, and integrate Pixcode into CI, scripts, dashboards, or Telegram-style bridges.
208
+ </p>
209
+ <p>
210
+ See <a href="api-automation.html">api-automation.html</a> and <a href="openapi.yaml">openapi.yaml</a>.
211
+ </p>
212
+ </section>
213
+
214
+ <section id="telegram" class="doc-section">
215
+ <h2>Notifications and Telegram</h2>
216
+ <p>
217
+ Long-running agent tasks should report back. Pixcode includes browser push notification support and a Telegram pairing flow. Users can receive notifications when sessions complete, fail, or require action. Telegram bridge behavior can route messages back into the Pixcode instance when enabled.
218
+ </p>
219
+ <div class="image-slot">
220
+ <span><strong>Telegram and notification image slot</strong>Recommended: 1200 x 900. Show notification settings, Telegram pairing code, and a task completion notification.</span>
221
+ </div>
222
+ </section>
223
+
224
+ <section id="plugins" class="doc-section">
225
+ <h2>Plugins and MCP</h2>
226
+ <p>
227
+ Pixcode includes extension points for provider tools, MCP server management, and plugins. Provider-specific settings can manage MCP configuration, sessions, API-key credentials, OAuth paste flows, install jobs, and model catalogs. Plugins can add frontend tabs and optional backend services.
228
+ </p>
229
+ <ul class="feature-list">
230
+ <li>MCP server management for supported providers.</li>
231
+ <li>Provider auth and session panels.</li>
232
+ <li>Model refresh and CLI install status.</li>
233
+ <li>Plugin loader support for UI tabs and backend integrations.</li>
234
+ </ul>
235
+ </section>
236
+
237
+ <section id="themes" class="doc-section">
238
+ <h2>Themes and appearance</h2>
239
+ <p>
240
+ Pixcode supports dark/light mode, built-in accent palettes, VS Code-like colors, emerald command-style colors, and custom accent values for dark and light modes. Theme tokens affect buttons, active states, focus rings, navigation, and other high-emphasis UI parts together.
241
+ </p>
242
+ <div class="grid two">
243
+ <div class="image-slot">
244
+ <span><strong>Dark theme slot</strong>Recommended: 1200 x 900. Show a terminal-like dark UI with emerald or amber accents.</span>
245
+ </div>
246
+ <div class="image-slot">
247
+ <span><strong>Light theme slot</strong>Recommended: 1200 x 900. Show custom accent color and readable light mode.</span>
248
+ </div>
249
+ </div>
250
+ </section>
251
+
252
+ <section id="install" class="doc-section">
253
+ <h2>Install and deployment</h2>
254
+ <p>
255
+ Pixcode targets Node.js 22+. The recommended quick start is npx or a global npm installation. Normal installed runtime serves the backend and built frontend through port 3001. Vite port 5173 is only for separate frontend development.
256
+ </p>
257
+ <div class="grid three">
258
+ <div class="code-panel"><pre><code>npx @pixelbyte-software/pixcode</code></pre></div>
259
+ <div class="code-panel"><pre><code>npm install -g @pixelbyte-software/pixcode
260
+ pixcode</code></pre></div>
261
+ <div class="code-panel"><pre><code>pixcode daemon install --mode auto --port 3001
262
+ pixcode daemon status --mode auto</code></pre></div>
263
+ </div>
264
+ <p>
265
+ Desktop installers are published from GitHub releases for Windows `.exe`, macOS `.dmg`, and Linux package/AppImage-style assets depending on the release.
266
+ </p>
267
+ </section>
268
+
269
+ <section id="security" class="doc-section">
270
+ <h2>Security model</h2>
271
+ <p>
272
+ Pixcode can control project files, shell sessions, Git state, provider CLIs, API keys, and external notification channels. Treat it like a powerful local admin interface. Use strong account credentials, rotate exposed API keys, and put public server deployments behind trusted network controls such as a reverse proxy, firewall, or VPN.
273
+ </p>
274
+ <ul class="feature-list">
275
+ <li>Local account login protects the web UI.</li>
276
+ <li>API keys are for automation and should be scoped operationally by where they are stored.</li>
277
+ <li>Provider secrets should not be exposed in logs, screenshots, public pages, or issue reports.</li>
278
+ <li>Remote deployments should be treated as sensitive developer infrastructure.</li>
279
+ </ul>
280
+ </section>
281
+
282
+ <section id="development" class="doc-section">
283
+ <h2>Development workflow</h2>
284
+ <p>
285
+ The frontend is React + Vite. The backend is Express + WebSocket with provider routes, orchestration modules, SQLite-backed auth data, and CLI adapter files. There is no unit test suite configured today; use typecheck, lint, build, and targeted manual smoke checks.
286
+ </p>
287
+ <div class="code-panel"><pre><code>npm install
288
+ npm run typecheck
289
+ npm run lint
290
+ npm run build</code></pre></div>
291
+ <p>
292
+ Important: `npm run dev` starts the daemon manager on Linux. For separate frontend development, use `npm run client`. For built backend runtime, rebuild before `npm run server`.
293
+ </p>
294
+ </section>
295
+ </div>
296
+ </div>
297
+ </main>
298
+
299
+ <footer class="footer">
300
+ <strong>Pixcode documentation</strong> ·
301
+ <a href="landing.html">Home</a> ·
302
+ <a href="features.html">Features</a> ·
303
+ <a href="orchestration.html">Orchestration</a> ·
304
+ <a href="api-automation.html">API</a> ·
305
+ <a href="llms.txt">llms.txt</a>
306
+ </footer>
307
+ </body>
308
+ </html>