@symerian/symi 3.0.20 → 3.0.22

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 (737) hide show
  1. package/dist/{audio-preflight-BaCdNfrk.js → audio-preflight-D7BVT-ls.js} +4 -4
  2. package/dist/build-info.json +3 -3
  3. package/dist/canvas-host/a2ui/.bundle.hash +1 -1
  4. package/dist/{chrome-UfmVM0xR.js → chrome-B5CO2vB5.js} +7 -7
  5. package/dist/{deliver-BqXdac6W.js → deliver-CrwjsDwv.js} +1 -1
  6. package/dist/extensionAPI.js +7 -7
  7. package/dist/{image-DIWsXYcW.js → image-Csu7WcLW.js} +1 -1
  8. package/dist/{manager-DW3SxcPr.js → manager-BkkVjTO8.js} +1 -1
  9. package/dist/{pi-embedded-BNch0U5F.js → pi-embedded-Dhp64z5l.js} +16 -16
  10. package/dist/{pi-embedded-helpers-IkHl02JF.js → pi-embedded-helpers-840E4hop.js} +4 -4
  11. package/dist/{pw-ai-nMkA-oDJ.js → pw-ai-CBgJf_RR.js} +1 -1
  12. package/dist/{runner-DNEC58JI.js → runner-BbFKo1ne.js} +1 -1
  13. package/dist/{synthesis-BWAr0sZ9.js → synthesis-DoEM0E8_.js} +7 -7
  14. package/dist/{web-7a-m_UxL.js → web-BYXJn-Ps.js} +7 -7
  15. package/package.json +1 -1
  16. package/docs/.i18n/README.md +0 -31
  17. package/docs/.i18n/glossary.ja-JP.json +0 -14
  18. package/docs/.i18n/glossary.zh-CN.json +0 -210
  19. package/docs/.i18n/ja-JP.tm.jsonl +0 -0
  20. package/docs/.i18n/zh-CN.tm.jsonl +0 -1303
  21. package/docs/CNAME +0 -1
  22. package/docs/assets/install-script.svg +0 -1
  23. package/docs/assets/macos-onboarding/01-macos-warning.jpeg +0 -0
  24. package/docs/assets/macos-onboarding/02-local-networks.jpeg +0 -0
  25. package/docs/assets/macos-onboarding/03-security-notice.png +0 -0
  26. package/docs/assets/macos-onboarding/04-choose-gateway.png +0 -0
  27. package/docs/assets/macos-onboarding/05-permissions.png +0 -0
  28. package/docs/assets/pixel-symi.svg +0 -60
  29. package/docs/assets/showcase/agents-ui.jpg +0 -0
  30. package/docs/assets/showcase/bambu-cli.png +0 -0
  31. package/docs/assets/showcase/codexmonitor.png +0 -0
  32. package/docs/assets/showcase/gohome-grafana.png +0 -0
  33. package/docs/assets/showcase/ios-testflight.jpg +0 -0
  34. package/docs/assets/showcase/oura-health.png +0 -0
  35. package/docs/assets/showcase/padel-cli.svg +0 -11
  36. package/docs/assets/showcase/padel-screenshot.jpg +0 -0
  37. package/docs/assets/showcase/papla-tts.jpg +0 -0
  38. package/docs/assets/showcase/pr-review-telegram.jpg +0 -0
  39. package/docs/assets/showcase/roborock-screenshot.jpg +0 -0
  40. package/docs/assets/showcase/roborock-status.svg +0 -13
  41. package/docs/assets/showcase/roof-camera-sky.jpg +0 -0
  42. package/docs/assets/showcase/snag.png +0 -0
  43. package/docs/assets/showcase/tesco-shop.jpg +0 -0
  44. package/docs/assets/showcase/wienerlinien.png +0 -0
  45. package/docs/assets/showcase/wine-cellar-skill.jpg +0 -0
  46. package/docs/assets/showcase/winix-air-purifier.jpg +0 -0
  47. package/docs/assets/showcase/xuezh-pronunciation.jpeg +0 -0
  48. package/docs/assets/sponsors/blacksmith.svg +0 -14
  49. package/docs/assets/sponsors/openai.svg +0 -3
  50. package/docs/assets/symi-logo-text-dark.png +0 -0
  51. package/docs/assets/symi-logo-text.png +0 -0
  52. package/docs/automation/auth-monitoring.md +0 -44
  53. package/docs/automation/cron-jobs.md +0 -540
  54. package/docs/automation/cron-vs-heartbeat.md +0 -286
  55. package/docs/automation/gmail-pubsub.md +0 -256
  56. package/docs/automation/hooks.md +0 -998
  57. package/docs/automation/poll.md +0 -61
  58. package/docs/automation/troubleshooting.md +0 -122
  59. package/docs/automation/webhook.md +0 -213
  60. package/docs/brave-search.md +0 -41
  61. package/docs/capabilities.md +0 -151
  62. package/docs/channels/bluebubbles.md +0 -346
  63. package/docs/channels/broadcast-groups.md +0 -441
  64. package/docs/channels/channel-routing.md +0 -112
  65. package/docs/channels/feishu.md +0 -586
  66. package/docs/channels/googlechat.md +0 -253
  67. package/docs/channels/grammy.md +0 -31
  68. package/docs/channels/group-messages.md +0 -82
  69. package/docs/channels/groups.md +0 -364
  70. package/docs/channels/imessage.md +0 -366
  71. package/docs/channels/index.md +0 -46
  72. package/docs/channels/irc.md +0 -234
  73. package/docs/channels/line.md +0 -186
  74. package/docs/channels/location.md +0 -56
  75. package/docs/channels/matrix.md +0 -300
  76. package/docs/channels/mattermost.md +0 -158
  77. package/docs/channels/msteams.md +0 -769
  78. package/docs/channels/nextcloud-talk.md +0 -138
  79. package/docs/channels/nostr.md +0 -233
  80. package/docs/channels/pairing.md +0 -100
  81. package/docs/channels/signal.md +0 -322
  82. package/docs/channels/slack.md +0 -510
  83. package/docs/channels/telegram.md +0 -748
  84. package/docs/channels/tlon.md +0 -148
  85. package/docs/channels/troubleshooting.md +0 -110
  86. package/docs/channels/twitch.md +0 -379
  87. package/docs/channels/whatsapp.md +0 -444
  88. package/docs/channels/zalo.md +0 -192
  89. package/docs/channels/zalouser.md +0 -140
  90. package/docs/ci.md +0 -50
  91. package/docs/cli/acp.md +0 -182
  92. package/docs/cli/agent.md +0 -24
  93. package/docs/cli/agents.md +0 -75
  94. package/docs/cli/approvals.md +0 -50
  95. package/docs/cli/browser.md +0 -107
  96. package/docs/cli/channels.md +0 -73
  97. package/docs/cli/config.md +0 -50
  98. package/docs/cli/configure.md +0 -32
  99. package/docs/cli/cron.md +0 -44
  100. package/docs/cli/dashboard.md +0 -16
  101. package/docs/cli/devices.md +0 -73
  102. package/docs/cli/directory.md +0 -62
  103. package/docs/cli/dns.md +0 -23
  104. package/docs/cli/docs.md +0 -15
  105. package/docs/cli/doctor.md +0 -41
  106. package/docs/cli/gateway.md +0 -202
  107. package/docs/cli/health.md +0 -21
  108. package/docs/cli/hooks.md +0 -313
  109. package/docs/cli/index.md +0 -1029
  110. package/docs/cli/logs.md +0 -28
  111. package/docs/cli/memory.md +0 -45
  112. package/docs/cli/message.md +0 -214
  113. package/docs/cli/models.md +0 -79
  114. package/docs/cli/node.md +0 -112
  115. package/docs/cli/nodes.md +0 -73
  116. package/docs/cli/onboard.md +0 -76
  117. package/docs/cli/pairing.md +0 -21
  118. package/docs/cli/plugins.md +0 -92
  119. package/docs/cli/reset.md +0 -17
  120. package/docs/cli/sandbox.md +0 -152
  121. package/docs/cli/security.md +0 -64
  122. package/docs/cli/sessions.md +0 -16
  123. package/docs/cli/setup.md +0 -29
  124. package/docs/cli/skills.md +0 -26
  125. package/docs/cli/status.md +0 -25
  126. package/docs/cli/system.md +0 -60
  127. package/docs/cli/tui.md +0 -23
  128. package/docs/cli/uninstall.md +0 -17
  129. package/docs/cli/update.md +0 -98
  130. package/docs/cli/voicecall.md +0 -34
  131. package/docs/cli/webhooks.md +0 -25
  132. package/docs/concepts/agent-loop.md +0 -148
  133. package/docs/concepts/agent-workspace.md +0 -234
  134. package/docs/concepts/agent.md +0 -123
  135. package/docs/concepts/architecture.md +0 -135
  136. package/docs/concepts/compaction.md +0 -61
  137. package/docs/concepts/context.md +0 -161
  138. package/docs/concepts/features.md +0 -51
  139. package/docs/concepts/markdown-formatting.md +0 -128
  140. package/docs/concepts/memory.md +0 -729
  141. package/docs/concepts/messages.md +0 -153
  142. package/docs/concepts/model-failover.md +0 -149
  143. package/docs/concepts/model-providers.md +0 -424
  144. package/docs/concepts/models.md +0 -208
  145. package/docs/concepts/multi-agent.md +0 -521
  146. package/docs/concepts/oauth.md +0 -145
  147. package/docs/concepts/presence.md +0 -102
  148. package/docs/concepts/queue.md +0 -86
  149. package/docs/concepts/retry.md +0 -64
  150. package/docs/concepts/session-pruning.md +0 -123
  151. package/docs/concepts/session-tool.md +0 -213
  152. package/docs/concepts/session.md +0 -199
  153. package/docs/concepts/sessions.md +0 -10
  154. package/docs/concepts/streaming.md +0 -129
  155. package/docs/concepts/system-prompt.md +0 -128
  156. package/docs/concepts/timezone.md +0 -90
  157. package/docs/concepts/typebox.md +0 -289
  158. package/docs/concepts/typing-indicators.md +0 -68
  159. package/docs/concepts/usage-tracking.md +0 -35
  160. package/docs/date-time.md +0 -127
  161. package/docs/debug/node-issue.md +0 -85
  162. package/docs/diagnostics/flags.md +0 -91
  163. package/docs/docs.json +0 -1849
  164. package/docs/experiments/onboarding-config-protocol.md +0 -40
  165. package/docs/experiments/plans/browser-evaluate-cdp-refactor.md +0 -229
  166. package/docs/experiments/plans/cron-add-hardening.md +0 -62
  167. package/docs/experiments/plans/group-policy-hardening.md +0 -40
  168. package/docs/experiments/plans/openresponses-gateway.md +0 -123
  169. package/docs/experiments/plans/pty-process-supervision.md +0 -192
  170. package/docs/experiments/plans/session-binding-channel-agnostic.md +0 -202
  171. package/docs/experiments/plans/thread-bound-subagents.md +0 -281
  172. package/docs/experiments/proposals/model-config.md +0 -36
  173. package/docs/experiments/research/memory.md +0 -228
  174. package/docs/gateway/authentication.md +0 -162
  175. package/docs/gateway/background-process.md +0 -96
  176. package/docs/gateway/bonjour.md +0 -177
  177. package/docs/gateway/bridge-protocol.md +0 -91
  178. package/docs/gateway/cli-backends.md +0 -225
  179. package/docs/gateway/configuration-examples.md +0 -610
  180. package/docs/gateway/configuration-reference.md +0 -2465
  181. package/docs/gateway/configuration.md +0 -488
  182. package/docs/gateway/discovery.md +0 -123
  183. package/docs/gateway/doctor.md +0 -282
  184. package/docs/gateway/gateway-lock.md +0 -34
  185. package/docs/gateway/health.md +0 -35
  186. package/docs/gateway/heartbeat.md +0 -374
  187. package/docs/gateway/index.md +0 -254
  188. package/docs/gateway/local-models.md +0 -150
  189. package/docs/gateway/logging.md +0 -113
  190. package/docs/gateway/multiple-gateways.md +0 -112
  191. package/docs/gateway/network-model.md +0 -20
  192. package/docs/gateway/openai-http-api.md +0 -119
  193. package/docs/gateway/openresponses-http-api.md +0 -333
  194. package/docs/gateway/pairing.md +0 -99
  195. package/docs/gateway/protocol.md +0 -221
  196. package/docs/gateway/remote-gateway-readme.md +0 -158
  197. package/docs/gateway/remote.md +0 -131
  198. package/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md +0 -128
  199. package/docs/gateway/sandboxing.md +0 -203
  200. package/docs/gateway/security/index.md +0 -931
  201. package/docs/gateway/tailscale.md +0 -132
  202. package/docs/gateway/tools-invoke-http-api.md +0 -110
  203. package/docs/gateway/troubleshooting.md +0 -317
  204. package/docs/gateway/trusted-proxy-auth.md +0 -270
  205. package/docs/glass-ui-rendering-invariants.md +0 -451
  206. package/docs/help/debugging.md +0 -162
  207. package/docs/help/environment.md +0 -107
  208. package/docs/help/faq.md +0 -2846
  209. package/docs/help/index.md +0 -21
  210. package/docs/help/scripts.md +0 -28
  211. package/docs/help/testing.md +0 -385
  212. package/docs/help/troubleshooting.md +0 -264
  213. package/docs/images/configure-model-picker-unsearchable.png +0 -0
  214. package/docs/images/feishu-step2-create-app.png +0 -0
  215. package/docs/images/feishu-step3-credentials.png +0 -0
  216. package/docs/images/feishu-step4-permissions.png +0 -0
  217. package/docs/images/feishu-step5-bot-capability.png +0 -0
  218. package/docs/images/feishu-step6-event-subscription.png +0 -0
  219. package/docs/images/groups-flow.svg +0 -52
  220. package/docs/images/mobile-ui-screenshot.png +0 -0
  221. package/docs/index.md +0 -186
  222. package/docs/install/ansible.md +0 -207
  223. package/docs/install/bun.md +0 -59
  224. package/docs/install/development-channels.md +0 -75
  225. package/docs/install/docker.md +0 -583
  226. package/docs/install/exe-dev.md +0 -126
  227. package/docs/install/fly.md +0 -472
  228. package/docs/install/gcp.md +0 -499
  229. package/docs/install/hetzner.md +0 -347
  230. package/docs/install/index.md +0 -218
  231. package/docs/install/installer.md +0 -405
  232. package/docs/install/macos-vm.md +0 -281
  233. package/docs/install/migrating.md +0 -192
  234. package/docs/install/nix.md +0 -98
  235. package/docs/install/node.md +0 -138
  236. package/docs/install/northflank.mdx +0 -49
  237. package/docs/install/podman.md +0 -108
  238. package/docs/install/railway.mdx +0 -95
  239. package/docs/install/render.mdx +0 -158
  240. package/docs/install/uninstall.md +0 -128
  241. package/docs/install/updating.md +0 -231
  242. package/docs/ja-JP/AGENTS.md +0 -37
  243. package/docs/ja-JP/index.md +0 -183
  244. package/docs/ja-JP/start/getting-started.md +0 -125
  245. package/docs/ja-JP/start/wizard.md +0 -77
  246. package/docs/logging.md +0 -350
  247. package/docs/nav-tabs-underline.js +0 -100
  248. package/docs/network.md +0 -54
  249. package/docs/nodes/audio.md +0 -133
  250. package/docs/nodes/camera.md +0 -156
  251. package/docs/nodes/images.md +0 -72
  252. package/docs/nodes/index.md +0 -342
  253. package/docs/nodes/location-command.md +0 -113
  254. package/docs/nodes/media-understanding.md +0 -379
  255. package/docs/nodes/talk.md +0 -90
  256. package/docs/nodes/troubleshooting.md +0 -112
  257. package/docs/nodes/voicewake.md +0 -65
  258. package/docs/perplexity.md +0 -80
  259. package/docs/phase-6.5-pre-flight-audit.md +0 -268
  260. package/docs/pi-dev.md +0 -70
  261. package/docs/pi.md +0 -610
  262. package/docs/platforms/android.md +0 -151
  263. package/docs/platforms/digitalocean.md +0 -265
  264. package/docs/platforms/index.md +0 -53
  265. package/docs/platforms/ios.md +0 -108
  266. package/docs/platforms/linux.md +0 -94
  267. package/docs/platforms/mac/bundled-gateway.md +0 -73
  268. package/docs/platforms/mac/canvas.md +0 -125
  269. package/docs/platforms/mac/child-process.md +0 -69
  270. package/docs/platforms/mac/dev-setup.md +0 -104
  271. package/docs/platforms/mac/health.md +0 -34
  272. package/docs/platforms/mac/icon.md +0 -31
  273. package/docs/platforms/mac/logging.md +0 -57
  274. package/docs/platforms/mac/menu-bar.md +0 -81
  275. package/docs/platforms/mac/peekaboo.md +0 -65
  276. package/docs/platforms/mac/permissions.md +0 -50
  277. package/docs/platforms/mac/release.md +0 -85
  278. package/docs/platforms/mac/remote.md +0 -84
  279. package/docs/platforms/mac/signing.md +0 -47
  280. package/docs/platforms/mac/skills.md +0 -33
  281. package/docs/platforms/mac/voice-overlay.md +0 -60
  282. package/docs/platforms/mac/voicewake.md +0 -66
  283. package/docs/platforms/mac/webchat.md +0 -43
  284. package/docs/platforms/mac/xpc.md +0 -61
  285. package/docs/platforms/macos.md +0 -204
  286. package/docs/platforms/oracle.md +0 -303
  287. package/docs/platforms/raspberry-pi.md +0 -358
  288. package/docs/platforms/windows.md +0 -159
  289. package/docs/plugins/agent-tools.md +0 -99
  290. package/docs/plugins/community.md +0 -44
  291. package/docs/plugins/manifest.md +0 -71
  292. package/docs/plugins/voice-call.md +0 -322
  293. package/docs/plugins/zalouser.md +0 -81
  294. package/docs/prose.md +0 -134
  295. package/docs/providers/anthropic.md +0 -174
  296. package/docs/providers/bedrock.md +0 -176
  297. package/docs/providers/claude-max-api-proxy.md +0 -148
  298. package/docs/providers/cloudflare-ai-gateway.md +0 -71
  299. package/docs/providers/deepgram.md +0 -93
  300. package/docs/providers/github-copilot.md +0 -72
  301. package/docs/providers/glm.md +0 -33
  302. package/docs/providers/huggingface.md +0 -209
  303. package/docs/providers/index.md +0 -67
  304. package/docs/providers/litellm.md +0 -153
  305. package/docs/providers/minimax.md +0 -208
  306. package/docs/providers/models.md +0 -52
  307. package/docs/providers/moonshot.md +0 -142
  308. package/docs/providers/nvidia.md +0 -55
  309. package/docs/providers/ollama.md +0 -250
  310. package/docs/providers/openai.md +0 -62
  311. package/docs/providers/opencode.md +0 -36
  312. package/docs/providers/openrouter.md +0 -37
  313. package/docs/providers/qianfan.md +0 -38
  314. package/docs/providers/qwen.md +0 -53
  315. package/docs/providers/synthetic.md +0 -99
  316. package/docs/providers/together.md +0 -65
  317. package/docs/providers/venice.md +0 -267
  318. package/docs/providers/vercel-ai-gateway.md +0 -50
  319. package/docs/providers/vllm.md +0 -92
  320. package/docs/providers/xiaomi.md +0 -64
  321. package/docs/providers/zai.md +0 -38
  322. package/docs/refactor/exec-host.md +0 -316
  323. package/docs/refactor/outbound-session-mirroring.md +0 -83
  324. package/docs/refactor/plugin-sdk.md +0 -214
  325. package/docs/refactor/strict-config.md +0 -93
  326. package/docs/refactor/syminet.md +0 -417
  327. package/docs/reference/AGENTS.default.md +0 -123
  328. package/docs/reference/RELEASING.md +0 -120
  329. package/docs/reference/api-usage-costs.md +0 -138
  330. package/docs/reference/credits.md +0 -28
  331. package/docs/reference/device-models.md +0 -47
  332. package/docs/reference/rpc.md +0 -43
  333. package/docs/reference/session-management-compaction.md +0 -284
  334. package/docs/reference/test.md +0 -51
  335. package/docs/reference/token-use.md +0 -136
  336. package/docs/reference/transcript-hygiene.md +0 -151
  337. package/docs/reference/wizard.md +0 -265
  338. package/docs/security/CONTRIBUTING-THREAT-MODEL.md +0 -89
  339. package/docs/security/README.md +0 -16
  340. package/docs/security/THREAT-MODEL-ATLAS.md +0 -600
  341. package/docs/security/formal-verification.md +0 -164
  342. package/docs/start/bootstrapping.md +0 -41
  343. package/docs/start/docs-directory.md +0 -63
  344. package/docs/start/getting-started.md +0 -135
  345. package/docs/start/hubs.md +0 -196
  346. package/docs/start/lore.md +0 -216
  347. package/docs/start/onboarding-overview.md +0 -51
  348. package/docs/start/onboarding.md +0 -81
  349. package/docs/start/quickstart.md +0 -22
  350. package/docs/start/setup.md +0 -160
  351. package/docs/start/showcase.md +0 -414
  352. package/docs/start/symi.md +0 -211
  353. package/docs/start/wizard-cli-automation.md +0 -158
  354. package/docs/start/wizard-cli-reference.md +0 -255
  355. package/docs/start/wizard.md +0 -109
  356. package/docs/style.css +0 -37
  357. package/docs/tools/agent-send.md +0 -52
  358. package/docs/tools/apply-patch.md +0 -51
  359. package/docs/tools/browser-linux-troubleshooting.md +0 -139
  360. package/docs/tools/browser-login.md +0 -67
  361. package/docs/tools/browser.md +0 -587
  362. package/docs/tools/chrome-extension.md +0 -183
  363. package/docs/tools/creating-skills.md +0 -54
  364. package/docs/tools/elevated.md +0 -55
  365. package/docs/tools/exec-approvals.md +0 -261
  366. package/docs/tools/exec.md +0 -184
  367. package/docs/tools/firecrawl.md +0 -61
  368. package/docs/tools/index.md +0 -540
  369. package/docs/tools/llm-task.md +0 -115
  370. package/docs/tools/loop-detection.md +0 -98
  371. package/docs/tools/multi-agent-sandbox-tools.md +0 -396
  372. package/docs/tools/pipeline.md +0 -340
  373. package/docs/tools/plugin.md +0 -687
  374. package/docs/tools/reactions.md +0 -21
  375. package/docs/tools/skills-config.md +0 -76
  376. package/docs/tools/skills.md +0 -300
  377. package/docs/tools/slash-commands.md +0 -202
  378. package/docs/tools/subagents.md +0 -232
  379. package/docs/tools/symihub.md +0 -256
  380. package/docs/tools/thinking.md +0 -75
  381. package/docs/tools/web.md +0 -265
  382. package/docs/tts.md +0 -398
  383. package/docs/vps.md +0 -43
  384. package/docs/web/control-ui.md +0 -247
  385. package/docs/web/dashboard.md +0 -46
  386. package/docs/web/index.md +0 -118
  387. package/docs/web/tui.md +0 -162
  388. package/docs/web/webchat.md +0 -53
  389. package/docs/whatsapp-symi-ai-zh.jpg +0 -0
  390. package/docs/whatsapp-symi.jpg +0 -0
  391. package/docs/zh-CN/AGENTS.md +0 -59
  392. package/docs/zh-CN/automation/auth-monitoring.md +0 -47
  393. package/docs/zh-CN/automation/cron-jobs.md +0 -422
  394. package/docs/zh-CN/automation/cron-vs-heartbeat.md +0 -286
  395. package/docs/zh-CN/automation/gmail-pubsub.md +0 -249
  396. package/docs/zh-CN/automation/hooks.md +0 -881
  397. package/docs/zh-CN/automation/poll.md +0 -68
  398. package/docs/zh-CN/automation/troubleshooting.md +0 -8
  399. package/docs/zh-CN/automation/webhook.md +0 -161
  400. package/docs/zh-CN/brave-search.md +0 -48
  401. package/docs/zh-CN/channels/bluebubbles.md +0 -271
  402. package/docs/zh-CN/channels/broadcast-groups.md +0 -448
  403. package/docs/zh-CN/channels/channel-routing.md +0 -112
  404. package/docs/zh-CN/channels/feishu.md +0 -629
  405. package/docs/zh-CN/channels/googlechat.md +0 -257
  406. package/docs/zh-CN/channels/grammy.md +0 -38
  407. package/docs/zh-CN/channels/group-messages.md +0 -89
  408. package/docs/zh-CN/channels/groups.md +0 -369
  409. package/docs/zh-CN/channels/imessage.md +0 -300
  410. package/docs/zh-CN/channels/index.md +0 -52
  411. package/docs/zh-CN/channels/line.md +0 -180
  412. package/docs/zh-CN/channels/location.md +0 -63
  413. package/docs/zh-CN/channels/matrix.md +0 -221
  414. package/docs/zh-CN/channels/mattermost.md +0 -144
  415. package/docs/zh-CN/channels/msteams.md +0 -773
  416. package/docs/zh-CN/channels/nextcloud-talk.md +0 -142
  417. package/docs/zh-CN/channels/nostr.md +0 -240
  418. package/docs/zh-CN/channels/pairing.md +0 -86
  419. package/docs/zh-CN/channels/signal.md +0 -207
  420. package/docs/zh-CN/channels/slack.md +0 -529
  421. package/docs/zh-CN/channels/telegram.md +0 -748
  422. package/docs/zh-CN/channels/tlon.md +0 -136
  423. package/docs/zh-CN/channels/troubleshooting.md +0 -34
  424. package/docs/zh-CN/channels/twitch.md +0 -385
  425. package/docs/zh-CN/channels/whatsapp.md +0 -411
  426. package/docs/zh-CN/channels/zalo.md +0 -196
  427. package/docs/zh-CN/channels/zalouser.md +0 -147
  428. package/docs/zh-CN/cli/acp.md +0 -173
  429. package/docs/zh-CN/cli/agent.md +0 -30
  430. package/docs/zh-CN/cli/agents.md +0 -82
  431. package/docs/zh-CN/cli/approvals.md +0 -57
  432. package/docs/zh-CN/cli/browser.md +0 -114
  433. package/docs/zh-CN/cli/channels.md +0 -80
  434. package/docs/zh-CN/cli/config.md +0 -57
  435. package/docs/zh-CN/cli/configure.md +0 -37
  436. package/docs/zh-CN/cli/cron.md +0 -43
  437. package/docs/zh-CN/cli/dashboard.md +0 -23
  438. package/docs/zh-CN/cli/devices.md +0 -74
  439. package/docs/zh-CN/cli/directory.md +0 -69
  440. package/docs/zh-CN/cli/dns.md +0 -30
  441. package/docs/zh-CN/cli/docs.md +0 -22
  442. package/docs/zh-CN/cli/doctor.md +0 -48
  443. package/docs/zh-CN/cli/gateway.md +0 -206
  444. package/docs/zh-CN/cli/health.md +0 -28
  445. package/docs/zh-CN/cli/hooks.md +0 -298
  446. package/docs/zh-CN/cli/index.md +0 -1025
  447. package/docs/zh-CN/cli/logs.md +0 -31
  448. package/docs/zh-CN/cli/memory.md +0 -52
  449. package/docs/zh-CN/cli/message.md +0 -205
  450. package/docs/zh-CN/cli/models.md +0 -85
  451. package/docs/zh-CN/cli/node.md +0 -115
  452. package/docs/zh-CN/cli/nodes.md +0 -80
  453. package/docs/zh-CN/cli/onboard.md +0 -36
  454. package/docs/zh-CN/cli/pairing.md +0 -28
  455. package/docs/zh-CN/cli/plugins.md +0 -66
  456. package/docs/zh-CN/cli/reset.md +0 -24
  457. package/docs/zh-CN/cli/sandbox.md +0 -158
  458. package/docs/zh-CN/cli/security.md +0 -33
  459. package/docs/zh-CN/cli/sessions.md +0 -23
  460. package/docs/zh-CN/cli/setup.md +0 -36
  461. package/docs/zh-CN/cli/skills.md +0 -33
  462. package/docs/zh-CN/cli/status.md +0 -32
  463. package/docs/zh-CN/cli/system.md +0 -63
  464. package/docs/zh-CN/cli/tui.md +0 -30
  465. package/docs/zh-CN/cli/uninstall.md +0 -24
  466. package/docs/zh-CN/cli/update.md +0 -101
  467. package/docs/zh-CN/cli/voicecall.md +0 -41
  468. package/docs/zh-CN/cli/webhooks.md +0 -32
  469. package/docs/zh-CN/concepts/agent-loop.md +0 -146
  470. package/docs/zh-CN/concepts/agent-workspace.md +0 -219
  471. package/docs/zh-CN/concepts/agent.md +0 -115
  472. package/docs/zh-CN/concepts/architecture.md +0 -122
  473. package/docs/zh-CN/concepts/compaction.md +0 -67
  474. package/docs/zh-CN/concepts/context.md +0 -168
  475. package/docs/zh-CN/concepts/features.md +0 -57
  476. package/docs/zh-CN/concepts/markdown-formatting.md +0 -115
  477. package/docs/zh-CN/concepts/memory.md +0 -412
  478. package/docs/zh-CN/concepts/messages.md +0 -140
  479. package/docs/zh-CN/concepts/model-failover.md +0 -145
  480. package/docs/zh-CN/concepts/model-providers.md +0 -320
  481. package/docs/zh-CN/concepts/models.md +0 -196
  482. package/docs/zh-CN/concepts/multi-agent.md +0 -371
  483. package/docs/zh-CN/concepts/oauth.md +0 -151
  484. package/docs/zh-CN/concepts/presence.md +0 -99
  485. package/docs/zh-CN/concepts/queue.md +0 -91
  486. package/docs/zh-CN/concepts/retry.md +0 -71
  487. package/docs/zh-CN/concepts/session-pruning.md +0 -129
  488. package/docs/zh-CN/concepts/session-tool.md +0 -198
  489. package/docs/zh-CN/concepts/session.md +0 -158
  490. package/docs/zh-CN/concepts/sessions.md +0 -17
  491. package/docs/zh-CN/concepts/streaming.md +0 -131
  492. package/docs/zh-CN/concepts/system-prompt.md +0 -99
  493. package/docs/zh-CN/concepts/timezone.md +0 -94
  494. package/docs/zh-CN/concepts/typebox.md +0 -284
  495. package/docs/zh-CN/concepts/typing-indicators.md +0 -74
  496. package/docs/zh-CN/concepts/usage-tracking.md +0 -42
  497. package/docs/zh-CN/date-time.md +0 -128
  498. package/docs/zh-CN/debug/node-issue.md +0 -90
  499. package/docs/zh-CN/diagnostics/flags.md +0 -98
  500. package/docs/zh-CN/experiments/onboarding-config-protocol.md +0 -47
  501. package/docs/zh-CN/experiments/plans/cron-add-hardening.md +0 -69
  502. package/docs/zh-CN/experiments/plans/group-policy-hardening.md +0 -45
  503. package/docs/zh-CN/experiments/plans/openresponses-gateway.md +0 -121
  504. package/docs/zh-CN/experiments/proposals/model-config.md +0 -42
  505. package/docs/zh-CN/experiments/research/memory.md +0 -235
  506. package/docs/zh-CN/gateway/authentication.md +0 -142
  507. package/docs/zh-CN/gateway/background-process.md +0 -100
  508. package/docs/zh-CN/gateway/bonjour.md +0 -174
  509. package/docs/zh-CN/gateway/bridge-protocol.md +0 -86
  510. package/docs/zh-CN/gateway/cli-backends.md +0 -213
  511. package/docs/zh-CN/gateway/configuration-examples.md +0 -580
  512. package/docs/zh-CN/gateway/configuration.md +0 -3284
  513. package/docs/zh-CN/gateway/discovery.md +0 -123
  514. package/docs/zh-CN/gateway/doctor.md +0 -238
  515. package/docs/zh-CN/gateway/gateway-lock.md +0 -41
  516. package/docs/zh-CN/gateway/health.md +0 -42
  517. package/docs/zh-CN/gateway/heartbeat.md +0 -272
  518. package/docs/zh-CN/gateway/index.md +0 -335
  519. package/docs/zh-CN/gateway/local-models.md +0 -157
  520. package/docs/zh-CN/gateway/logging.md +0 -114
  521. package/docs/zh-CN/gateway/multiple-gateways.md +0 -119
  522. package/docs/zh-CN/gateway/network-model.md +0 -23
  523. package/docs/zh-CN/gateway/openai-http-api.md +0 -125
  524. package/docs/zh-CN/gateway/openresponses-http-api.md +0 -317
  525. package/docs/zh-CN/gateway/pairing.md +0 -99
  526. package/docs/zh-CN/gateway/protocol.md +0 -220
  527. package/docs/zh-CN/gateway/remote-gateway-readme.md +0 -164
  528. package/docs/zh-CN/gateway/remote.md +0 -133
  529. package/docs/zh-CN/gateway/sandbox-vs-tool-policy-vs-elevated.md +0 -135
  530. package/docs/zh-CN/gateway/sandboxing.md +0 -188
  531. package/docs/zh-CN/gateway/security/index.md +0 -772
  532. package/docs/zh-CN/gateway/tailscale.md +0 -124
  533. package/docs/zh-CN/gateway/tools-invoke-http-api.md +0 -92
  534. package/docs/zh-CN/gateway/troubleshooting.md +0 -758
  535. package/docs/zh-CN/help/debugging.md +0 -160
  536. package/docs/zh-CN/help/environment.md +0 -88
  537. package/docs/zh-CN/help/faq.md +0 -2613
  538. package/docs/zh-CN/help/index.md +0 -28
  539. package/docs/zh-CN/help/scripts.md +0 -35
  540. package/docs/zh-CN/help/testing.md +0 -375
  541. package/docs/zh-CN/help/troubleshooting.md +0 -104
  542. package/docs/zh-CN/index.md +0 -183
  543. package/docs/zh-CN/install/ansible.md +0 -214
  544. package/docs/zh-CN/install/bun.md +0 -65
  545. package/docs/zh-CN/install/development-channels.md +0 -81
  546. package/docs/zh-CN/install/docker.md +0 -525
  547. package/docs/zh-CN/install/exe-dev.md +0 -127
  548. package/docs/zh-CN/install/fly.md +0 -476
  549. package/docs/zh-CN/install/gcp.md +0 -509
  550. package/docs/zh-CN/install/hetzner.md +0 -336
  551. package/docs/zh-CN/install/index.md +0 -193
  552. package/docs/zh-CN/install/installer.md +0 -128
  553. package/docs/zh-CN/install/macos-vm.md +0 -288
  554. package/docs/zh-CN/install/migrating.md +0 -199
  555. package/docs/zh-CN/install/nix.md +0 -99
  556. package/docs/zh-CN/install/node.md +0 -8
  557. package/docs/zh-CN/install/northflank.mdx +0 -56
  558. package/docs/zh-CN/install/railway.mdx +0 -102
  559. package/docs/zh-CN/install/render.mdx +0 -168
  560. package/docs/zh-CN/install/uninstall.md +0 -135
  561. package/docs/zh-CN/install/updating.md +0 -233
  562. package/docs/zh-CN/logging.md +0 -329
  563. package/docs/zh-CN/network.md +0 -59
  564. package/docs/zh-CN/nodes/audio.md +0 -120
  565. package/docs/zh-CN/nodes/camera.md +0 -162
  566. package/docs/zh-CN/nodes/images.md +0 -79
  567. package/docs/zh-CN/nodes/index.md +0 -348
  568. package/docs/zh-CN/nodes/location-command.md +0 -120
  569. package/docs/zh-CN/nodes/media-understanding.md +0 -380
  570. package/docs/zh-CN/nodes/talk.md +0 -97
  571. package/docs/zh-CN/nodes/troubleshooting.md +0 -8
  572. package/docs/zh-CN/nodes/voicewake.md +0 -72
  573. package/docs/zh-CN/perplexity.md +0 -84
  574. package/docs/zh-CN/pi-dev.md +0 -77
  575. package/docs/zh-CN/pi.md +0 -617
  576. package/docs/zh-CN/platforms/android.md +0 -155
  577. package/docs/zh-CN/platforms/digitalocean.md +0 -268
  578. package/docs/zh-CN/platforms/index.md +0 -60
  579. package/docs/zh-CN/platforms/ios.md +0 -114
  580. package/docs/zh-CN/platforms/linux.md +0 -101
  581. package/docs/zh-CN/platforms/mac/bundled-gateway.md +0 -75
  582. package/docs/zh-CN/platforms/mac/canvas.md +0 -128
  583. package/docs/zh-CN/platforms/mac/child-process.md +0 -73
  584. package/docs/zh-CN/platforms/mac/dev-setup.md +0 -109
  585. package/docs/zh-CN/platforms/mac/health.md +0 -41
  586. package/docs/zh-CN/platforms/mac/icon.md +0 -38
  587. package/docs/zh-CN/platforms/mac/logging.md +0 -64
  588. package/docs/zh-CN/platforms/mac/menu-bar.md +0 -88
  589. package/docs/zh-CN/platforms/mac/peekaboo.md +0 -62
  590. package/docs/zh-CN/platforms/mac/permissions.md +0 -46
  591. package/docs/zh-CN/platforms/mac/release.md +0 -92
  592. package/docs/zh-CN/platforms/mac/remote.md +0 -90
  593. package/docs/zh-CN/platforms/mac/signing.md +0 -54
  594. package/docs/zh-CN/platforms/mac/skills.md +0 -40
  595. package/docs/zh-CN/platforms/mac/voice-overlay.md +0 -67
  596. package/docs/zh-CN/platforms/mac/voicewake.md +0 -73
  597. package/docs/zh-CN/platforms/mac/webchat.md +0 -43
  598. package/docs/zh-CN/platforms/mac/xpc.md +0 -68
  599. package/docs/zh-CN/platforms/macos.md +0 -193
  600. package/docs/zh-CN/platforms/oracle.md +0 -310
  601. package/docs/zh-CN/platforms/raspberry-pi.md +0 -365
  602. package/docs/zh-CN/platforms/windows.md +0 -156
  603. package/docs/zh-CN/plugins/agent-tools.md +0 -99
  604. package/docs/zh-CN/plugins/manifest.md +0 -68
  605. package/docs/zh-CN/plugins/voice-call.md +0 -250
  606. package/docs/zh-CN/plugins/zalouser.md +0 -88
  607. package/docs/zh-CN/prose.md +0 -141
  608. package/docs/zh-CN/providers/anthropic.md +0 -159
  609. package/docs/zh-CN/providers/bedrock.md +0 -170
  610. package/docs/zh-CN/providers/claude-max-api-proxy.md +0 -155
  611. package/docs/zh-CN/providers/deepgram.md +0 -97
  612. package/docs/zh-CN/providers/github-copilot.md +0 -67
  613. package/docs/zh-CN/providers/glm.md +0 -39
  614. package/docs/zh-CN/providers/index.md +0 -66
  615. package/docs/zh-CN/providers/minimax.md +0 -206
  616. package/docs/zh-CN/providers/models.md +0 -55
  617. package/docs/zh-CN/providers/moonshot.md +0 -145
  618. package/docs/zh-CN/providers/ollama.md +0 -230
  619. package/docs/zh-CN/providers/openai.md +0 -68
  620. package/docs/zh-CN/providers/opencode.md +0 -41
  621. package/docs/zh-CN/providers/openrouter.md +0 -43
  622. package/docs/zh-CN/providers/qianfan.md +0 -8
  623. package/docs/zh-CN/providers/qwen.md +0 -55
  624. package/docs/zh-CN/providers/synthetic.md +0 -102
  625. package/docs/zh-CN/providers/venice.md +0 -274
  626. package/docs/zh-CN/providers/vercel-ai-gateway.md +0 -57
  627. package/docs/zh-CN/providers/xiaomi.md +0 -68
  628. package/docs/zh-CN/providers/zai.md +0 -41
  629. package/docs/zh-CN/refactor/exec-host.md +0 -323
  630. package/docs/zh-CN/refactor/outbound-session-mirroring.md +0 -90
  631. package/docs/zh-CN/refactor/plugin-sdk.md +0 -221
  632. package/docs/zh-CN/refactor/strict-config.md +0 -100
  633. package/docs/zh-CN/refactor/syminet.md +0 -424
  634. package/docs/zh-CN/reference/AGENTS.default.md +0 -130
  635. package/docs/zh-CN/reference/RELEASING.md +0 -122
  636. package/docs/zh-CN/reference/api-usage-costs.md +0 -136
  637. package/docs/zh-CN/reference/credits.md +0 -34
  638. package/docs/zh-CN/reference/device-models.md +0 -54
  639. package/docs/zh-CN/reference/rpc.md +0 -48
  640. package/docs/zh-CN/reference/session-management-compaction.md +0 -286
  641. package/docs/zh-CN/reference/templates/AGENTS.dev.md +0 -89
  642. package/docs/zh-CN/reference/templates/AGENTS.md +0 -234
  643. package/docs/zh-CN/reference/templates/BOOT.md +0 -17
  644. package/docs/zh-CN/reference/templates/BOOTSTRAP.md +0 -68
  645. package/docs/zh-CN/reference/templates/IDENTITY.dev.md +0 -54
  646. package/docs/zh-CN/reference/templates/IDENTITY.md +0 -36
  647. package/docs/zh-CN/reference/templates/SYMICORE.dev.md +0 -83
  648. package/docs/zh-CN/reference/templates/SYMICORE.md +0 -49
  649. package/docs/zh-CN/reference/templates/SYMIPULSE.md +0 -69
  650. package/docs/zh-CN/reference/templates/TOOLS.dev.md +0 -31
  651. package/docs/zh-CN/reference/templates/TOOLS.md +0 -53
  652. package/docs/zh-CN/reference/templates/USER.dev.md +0 -25
  653. package/docs/zh-CN/reference/templates/USER.md +0 -30
  654. package/docs/zh-CN/reference/test.md +0 -57
  655. package/docs/zh-CN/reference/token-use.md +0 -119
  656. package/docs/zh-CN/reference/transcript-hygiene.md +0 -109
  657. package/docs/zh-CN/reference/wizard.md +0 -9
  658. package/docs/zh-CN/security/formal-verification.md +0 -171
  659. package/docs/zh-CN/start/bootstrapping.md +0 -9
  660. package/docs/zh-CN/start/docs-directory.md +0 -69
  661. package/docs/zh-CN/start/getting-started.md +0 -201
  662. package/docs/zh-CN/start/hubs.md +0 -199
  663. package/docs/zh-CN/start/lore.md +0 -223
  664. package/docs/zh-CN/start/onboarding.md +0 -105
  665. package/docs/zh-CN/start/quickstart.md +0 -88
  666. package/docs/zh-CN/start/setup.md +0 -151
  667. package/docs/zh-CN/start/showcase.md +0 -421
  668. package/docs/zh-CN/start/symi.md +0 -244
  669. package/docs/zh-CN/start/wizard.md +0 -326
  670. package/docs/zh-CN/tools/agent-send.md +0 -58
  671. package/docs/zh-CN/tools/apply-patch.md +0 -57
  672. package/docs/zh-CN/tools/browser-linux-troubleshooting.md +0 -144
  673. package/docs/zh-CN/tools/browser-login.md +0 -75
  674. package/docs/zh-CN/tools/browser.md +0 -553
  675. package/docs/zh-CN/tools/chrome-extension.md +0 -183
  676. package/docs/zh-CN/tools/creating-skills.md +0 -61
  677. package/docs/zh-CN/tools/elevated.md +0 -62
  678. package/docs/zh-CN/tools/exec-approvals.md +0 -233
  679. package/docs/zh-CN/tools/exec.md +0 -169
  680. package/docs/zh-CN/tools/firecrawl.md +0 -68
  681. package/docs/zh-CN/tools/index.md +0 -508
  682. package/docs/zh-CN/tools/llm-task.md +0 -117
  683. package/docs/zh-CN/tools/multi-agent-sandbox-tools.md +0 -400
  684. package/docs/zh-CN/tools/pipeline.md +0 -349
  685. package/docs/zh-CN/tools/plugin.md +0 -639
  686. package/docs/zh-CN/tools/reactions.md +0 -28
  687. package/docs/zh-CN/tools/skills-config.md +0 -78
  688. package/docs/zh-CN/tools/skills.md +0 -279
  689. package/docs/zh-CN/tools/slash-commands.md +0 -196
  690. package/docs/zh-CN/tools/subagents.md +0 -167
  691. package/docs/zh-CN/tools/symihub.md +0 -209
  692. package/docs/zh-CN/tools/thinking.md +0 -80
  693. package/docs/zh-CN/tools/web.md +0 -257
  694. package/docs/zh-CN/tts.md +0 -373
  695. package/docs/zh-CN/vps.md +0 -47
  696. package/docs/zh-CN/web/control-ui.md +0 -190
  697. package/docs/zh-CN/web/dashboard.md +0 -53
  698. package/docs/zh-CN/web/index.md +0 -118
  699. package/docs/zh-CN/web/tui.md +0 -166
  700. package/docs/zh-CN/web/webchat.md +0 -56
  701. package/extensions/imessage/index.ts +0 -17
  702. package/extensions/imessage/node_modules/.bin/symi +0 -21
  703. package/extensions/imessage/package.json +0 -15
  704. package/extensions/imessage/src/channel.outbound.test.ts +0 -66
  705. package/extensions/imessage/src/channel.ts +0 -298
  706. package/extensions/imessage/src/runtime.ts +0 -14
  707. package/extensions/imessage/symi.plugin.json +0 -9
  708. package/extensions/line/index.ts +0 -19
  709. package/extensions/line/node_modules/.bin/symi +0 -21
  710. package/extensions/line/package.json +0 -30
  711. package/extensions/line/src/card-command.ts +0 -344
  712. package/extensions/line/src/channel.logout.test.ts +0 -133
  713. package/extensions/line/src/channel.sendPayload.test.ts +0 -312
  714. package/extensions/line/src/channel.startup.test.ts +0 -133
  715. package/extensions/line/src/channel.ts +0 -801
  716. package/extensions/line/src/runtime.ts +0 -14
  717. package/extensions/line/symi.plugin.json +0 -9
  718. package/extensions/signal/index.ts +0 -17
  719. package/extensions/signal/node_modules/.bin/symi +0 -21
  720. package/extensions/signal/package.json +0 -15
  721. package/extensions/signal/src/channel.ts +0 -302
  722. package/extensions/signal/src/runtime.ts +0 -14
  723. package/extensions/signal/symi.plugin.json +0 -9
  724. package/extensions/telegram/index.ts +0 -17
  725. package/extensions/telegram/node_modules/.bin/symi +0 -21
  726. package/extensions/telegram/package.json +0 -15
  727. package/extensions/telegram/src/channel.test.ts +0 -125
  728. package/extensions/telegram/src/channel.ts +0 -560
  729. package/extensions/telegram/src/runtime.ts +0 -14
  730. package/extensions/telegram/symi.plugin.json +0 -9
  731. package/extensions/whatsapp/index.ts +0 -17
  732. package/extensions/whatsapp/node_modules/.bin/symi +0 -21
  733. package/extensions/whatsapp/package.json +0 -15
  734. package/extensions/whatsapp/src/channel.ts +0 -465
  735. package/extensions/whatsapp/src/resolve-target.test.ts +0 -170
  736. package/extensions/whatsapp/src/runtime.ts +0 -14
  737. package/extensions/whatsapp/symi.plugin.json +0 -9
@@ -1,158 +0,0 @@
1
- ---
2
- summary: "Scripted onboarding and agent setup for the Symi CLI"
3
- read_when:
4
- - You are automating onboarding in scripts or CI
5
- - You need non-interactive examples for specific providers
6
- title: "CLI Automation"
7
- sidebarTitle: "CLI automation"
8
- ---
9
-
10
- # CLI Automation
11
-
12
- Use `--non-interactive` to automate `symi onboard`.
13
-
14
- <Note>
15
- `--json` does not imply non-interactive mode. Use `--non-interactive` (and `--workspace`) for scripts.
16
- </Note>
17
-
18
- ## Baseline non-interactive example
19
-
20
- ```bash
21
- symi onboard --non-interactive \
22
- --mode local \
23
- --auth-choice apiKey \
24
- --anthropic-api-key "$ANTHROPIC_API_KEY" \
25
- --gateway-port 18789 \
26
- --gateway-bind loopback \
27
- --install-daemon \
28
- --daemon-runtime node \
29
- --skip-skills
30
- ```
31
-
32
- Add `--json` for a machine-readable summary.
33
-
34
- ## Provider-specific examples
35
-
36
- <AccordionGroup>
37
- <Accordion title="Gemini example">
38
- ```bash
39
- symi onboard --non-interactive \
40
- --mode local \
41
- --auth-choice gemini-api-key \
42
- --gemini-api-key "$GEMINI_API_KEY" \
43
- --gateway-port 18789 \
44
- --gateway-bind loopback
45
- ```
46
- </Accordion>
47
- <Accordion title="Z.AI example">
48
- ```bash
49
- symi onboard --non-interactive \
50
- --mode local \
51
- --auth-choice zai-api-key \
52
- --zai-api-key "$ZAI_API_KEY" \
53
- --gateway-port 18789 \
54
- --gateway-bind loopback
55
- ```
56
- </Accordion>
57
- <Accordion title="Vercel AI Gateway example">
58
- ```bash
59
- symi onboard --non-interactive \
60
- --mode local \
61
- --auth-choice ai-gateway-api-key \
62
- --ai-gateway-api-key "$AI_GATEWAY_API_KEY" \
63
- --gateway-port 18789 \
64
- --gateway-bind loopback
65
- ```
66
- </Accordion>
67
- <Accordion title="Cloudflare AI Gateway example">
68
- ```bash
69
- symi onboard --non-interactive \
70
- --mode local \
71
- --auth-choice cloudflare-ai-gateway-api-key \
72
- --cloudflare-ai-gateway-account-id "your-account-id" \
73
- --cloudflare-ai-gateway-gateway-id "your-gateway-id" \
74
- --cloudflare-ai-gateway-api-key "$CLOUDFLARE_AI_GATEWAY_API_KEY" \
75
- --gateway-port 18789 \
76
- --gateway-bind loopback
77
- ```
78
- </Accordion>
79
- <Accordion title="Moonshot example">
80
- ```bash
81
- symi onboard --non-interactive \
82
- --mode local \
83
- --auth-choice moonshot-api-key \
84
- --moonshot-api-key "$MOONSHOT_API_KEY" \
85
- --gateway-port 18789 \
86
- --gateway-bind loopback
87
- ```
88
- </Accordion>
89
- <Accordion title="Synthetic example">
90
- ```bash
91
- symi onboard --non-interactive \
92
- --mode local \
93
- --auth-choice synthetic-api-key \
94
- --synthetic-api-key "$SYNTHETIC_API_KEY" \
95
- --gateway-port 18789 \
96
- --gateway-bind loopback
97
- ```
98
- </Accordion>
99
- <Accordion title="OpenCode Zen example">
100
- ```bash
101
- symi onboard --non-interactive \
102
- --mode local \
103
- --auth-choice opencode-zen \
104
- --opencode-zen-api-key "$OPENCODE_API_KEY" \
105
- --gateway-port 18789 \
106
- --gateway-bind loopback
107
- ```
108
- </Accordion>
109
- <Accordion title="Custom provider example">
110
- ```bash
111
- symi onboard --non-interactive \
112
- --mode local \
113
- --auth-choice custom-api-key \
114
- --custom-base-url "https://llm.example.com/v1" \
115
- --custom-model-id "foo-large" \
116
- --custom-api-key "$CUSTOM_API_KEY" \
117
- --custom-provider-id "my-custom" \
118
- --custom-compatibility anthropic \
119
- --gateway-port 18789 \
120
- --gateway-bind loopback
121
- ```
122
-
123
- `--custom-api-key` is optional. If omitted, onboarding checks `CUSTOM_API_KEY`.
124
-
125
- </Accordion>
126
- </AccordionGroup>
127
-
128
- ## Add another agent
129
-
130
- Use `symi agents add <name>` to create a separate agent with its own workspace,
131
- sessions, and auth profiles. Running without `--workspace` launches the wizard.
132
-
133
- ```bash
134
- symi agents add work \
135
- --workspace ~/.symi/workspace-work \
136
- --model openai/gpt-5.2 \
137
- --bind whatsapp:biz \
138
- --non-interactive \
139
- --json
140
- ```
141
-
142
- What it sets:
143
-
144
- - `agents.list[].name`
145
- - `agents.list[].workspace`
146
- - `agents.list[].agentDir`
147
-
148
- Notes:
149
-
150
- - Default workspaces follow `~/.symi/workspace-<agentId>`.
151
- - Add `bindings` to route inbound messages (the wizard can do this).
152
- - Non-interactive flags: `--model`, `--agent-dir`, `--bind`, `--non-interactive`.
153
-
154
- ## Related docs
155
-
156
- - Onboarding hub: [Onboarding Wizard (CLI)](/start/wizard)
157
- - Full reference: [CLI Onboarding Reference](/start/wizard-cli-reference)
158
- - Command reference: [`symi onboard`](/cli/onboard)
@@ -1,255 +0,0 @@
1
- ---
2
- summary: "Complete reference for CLI onboarding flow, auth/model setup, outputs, and internals"
3
- read_when:
4
- - You need detailed behavior for symi onboard
5
- - You are debugging onboarding results or integrating onboarding clients
6
- title: "CLI Onboarding Reference"
7
- sidebarTitle: "CLI reference"
8
- ---
9
-
10
- # CLI Onboarding Reference
11
-
12
- This page is the full reference for `symi onboard`.
13
- For the short guide, see [Onboarding Wizard (CLI)](/start/wizard).
14
-
15
- ## What the wizard does
16
-
17
- Local mode (default) walks you through:
18
-
19
- - Model and auth setup (OpenAI Code subscription OAuth, Anthropic API key or setup token, plus MiniMax, GLM, Moonshot, and AI Gateway options)
20
- - Workspace location and bootstrap files
21
- - Gateway settings (port, bind, auth, tailscale)
22
- - Daemon install (LaunchAgent or systemd user unit)
23
- - Health check
24
- - Skills setup
25
-
26
- Remote mode configures this machine to connect to a gateway elsewhere.
27
- It does not install or modify anything on the remote host.
28
-
29
- ## Local flow details
30
-
31
- <Steps>
32
- <Step title="Existing config detection">
33
- - If `~/.symi/symi.json` exists, choose Keep, Modify, or Reset.
34
- - Re-running the wizard does not wipe anything unless you explicitly choose Reset (or pass `--reset`).
35
- - If config is invalid or contains legacy keys, the wizard stops and asks you to run `symi doctor` before continuing.
36
- - Reset uses `trash` and offers scopes:
37
- - Config only
38
- - Config + credentials + sessions
39
- - Full reset (also removes workspace)
40
- </Step>
41
- <Step title="Model and auth">
42
- - Full option matrix is in [Auth and model options](#auth-and-model-options).
43
- </Step>
44
- <Step title="Workspace">
45
- - Default `~/.symi/workspace` (configurable).
46
- - Seeds workspace files needed for first-run bootstrap ritual.
47
- - Workspace layout: [Agent workspace](/concepts/agent-workspace).
48
- </Step>
49
- <Step title="Gateway">
50
- - Prompts for port, bind, auth mode, and tailscale exposure.
51
- - Recommended: keep token auth enabled even for loopback so local WS clients must authenticate.
52
- - Disable auth only if you fully trust every local process.
53
- - Non-loopback binds still require auth.
54
- </Step>
55
- <Step title="Channels">
56
- - [WhatsApp](/channels/whatsapp): optional QR login
57
- - [Telegram](/channels/telegram): bot token
58
- - [Google Chat](/channels/googlechat): service account JSON + webhook audience
59
- - [Mattermost](/channels/mattermost) plugin: bot token + base URL
60
- - [Signal](/channels/signal): optional `signal-cli` install + account config
61
- - [BlueBubbles](/channels/bluebubbles): recommended for iMessage; server URL + password + webhook
62
- - [iMessage](/channels/imessage): legacy `imsg` CLI path + DB access
63
- - DM security: default is pairing. First DM sends a code; approve via
64
- `symi pairing approve <channel> <code>` or use allowlists.
65
- </Step>
66
- <Step title="Daemon install">
67
- - macOS: LaunchAgent
68
- - Requires logged-in user session; for headless, use a custom LaunchDaemon (not shipped).
69
- - Linux and Windows via WSL2: systemd user unit
70
- - Wizard attempts `loginctl enable-linger <user>` so gateway stays up after logout.
71
- - May prompt for sudo (writes `/var/lib/systemd/linger`); it tries without sudo first.
72
- - Runtime selection: Node (recommended; required for WhatsApp and Telegram). Bun is not recommended.
73
- </Step>
74
- <Step title="Health check">
75
- - Starts gateway (if needed) and runs `symi health`.
76
- - `symi status --deep` adds gateway health probes to status output.
77
- </Step>
78
- <Step title="Skills">
79
- - Reads available skills and checks requirements.
80
- - Lets you choose node manager: npm or pnpm (bun not recommended).
81
- - Installs optional dependencies (some use Homebrew on macOS).
82
- </Step>
83
- <Step title="Finish">
84
- - Summary and next steps, including iOS, Android, and macOS app options.
85
- </Step>
86
- </Steps>
87
-
88
- <Note>
89
- If no GUI is detected, the wizard prints SSH port-forward instructions for the Control UI instead of opening a browser.
90
- If Control UI assets are missing, the wizard attempts to build them; fallback is `pnpm ui:build` (auto-installs UI deps).
91
- </Note>
92
-
93
- ## Remote mode details
94
-
95
- Remote mode configures this machine to connect to a gateway elsewhere.
96
-
97
- <Info>
98
- Remote mode does not install or modify anything on the remote host.
99
- </Info>
100
-
101
- What you set:
102
-
103
- - Remote gateway URL (`ws://...`)
104
- - Token if remote gateway auth is required (recommended)
105
-
106
- <Note>
107
- - If gateway is loopback-only, use SSH tunneling or a tailnet.
108
- - Discovery hints:
109
- - macOS: Bonjour (`dns-sd`)
110
- - Linux: Avahi (`avahi-browse`)
111
- </Note>
112
-
113
- ## Auth and model options
114
-
115
- <AccordionGroup>
116
- <Accordion title="Anthropic API key (recommended)">
117
- Uses `ANTHROPIC_API_KEY` if present or prompts for a key, then saves it for daemon use.
118
- </Accordion>
119
- <Accordion title="Anthropic OAuth (Claude Code CLI)">
120
- - macOS: checks Keychain item "Claude Code-credentials"
121
- - Linux and Windows: reuses `~/.claude/.credentials.json` if present
122
-
123
- On macOS, choose "Always Allow" so launchd starts do not block.
124
-
125
- </Accordion>
126
- <Accordion title="Anthropic token (setup-token paste)">
127
- Run `claude setup-token` on any machine, then paste the token.
128
- You can name it; blank uses default.
129
- </Accordion>
130
- <Accordion title="OpenAI Code subscription (Codex CLI reuse)">
131
- If `~/.codex/auth.json` exists, the wizard can reuse it.
132
- </Accordion>
133
- <Accordion title="OpenAI Code subscription (OAuth)">
134
- Browser flow; paste `code#state`.
135
-
136
- Sets `agents.defaults.model` to `openai-codex/gpt-5.3-codex` when model is unset or `openai/*`.
137
-
138
- </Accordion>
139
- <Accordion title="OpenAI API key">
140
- Uses `OPENAI_API_KEY` if present or prompts for a key, then saves it to
141
- `~/.symi/.env` so launchd can read it.
142
-
143
- Sets `agents.defaults.model` to `openai/gpt-5.1-codex` when model is unset, `openai/*`, or `openai-codex/*`.
144
-
145
- </Accordion>
146
- <Accordion title="xAI (Grok) API key">
147
- Prompts for `XAI_API_KEY` and configures xAI as a model provider.
148
- </Accordion>
149
- <Accordion title="OpenCode Zen">
150
- Prompts for `OPENCODE_API_KEY` (or `OPENCODE_ZEN_API_KEY`).
151
- Setup URL: [opencode.ai/auth](https://opencode.ai/auth).
152
- </Accordion>
153
- <Accordion title="API key (generic)">
154
- Stores the key for you.
155
- </Accordion>
156
- <Accordion title="Vercel AI Gateway">
157
- Prompts for `AI_GATEWAY_API_KEY`.
158
- More detail: [Vercel AI Gateway](/providers/vercel-ai-gateway).
159
- </Accordion>
160
- <Accordion title="Cloudflare AI Gateway">
161
- Prompts for account ID, gateway ID, and `CLOUDFLARE_AI_GATEWAY_API_KEY`.
162
- More detail: [Cloudflare AI Gateway](/providers/cloudflare-ai-gateway).
163
- </Accordion>
164
- <Accordion title="MiniMax M2.1">
165
- Config is auto-written.
166
- More detail: [MiniMax](/providers/minimax).
167
- </Accordion>
168
- <Accordion title="Synthetic (Anthropic-compatible)">
169
- Prompts for `SYNTHETIC_API_KEY`.
170
- More detail: [Synthetic](/providers/synthetic).
171
- </Accordion>
172
- <Accordion title="Moonshot and Kimi Coding">
173
- Moonshot (Kimi K2) and Kimi Coding configs are auto-written.
174
- More detail: [Moonshot AI (Kimi + Kimi Coding)](/providers/moonshot).
175
- </Accordion>
176
- <Accordion title="Custom provider">
177
- Works with OpenAI-compatible and Anthropic-compatible endpoints.
178
-
179
- Non-interactive flags:
180
- - `--auth-choice custom-api-key`
181
- - `--custom-base-url`
182
- - `--custom-model-id`
183
- - `--custom-api-key` (optional; falls back to `CUSTOM_API_KEY`)
184
- - `--custom-provider-id` (optional)
185
- - `--custom-compatibility <openai|anthropic>` (optional; default `openai`)
186
-
187
- </Accordion>
188
- <Accordion title="Skip">
189
- Leaves auth unconfigured.
190
- </Accordion>
191
- </AccordionGroup>
192
-
193
- Model behavior:
194
-
195
- - Pick default model from detected options, or enter provider and model manually.
196
- - Wizard runs a model check and warns if the configured model is unknown or missing auth.
197
-
198
- Credential and profile paths:
199
-
200
- - OAuth credentials: `~/.symi/credentials/oauth.json`
201
- - Auth profiles (API keys + OAuth): `~/.symi/agents/<agentId>/agent/auth-profiles.json`
202
-
203
- <Note>
204
- Headless and server tip: complete OAuth on a machine with a browser, then copy
205
- `~/.symi/credentials/oauth.json` (or `$SYMI_STATE_DIR/credentials/oauth.json`)
206
- to the gateway host.
207
- </Note>
208
-
209
- ## Outputs and internals
210
-
211
- Typical fields in `~/.symi/symi.json`:
212
-
213
- - `agents.defaults.workspace`
214
- - `agents.defaults.model` / `models.providers` (if Minimax chosen)
215
- - `gateway.*` (mode, bind, auth, tailscale)
216
- - `skills.install.nodeManager`
217
- - `wizard.lastRunAt`
218
- - `wizard.lastRunVersion`
219
- - `wizard.lastRunCommit`
220
- - `wizard.lastRunCommand`
221
- - `wizard.lastRunMode`
222
-
223
- `symi agents add` writes `agents.list[]` and optional `bindings`.
224
-
225
- WhatsApp credentials go under `~/.symi/credentials/whatsapp/<accountId>/`.
226
- Sessions are stored under `~/.symi/agents/<agentId>/sessions/`.
227
-
228
- <Note>
229
- Some channels are delivered as plugins. When selected during onboarding, the wizard
230
- prompts to install the plugin (npm or local path) before channel configuration.
231
- </Note>
232
-
233
- Gateway wizard RPC:
234
-
235
- - `wizard.start`
236
- - `wizard.next`
237
- - `wizard.cancel`
238
- - `wizard.status`
239
-
240
- Clients (macOS app and Control UI) can render steps without re-implementing onboarding logic.
241
-
242
- Signal setup behavior:
243
-
244
- - Downloads the appropriate release asset
245
- - Stores it under `~/.symi/tools/signal-cli/<version>/`
246
- - Writes `channels.signal.cliPath` in config
247
- - JVM builds require Java 21
248
- - Native builds are used when available
249
- - Windows uses WSL2 and follows Linux signal-cli flow inside WSL
250
-
251
- ## Related docs
252
-
253
- - Onboarding hub: [Onboarding Wizard (CLI)](/start/wizard)
254
- - Automation and scripts: [CLI Automation](/start/wizard-cli-automation)
255
- - Command reference: [`symi onboard`](/cli/onboard)
@@ -1,109 +0,0 @@
1
- ---
2
- summary: "CLI onboarding wizard: guided setup for gateway, workspace, channels, and skills"
3
- read_when:
4
- - Running or configuring the onboarding wizard
5
- - Setting up a new machine
6
- title: "Onboarding Wizard (CLI)"
7
- sidebarTitle: "Onboarding: CLI"
8
- ---
9
-
10
- # Onboarding Wizard (CLI)
11
-
12
- The onboarding wizard is the **recommended** way to set up Symi on macOS,
13
- Linux, or Windows (via WSL2; strongly recommended).
14
- It configures a local Gateway or a remote Gateway connection, plus channels, skills,
15
- and workspace defaults in one guided flow.
16
-
17
- ```bash
18
- symi onboard
19
- ```
20
-
21
- <Info>
22
- Fastest first chat: open the Control UI (no channel setup needed). Run
23
- `symi dashboard` and chat in the browser. Docs: [Dashboard](/web/dashboard).
24
- </Info>
25
-
26
- To reconfigure later:
27
-
28
- ```bash
29
- symi configure
30
- symi agents add <name>
31
- ```
32
-
33
- <Note>
34
- `--json` does not imply non-interactive mode. For scripts, use `--non-interactive`.
35
- </Note>
36
-
37
- <Tip>
38
- Recommended: set up a Brave Search API key so the agent can use `web_search`
39
- (`web_fetch` works without a key). Easiest path: `symi configure --section web`
40
- which stores `tools.web.search.apiKey`. Docs: [Web tools](/tools/web).
41
- </Tip>
42
-
43
- ## QuickStart vs Advanced
44
-
45
- The wizard starts with **QuickStart** (defaults) vs **Advanced** (full control).
46
-
47
- <Tabs>
48
- <Tab title="QuickStart (defaults)">
49
- - Local gateway (loopback)
50
- - Workspace default (or existing workspace)
51
- - Gateway port **18789**
52
- - Gateway auth **Token** (auto‑generated, even on loopback)
53
- - Tailscale exposure **Off**
54
- - Telegram + WhatsApp DMs default to **allowlist** (you'll be prompted for your phone number)
55
- </Tab>
56
- <Tab title="Advanced (full control)">
57
- - Exposes every step (mode, workspace, gateway, channels, daemon, skills).
58
- </Tab>
59
- </Tabs>
60
-
61
- ## What the wizard configures
62
-
63
- **Local mode (default)** walks you through these steps:
64
-
65
- 1. **Model/Auth** — Anthropic API key (recommended), OpenAI, or Custom Provider
66
- (OpenAI-compatible, Anthropic-compatible, or Unknown auto-detect). Pick a default model.
67
- 2. **Workspace** — Location for agent files (default `~/.symi/workspace`). Seeds bootstrap files.
68
- 3. **Gateway** — Port, bind address, auth mode, Tailscale exposure.
69
- 4. **Daemon** — Installs a LaunchAgent (macOS) or systemd user unit (Linux/WSL2).
70
- 5. **Health check** — Starts the Gateway and verifies it's running.
71
- 6. **Skills** — Installs recommended skills and optional dependencies.
72
-
73
- <Note>
74
- Re-running the wizard does **not** wipe anything unless you explicitly choose **Reset** (or pass `--reset`).
75
- If the config is invalid or contains legacy keys, the wizard asks you to run `symi doctor` first.
76
- </Note>
77
-
78
- **Remote mode** only configures the local client to connect to a Gateway elsewhere.
79
- It does **not** install or change anything on the remote host.
80
-
81
- ## Add another agent
82
-
83
- Use `symi agents add <name>` to create a separate agent with its own workspace,
84
- sessions, and auth profiles. Running without `--workspace` launches the wizard.
85
-
86
- What it sets:
87
-
88
- - `agents.list[].name`
89
- - `agents.list[].workspace`
90
- - `agents.list[].agentDir`
91
-
92
- Notes:
93
-
94
- - Default workspaces follow `~/.symi/workspace-<agentId>`.
95
- - Add `bindings` to route inbound messages (the wizard can do this).
96
- - Non-interactive flags: `--model`, `--agent-dir`, `--bind`, `--non-interactive`.
97
-
98
- ## Full reference
99
-
100
- For detailed step-by-step breakdowns, non-interactive scripting, Signal setup,
101
- RPC API, and a full list of config fields the wizard writes, see the
102
- [Wizard Reference](/reference/wizard).
103
-
104
- ## Related docs
105
-
106
- - CLI command reference: [`symi onboard`](/cli/onboard)
107
- - Onboarding overview: [Onboarding Overview](/start/onboarding-overview)
108
- - macOS app onboarding: [Onboarding](/start/onboarding)
109
- - Agent first-run ritual: [Agent Bootstrapping](/start/bootstrapping)
package/docs/style.css DELETED
@@ -1,37 +0,0 @@
1
- #content > h1:first-of-type {
2
- display: none !important;
3
- }
4
-
5
- .nav-tabs {
6
- position: relative;
7
- }
8
-
9
- .nav-tabs-item > div {
10
- opacity: 0;
11
- }
12
-
13
- .nav-tabs-underline {
14
- position: absolute;
15
- left: 0;
16
- bottom: 0;
17
- height: 1.5px;
18
- width: var(--nav-tab-underline-width, 0);
19
- transform: translateX(var(--nav-tab-underline-x, 0));
20
- background-color: rgb(var(--primary));
21
- border-radius: 999px;
22
- pointer-events: none;
23
- opacity: 0;
24
- transition:
25
- transform 260ms ease-in-out,
26
- width 260ms ease-in-out,
27
- opacity 160ms ease-in-out;
28
- will-change: transform, width;
29
- }
30
-
31
- html.dark .nav-tabs-underline {
32
- background-color: rgb(var(--primary-light));
33
- }
34
-
35
- .nav-tabs-underline-ready .nav-tabs-underline {
36
- opacity: 1;
37
- }
@@ -1,52 +0,0 @@
1
- ---
2
- summary: "Direct `symi agent` CLI runs (with optional delivery)"
3
- read_when:
4
- - Adding or modifying the agent CLI entrypoint
5
- title: "Agent Send"
6
- ---
7
-
8
- # `symi agent` (direct agent runs)
9
-
10
- `symi agent` runs a single agent turn without needing an inbound chat message.
11
- By default it goes **through the Gateway**; add `--local` to force the embedded
12
- runtime on the current machine.
13
-
14
- ## Behavior
15
-
16
- - Required: `--message <text>`
17
- - Session selection:
18
- - `--to <dest>` derives the session key (group/channel targets preserve isolation; direct chats collapse to `main`), **or**
19
- - `--session-id <id>` reuses an existing session by id, **or**
20
- - `--agent <id>` targets a configured agent directly (uses that agent's `main` session key)
21
- - Runs the same embedded agent runtime as normal inbound replies.
22
- - Thinking/verbose flags persist into the session store.
23
- - Output:
24
- - default: prints reply text (plus `MEDIA:<url>` lines)
25
- - `--json`: prints structured payload + metadata
26
- - Optional delivery back to a channel with `--deliver` + `--channel` (target formats match `symi message --target`).
27
- - Use `--reply-channel`/`--reply-to`/`--reply-account` to override delivery without changing the session.
28
-
29
- If the Gateway is unreachable, the CLI **falls back** to the embedded local run.
30
-
31
- ## Examples
32
-
33
- ```bash
34
- symi agent --to +15555550123 --message "status update"
35
- symi agent --agent ops --message "Summarize logs"
36
- symi agent --session-id 1234 --message "Summarize inbox" --thinking medium
37
- symi agent --to +15555550123 --message "Trace logs" --verbose on --json
38
- symi agent --to +15555550123 --message "Summon reply" --deliver
39
- symi agent --agent ops --message "Generate report" --deliver --reply-channel slack --reply-to "#reports"
40
- ```
41
-
42
- ## Flags
43
-
44
- - `--local`: run locally (requires model provider API keys in your shell)
45
- - `--deliver`: send the reply to the chosen channel
46
- - `--reply-to`: delivery target override
47
- - `--reply-channel`: delivery channel override
48
- - `--reply-account`: delivery account id override
49
- - `--thinking <off|minimal|low|medium|high|xhigh>`: persist thinking level (GPT-5.2 + Codex models only)
50
- - `--verbose <on|full|off>`: persist verbose level
51
- - `--timeout <seconds>`: override agent timeout
52
- - `--json`: output structured JSON
@@ -1,51 +0,0 @@
1
- ---
2
- summary: "Apply multi-file patches with the apply_patch tool"
3
- read_when:
4
- - You need structured file edits across multiple files
5
- - You want to document or debug patch-based edits
6
- title: "apply_patch Tool"
7
- ---
8
-
9
- # apply_patch tool
10
-
11
- Apply file changes using a structured patch format. This is ideal for multi-file
12
- or multi-hunk edits where a single `edit` call would be brittle.
13
-
14
- The tool accepts a single `input` string that wraps one or more file operations:
15
-
16
- ```
17
- *** Begin Patch
18
- *** Add File: path/to/file.txt
19
- +line 1
20
- +line 2
21
- *** Update File: src/app.ts
22
- @@
23
- -old line
24
- +new line
25
- *** Delete File: obsolete.txt
26
- *** End Patch
27
- ```
28
-
29
- ## Parameters
30
-
31
- - `input` (required): Full patch contents including `*** Begin Patch` and `*** End Patch`.
32
-
33
- ## Notes
34
-
35
- - Patch paths support relative paths (from the workspace directory) and absolute paths.
36
- - `tools.exec.applyPatch.workspaceOnly` defaults to `true` (workspace-contained). Set it to `false` only if you intentionally want `apply_patch` to write/delete outside the workspace directory.
37
- - Use `*** Move to:` within an `*** Update File:` hunk to rename files.
38
- - `*** End of File` marks an EOF-only insert when needed.
39
- - Experimental and disabled by default. Enable with `tools.exec.applyPatch.enabled`.
40
- - OpenAI-only (including OpenAI Codex). Optionally gate by model via
41
- `tools.exec.applyPatch.allowModels`.
42
- - Config is only under `tools.exec`.
43
-
44
- ## Example
45
-
46
- ```json
47
- {
48
- "tool": "apply_patch",
49
- "input": "*** Begin Patch\n*** Update File: src/index.ts\n@@\n-const foo = 1\n+const foo = 2\n*** End Patch"
50
- }
51
- ```