opencode-v2 1.1.53
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +27 -0
- package/Dockerfile +18 -0
- package/README.md +15 -0
- package/bin/opencode +84 -0
- package/bunfig.toml +5 -0
- package/package.json +126 -0
- package/parsers-config.ts +253 -0
- package/script/build.ts +193 -0
- package/script/postinstall.mjs +125 -0
- package/script/publish.ts +181 -0
- package/script/schema.ts +47 -0
- package/script/seed-e2e.ts +50 -0
- package/src/acp/README.md +164 -0
- package/src/acp/agent.ts +1676 -0
- package/src/acp/session.ts +117 -0
- package/src/acp/types.ts +23 -0
- package/src/agent/agent.ts +414 -0
- package/src/agent/generate.txt +75 -0
- package/src/agent/prompt/compaction.txt +12 -0
- package/src/agent/prompt/explore.txt +18 -0
- package/src/agent/prompt/summary.txt +11 -0
- package/src/agent/prompt/title.txt +44 -0
- package/src/auth/index.ts +70 -0
- package/src/bun/index.ts +137 -0
- package/src/bun/registry.ts +48 -0
- package/src/bus/bus-event.ts +43 -0
- package/src/bus/global.ts +10 -0
- package/src/bus/index.ts +105 -0
- package/src/cli/bootstrap.ts +17 -0
- package/src/cli/cmd/acp.ts +70 -0
- package/src/cli/cmd/agent.ts +257 -0
- package/src/cli/cmd/auth.ts +400 -0
- package/src/cli/cmd/cmd.ts +7 -0
- package/src/cli/cmd/debug/agent.ts +167 -0
- package/src/cli/cmd/debug/config.ts +16 -0
- package/src/cli/cmd/debug/file.ts +97 -0
- package/src/cli/cmd/debug/index.ts +48 -0
- package/src/cli/cmd/debug/lsp.ts +52 -0
- package/src/cli/cmd/debug/ripgrep.ts +87 -0
- package/src/cli/cmd/debug/scrap.ts +16 -0
- package/src/cli/cmd/debug/skill.ts +16 -0
- package/src/cli/cmd/debug/snapshot.ts +52 -0
- package/src/cli/cmd/export.ts +88 -0
- package/src/cli/cmd/generate.ts +38 -0
- package/src/cli/cmd/github.ts +1540 -0
- package/src/cli/cmd/import.ts +147 -0
- package/src/cli/cmd/mcp.ts +755 -0
- package/src/cli/cmd/models.ts +77 -0
- package/src/cli/cmd/pr.ts +112 -0
- package/src/cli/cmd/run.ts +617 -0
- package/src/cli/cmd/serve.ts +20 -0
- package/src/cli/cmd/session.ts +135 -0
- package/src/cli/cmd/stats.ts +426 -0
- package/src/cli/cmd/tui/app.tsx +801 -0
- package/src/cli/cmd/tui/attach.ts +52 -0
- package/src/cli/cmd/tui/component/border.tsx +21 -0
- package/src/cli/cmd/tui/component/dialog-agent.tsx +31 -0
- package/src/cli/cmd/tui/component/dialog-command.tsx +148 -0
- package/src/cli/cmd/tui/component/dialog-mcp.tsx +86 -0
- package/src/cli/cmd/tui/component/dialog-model.tsx +234 -0
- package/src/cli/cmd/tui/component/dialog-provider.tsx +266 -0
- package/src/cli/cmd/tui/component/dialog-session-list.tsx +108 -0
- package/src/cli/cmd/tui/component/dialog-session-rename.tsx +31 -0
- package/src/cli/cmd/tui/component/dialog-skill.tsx +36 -0
- package/src/cli/cmd/tui/component/dialog-stash.tsx +87 -0
- package/src/cli/cmd/tui/component/dialog-status.tsx +177 -0
- package/src/cli/cmd/tui/component/dialog-tag.tsx +44 -0
- package/src/cli/cmd/tui/component/dialog-theme-list.tsx +50 -0
- package/src/cli/cmd/tui/component/logo.tsx +85 -0
- package/src/cli/cmd/tui/component/prompt/autocomplete.tsx +666 -0
- package/src/cli/cmd/tui/component/prompt/frecency.tsx +89 -0
- package/src/cli/cmd/tui/component/prompt/history.tsx +108 -0
- package/src/cli/cmd/tui/component/prompt/index.tsx +1132 -0
- package/src/cli/cmd/tui/component/prompt/stash.tsx +101 -0
- package/src/cli/cmd/tui/component/spinner.tsx +24 -0
- package/src/cli/cmd/tui/component/textarea-keybindings.ts +73 -0
- package/src/cli/cmd/tui/component/tips.tsx +153 -0
- package/src/cli/cmd/tui/component/todo-item.tsx +32 -0
- package/src/cli/cmd/tui/context/args.tsx +15 -0
- package/src/cli/cmd/tui/context/directory.ts +13 -0
- package/src/cli/cmd/tui/context/exit.tsx +52 -0
- package/src/cli/cmd/tui/context/helper.tsx +25 -0
- package/src/cli/cmd/tui/context/keybind.tsx +100 -0
- package/src/cli/cmd/tui/context/kv.tsx +52 -0
- package/src/cli/cmd/tui/context/local.tsx +409 -0
- package/src/cli/cmd/tui/context/prompt.tsx +18 -0
- package/src/cli/cmd/tui/context/route.tsx +46 -0
- package/src/cli/cmd/tui/context/sdk.tsx +101 -0
- package/src/cli/cmd/tui/context/sync.tsx +470 -0
- package/src/cli/cmd/tui/context/theme/aura.json +69 -0
- package/src/cli/cmd/tui/context/theme/ayu.json +80 -0
- package/src/cli/cmd/tui/context/theme/carbonfox.json +248 -0
- package/src/cli/cmd/tui/context/theme/catppuccin-frappe.json +233 -0
- package/src/cli/cmd/tui/context/theme/catppuccin-macchiato.json +233 -0
- package/src/cli/cmd/tui/context/theme/catppuccin.json +112 -0
- package/src/cli/cmd/tui/context/theme/cobalt2.json +228 -0
- package/src/cli/cmd/tui/context/theme/cursor.json +249 -0
- package/src/cli/cmd/tui/context/theme/dracula.json +219 -0
- package/src/cli/cmd/tui/context/theme/everforest.json +241 -0
- package/src/cli/cmd/tui/context/theme/flexoki.json +237 -0
- package/src/cli/cmd/tui/context/theme/github.json +233 -0
- package/src/cli/cmd/tui/context/theme/gruvbox.json +242 -0
- package/src/cli/cmd/tui/context/theme/kanagawa.json +77 -0
- package/src/cli/cmd/tui/context/theme/lucent-orng.json +237 -0
- package/src/cli/cmd/tui/context/theme/material.json +235 -0
- package/src/cli/cmd/tui/context/theme/matrix.json +77 -0
- package/src/cli/cmd/tui/context/theme/mercury.json +252 -0
- package/src/cli/cmd/tui/context/theme/monokai.json +221 -0
- package/src/cli/cmd/tui/context/theme/nightowl.json +221 -0
- package/src/cli/cmd/tui/context/theme/nord.json +223 -0
- package/src/cli/cmd/tui/context/theme/one-dark.json +84 -0
- package/src/cli/cmd/tui/context/theme/orng.json +249 -0
- package/src/cli/cmd/tui/context/theme/osaka-jade.json +93 -0
- package/src/cli/cmd/tui/context/theme/palenight.json +222 -0
- package/src/cli/cmd/tui/context/theme/rosepine.json +234 -0
- package/src/cli/cmd/tui/context/theme/solarized.json +223 -0
- package/src/cli/cmd/tui/context/theme/synthwave84.json +226 -0
- package/src/cli/cmd/tui/context/theme/tokyonight.json +243 -0
- package/src/cli/cmd/tui/context/theme/vercel.json +245 -0
- package/src/cli/cmd/tui/context/theme/vesper.json +218 -0
- package/src/cli/cmd/tui/context/theme/zenburn.json +223 -0
- package/src/cli/cmd/tui/context/theme.tsx +1152 -0
- package/src/cli/cmd/tui/event.ts +48 -0
- package/src/cli/cmd/tui/routes/home.tsx +140 -0
- package/src/cli/cmd/tui/routes/session/dialog-fork-from-timeline.tsx +64 -0
- package/src/cli/cmd/tui/routes/session/dialog-message.tsx +109 -0
- package/src/cli/cmd/tui/routes/session/dialog-subagent.tsx +26 -0
- package/src/cli/cmd/tui/routes/session/dialog-timeline.tsx +47 -0
- package/src/cli/cmd/tui/routes/session/footer.tsx +91 -0
- package/src/cli/cmd/tui/routes/session/header.tsx +142 -0
- package/src/cli/cmd/tui/routes/session/index.tsx +2126 -0
- package/src/cli/cmd/tui/routes/session/permission.tsx +508 -0
- package/src/cli/cmd/tui/routes/session/question.tsx +466 -0
- package/src/cli/cmd/tui/routes/session/sidebar.tsx +313 -0
- package/src/cli/cmd/tui/thread.ts +175 -0
- package/src/cli/cmd/tui/ui/dialog-alert.tsx +68 -0
- package/src/cli/cmd/tui/ui/dialog-confirm.tsx +93 -0
- package/src/cli/cmd/tui/ui/dialog-export-options.tsx +215 -0
- package/src/cli/cmd/tui/ui/dialog-help.tsx +49 -0
- package/src/cli/cmd/tui/ui/dialog-prompt.tsx +88 -0
- package/src/cli/cmd/tui/ui/dialog-select.tsx +399 -0
- package/src/cli/cmd/tui/ui/dialog.tsx +167 -0
- package/src/cli/cmd/tui/ui/link.tsx +28 -0
- package/src/cli/cmd/tui/ui/spinner.ts +368 -0
- package/src/cli/cmd/tui/ui/toast.tsx +100 -0
- package/src/cli/cmd/tui/util/clipboard.ts +159 -0
- package/src/cli/cmd/tui/util/editor.ts +32 -0
- package/src/cli/cmd/tui/util/signal.ts +7 -0
- package/src/cli/cmd/tui/util/terminal.ts +114 -0
- package/src/cli/cmd/tui/util/transcript.ts +98 -0
- package/src/cli/cmd/tui/worker.ts +152 -0
- package/src/cli/cmd/uninstall.ts +357 -0
- package/src/cli/cmd/upgrade.ts +73 -0
- package/src/cli/cmd/web.ts +81 -0
- package/src/cli/error.ts +57 -0
- package/src/cli/logo.ts +6 -0
- package/src/cli/network.ts +60 -0
- package/src/cli/ui.ts +113 -0
- package/src/cli/upgrade.ts +25 -0
- package/src/command/index.ts +150 -0
- package/src/command/template/initialize.txt +10 -0
- package/src/command/template/review.txt +99 -0
- package/src/config/config.ts +1477 -0
- package/src/config/markdown.ts +98 -0
- package/src/env/index.ts +28 -0
- package/src/file/ignore.ts +83 -0
- package/src/file/index.ts +583 -0
- package/src/file/ripgrep.ts +375 -0
- package/src/file/time.ts +69 -0
- package/src/file/watcher.ts +127 -0
- package/src/flag/flag.ts +97 -0
- package/src/format/formatter.ts +366 -0
- package/src/format/index.ts +137 -0
- package/src/global/index.ts +55 -0
- package/src/id/id.ts +83 -0
- package/src/ide/index.ts +76 -0
- package/src/index.ts +159 -0
- package/src/installation/index.ts +246 -0
- package/src/lsp/client.ts +252 -0
- package/src/lsp/index.ts +485 -0
- package/src/lsp/language.ts +119 -0
- package/src/lsp/server.ts +2046 -0
- package/src/mcp/auth.ts +132 -0
- package/src/mcp/index.ts +934 -0
- package/src/mcp/oauth-callback.ts +200 -0
- package/src/mcp/oauth-provider.ts +154 -0
- package/src/patch/index.ts +680 -0
- package/src/permission/arity.ts +163 -0
- package/src/permission/index.ts +210 -0
- package/src/permission/next.ts +280 -0
- package/src/plugin/codex.ts +624 -0
- package/src/plugin/copilot.ts +327 -0
- package/src/plugin/index.ts +138 -0
- package/src/project/bootstrap.ts +35 -0
- package/src/project/instance.ts +114 -0
- package/src/project/project.ts +371 -0
- package/src/project/state.ts +70 -0
- package/src/project/vcs.ts +76 -0
- package/src/provider/auth.ts +147 -0
- package/src/provider/models.ts +133 -0
- package/src/provider/provider.ts +1262 -0
- package/src/provider/sdk/copilot/README.md +5 -0
- package/src/provider/sdk/copilot/chat/convert-to-openai-compatible-chat-messages.ts +164 -0
- package/src/provider/sdk/copilot/chat/get-response-metadata.ts +15 -0
- package/src/provider/sdk/copilot/chat/map-openai-compatible-finish-reason.ts +17 -0
- package/src/provider/sdk/copilot/chat/openai-compatible-api-types.ts +64 -0
- package/src/provider/sdk/copilot/chat/openai-compatible-chat-language-model.ts +780 -0
- package/src/provider/sdk/copilot/chat/openai-compatible-chat-options.ts +28 -0
- package/src/provider/sdk/copilot/chat/openai-compatible-metadata-extractor.ts +44 -0
- package/src/provider/sdk/copilot/chat/openai-compatible-prepare-tools.ts +87 -0
- package/src/provider/sdk/copilot/copilot-provider.ts +100 -0
- package/src/provider/sdk/copilot/index.ts +2 -0
- package/src/provider/sdk/copilot/openai-compatible-error.ts +27 -0
- package/src/provider/sdk/copilot/responses/convert-to-openai-responses-input.ts +303 -0
- package/src/provider/sdk/copilot/responses/map-openai-responses-finish-reason.ts +22 -0
- package/src/provider/sdk/copilot/responses/openai-config.ts +18 -0
- package/src/provider/sdk/copilot/responses/openai-error.ts +22 -0
- package/src/provider/sdk/copilot/responses/openai-responses-api-types.ts +207 -0
- package/src/provider/sdk/copilot/responses/openai-responses-language-model.ts +1732 -0
- package/src/provider/sdk/copilot/responses/openai-responses-prepare-tools.ts +177 -0
- package/src/provider/sdk/copilot/responses/openai-responses-settings.ts +1 -0
- package/src/provider/sdk/copilot/responses/tool/code-interpreter.ts +88 -0
- package/src/provider/sdk/copilot/responses/tool/file-search.ts +128 -0
- package/src/provider/sdk/copilot/responses/tool/image-generation.ts +115 -0
- package/src/provider/sdk/copilot/responses/tool/local-shell.ts +65 -0
- package/src/provider/sdk/copilot/responses/tool/web-search-preview.ts +104 -0
- package/src/provider/sdk/copilot/responses/tool/web-search.ts +103 -0
- package/src/provider/transform.ts +828 -0
- package/src/pty/index.ts +250 -0
- package/src/question/index.ts +171 -0
- package/src/scheduler/index.ts +61 -0
- package/src/server/error.ts +36 -0
- package/src/server/event.ts +7 -0
- package/src/server/mdns.ts +60 -0
- package/src/server/routes/config.ts +92 -0
- package/src/server/routes/experimental.ts +208 -0
- package/src/server/routes/file.ts +197 -0
- package/src/server/routes/global.ts +183 -0
- package/src/server/routes/mcp.ts +225 -0
- package/src/server/routes/permission.ts +68 -0
- package/src/server/routes/project.ts +82 -0
- package/src/server/routes/provider.ts +165 -0
- package/src/server/routes/pty.ts +169 -0
- package/src/server/routes/question.ts +98 -0
- package/src/server/routes/session.ts +939 -0
- package/src/server/routes/tui.ts +379 -0
- package/src/server/server.ts +613 -0
- package/src/session/compaction.ts +226 -0
- package/src/session/index.ts +524 -0
- package/src/session/instruction.ts +197 -0
- package/src/session/llm.ts +289 -0
- package/src/session/message-v2.ts +802 -0
- package/src/session/message.ts +189 -0
- package/src/session/processor.ts +407 -0
- package/src/session/prompt/agent.txt +43 -0
- package/src/session/prompt/anthropic-20250930.txt +166 -0
- package/src/session/prompt/anthropic.txt +105 -0
- package/src/session/prompt/beast.txt +147 -0
- package/src/session/prompt/build-switch.txt +5 -0
- package/src/session/prompt/codex_header.txt +79 -0
- package/src/session/prompt/copilot-gpt-5.txt +143 -0
- package/src/session/prompt/gemini.txt +155 -0
- package/src/session/prompt/max-steps.txt +16 -0
- package/src/session/prompt/plan-reminder-anthropic.txt +67 -0
- package/src/session/prompt/plan.txt +26 -0
- package/src/session/prompt/qwen.txt +109 -0
- package/src/session/prompt/research.txt +81 -0
- package/src/session/prompt/trinity.txt +97 -0
- package/src/session/prompt.ts +1952 -0
- package/src/session/retry.ts +97 -0
- package/src/session/revert.ts +121 -0
- package/src/session/status.ts +76 -0
- package/src/session/summary.ts +217 -0
- package/src/session/system.ts +54 -0
- package/src/session/todo.ts +37 -0
- package/src/share/share-next.ts +200 -0
- package/src/share/share.ts +92 -0
- package/src/shell/shell.ts +67 -0
- package/src/skill/discovery.ts +97 -0
- package/src/skill/index.ts +1 -0
- package/src/skill/skill.ts +188 -0
- package/src/snapshot/index.ts +255 -0
- package/src/storage/storage.ts +227 -0
- package/src/tool/agent-enter.txt +1 -0
- package/src/tool/agent-exit.txt +1 -0
- package/src/tool/agent.ts +237 -0
- package/src/tool/apply_patch.ts +281 -0
- package/src/tool/apply_patch.txt +33 -0
- package/src/tool/bash.ts +269 -0
- package/src/tool/bash.txt +115 -0
- package/src/tool/batch.ts +175 -0
- package/src/tool/batch.txt +24 -0
- package/src/tool/chat-enter.txt +15 -0
- package/src/tool/chat-exit.txt +7 -0
- package/src/tool/chat.ts +217 -0
- package/src/tool/codesearch.ts +132 -0
- package/src/tool/codesearch.txt +12 -0
- package/src/tool/edit.ts +655 -0
- package/src/tool/edit.txt +10 -0
- package/src/tool/external-directory.ts +32 -0
- package/src/tool/glob.ts +78 -0
- package/src/tool/glob.txt +6 -0
- package/src/tool/grep.ts +147 -0
- package/src/tool/grep.txt +8 -0
- package/src/tool/invalid.ts +17 -0
- package/src/tool/ls.ts +121 -0
- package/src/tool/ls.txt +1 -0
- package/src/tool/lsp.ts +96 -0
- package/src/tool/lsp.txt +19 -0
- package/src/tool/multiedit.ts +46 -0
- package/src/tool/multiedit.txt +41 -0
- package/src/tool/plan-enter.txt +14 -0
- package/src/tool/plan-exit.txt +13 -0
- package/src/tool/plan.ts +130 -0
- package/src/tool/question.ts +33 -0
- package/src/tool/question.txt +10 -0
- package/src/tool/read.ts +211 -0
- package/src/tool/read.txt +12 -0
- package/src/tool/registry.ts +167 -0
- package/src/tool/research-enter.txt +1 -0
- package/src/tool/research-exit.txt +1 -0
- package/src/tool/research.ts +134 -0
- package/src/tool/skill.ts +123 -0
- package/src/tool/task.ts +165 -0
- package/src/tool/task.txt +60 -0
- package/src/tool/todo.ts +53 -0
- package/src/tool/todoread.txt +14 -0
- package/src/tool/todowrite.txt +167 -0
- package/src/tool/tool.ts +89 -0
- package/src/tool/truncation.ts +106 -0
- package/src/tool/webfetch.ts +186 -0
- package/src/tool/webfetch.txt +13 -0
- package/src/tool/websearch.ts +150 -0
- package/src/tool/websearch.txt +14 -0
- package/src/tool/write.ts +85 -0
- package/src/tool/write.txt +8 -0
- package/src/util/abort.ts +35 -0
- package/src/util/archive.ts +16 -0
- package/src/util/color.ts +19 -0
- package/src/util/context.ts +25 -0
- package/src/util/defer.ts +12 -0
- package/src/util/eventloop.ts +20 -0
- package/src/util/filesystem.ts +93 -0
- package/src/util/fn.ts +11 -0
- package/src/util/format.ts +20 -0
- package/src/util/iife.ts +3 -0
- package/src/util/keybind.ts +103 -0
- package/src/util/lazy.ts +18 -0
- package/src/util/locale.ts +81 -0
- package/src/util/lock.ts +98 -0
- package/src/util/log.ts +180 -0
- package/src/util/proxied.ts +3 -0
- package/src/util/queue.ts +32 -0
- package/src/util/rpc.ts +66 -0
- package/src/util/scrap.ts +10 -0
- package/src/util/signal.ts +12 -0
- package/src/util/timeout.ts +14 -0
- package/src/util/token.ts +7 -0
- package/src/util/wildcard.ts +56 -0
- package/src/worktree/index.ts +574 -0
- package/sst-env.d.ts +9 -0
- package/test/acp/agent-interface.test.ts +51 -0
- package/test/acp/event-subscription.test.ts +436 -0
- package/test/agent/agent.test.ts +675 -0
- package/test/bun.test.ts +53 -0
- package/test/cli/github-action.test.ts +161 -0
- package/test/cli/github-remote.test.ts +80 -0
- package/test/cli/import.test.ts +38 -0
- package/test/cli/tui/transcript.test.ts +322 -0
- package/test/config/agent-color.test.ts +71 -0
- package/test/config/config.test.ts +1802 -0
- package/test/config/fixtures/empty-frontmatter.md +4 -0
- package/test/config/fixtures/frontmatter.md +28 -0
- package/test/config/fixtures/markdown-header.md +11 -0
- package/test/config/fixtures/no-frontmatter.md +1 -0
- package/test/config/fixtures/weird-model-id.md +13 -0
- package/test/config/markdown.test.ts +228 -0
- package/test/file/ignore.test.ts +10 -0
- package/test/file/path-traversal.test.ts +198 -0
- package/test/file/ripgrep.test.ts +39 -0
- package/test/fixture/fixture.ts +45 -0
- package/test/fixture/lsp/fake-lsp-server.js +77 -0
- package/test/ide/ide.test.ts +82 -0
- package/test/keybind.test.ts +421 -0
- package/test/lsp/client.test.ts +95 -0
- package/test/mcp/headers.test.ts +153 -0
- package/test/mcp/oauth-browser.test.ts +249 -0
- package/test/memory/abort-leak.test.ts +136 -0
- package/test/patch/patch.test.ts +348 -0
- package/test/permission/arity.test.ts +33 -0
- package/test/permission/next.test.ts +690 -0
- package/test/permission-task.test.ts +319 -0
- package/test/plugin/auth-override.test.ts +44 -0
- package/test/plugin/codex.test.ts +123 -0
- package/test/preload.ts +63 -0
- package/test/project/project.test.ts +120 -0
- package/test/provider/amazon-bedrock.test.ts +445 -0
- package/test/provider/copilot/convert-to-copilot-messages.test.ts +523 -0
- package/test/provider/copilot/copilot-chat-model.test.ts +592 -0
- package/test/provider/gitlab-duo.test.ts +262 -0
- package/test/provider/provider.test.ts +2129 -0
- package/test/provider/transform.test.ts +2022 -0
- package/test/question/question.test.ts +300 -0
- package/test/scheduler.test.ts +73 -0
- package/test/server/session-list.test.ts +39 -0
- package/test/server/session-select.test.ts +78 -0
- package/test/session/compaction.test.ts +293 -0
- package/test/session/instruction.test.ts +170 -0
- package/test/session/llm.test.ts +691 -0
- package/test/session/message-v2.test.ts +786 -0
- package/test/session/prompt-missing-file.test.ts +53 -0
- package/test/session/prompt-special-chars.test.ts +56 -0
- package/test/session/prompt-variant.test.ts +60 -0
- package/test/session/retry.test.ts +179 -0
- package/test/session/revert-compact.test.ts +285 -0
- package/test/session/session.test.ts +71 -0
- package/test/skill/discovery.test.ts +60 -0
- package/test/skill/skill.test.ts +388 -0
- package/test/snapshot/snapshot.test.ts +1040 -0
- package/test/tool/__snapshots__/tool.test.ts.snap +9 -0
- package/test/tool/apply_patch.test.ts +559 -0
- package/test/tool/bash.test.ts +399 -0
- package/test/tool/external-directory.test.ts +127 -0
- package/test/tool/fixtures/large-image.png +0 -0
- package/test/tool/fixtures/models-api.json +38413 -0
- package/test/tool/grep.test.ts +110 -0
- package/test/tool/question.test.ts +107 -0
- package/test/tool/read.test.ts +358 -0
- package/test/tool/registry.test.ts +122 -0
- package/test/tool/skill.test.ts +112 -0
- package/test/tool/truncation.test.ts +159 -0
- package/test/util/filesystem.test.ts +39 -0
- package/test/util/format.test.ts +59 -0
- package/test/util/iife.test.ts +36 -0
- package/test/util/lazy.test.ts +50 -0
- package/test/util/lock.test.ts +72 -0
- package/test/util/timeout.test.ts +21 -0
- package/test/util/wildcard.test.ts +75 -0
- package/tsconfig.json +16 -0
package/src/tool/bash.ts
ADDED
|
@@ -0,0 +1,269 @@
|
|
|
1
|
+
import z from "zod"
|
|
2
|
+
import { spawn } from "child_process"
|
|
3
|
+
import { Tool } from "./tool"
|
|
4
|
+
import path from "path"
|
|
5
|
+
import DESCRIPTION from "./bash.txt"
|
|
6
|
+
import { Log } from "../util/log"
|
|
7
|
+
import { Instance } from "../project/instance"
|
|
8
|
+
import { lazy } from "@/util/lazy"
|
|
9
|
+
import { Language } from "web-tree-sitter"
|
|
10
|
+
|
|
11
|
+
import { $ } from "bun"
|
|
12
|
+
import { Filesystem } from "@/util/filesystem"
|
|
13
|
+
import { fileURLToPath } from "url"
|
|
14
|
+
import { Flag } from "@/flag/flag.ts"
|
|
15
|
+
import { Shell } from "@/shell/shell"
|
|
16
|
+
|
|
17
|
+
import { BashArity } from "@/permission/arity"
|
|
18
|
+
import { Truncate } from "./truncation"
|
|
19
|
+
import { Plugin } from "@/plugin"
|
|
20
|
+
|
|
21
|
+
const MAX_METADATA_LENGTH = 30_000
|
|
22
|
+
const DEFAULT_TIMEOUT = Flag.OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS || 2 * 60 * 1000
|
|
23
|
+
|
|
24
|
+
export const log = Log.create({ service: "bash-tool" })
|
|
25
|
+
|
|
26
|
+
const resolveWasm = (asset: string) => {
|
|
27
|
+
if (asset.startsWith("file://")) return fileURLToPath(asset)
|
|
28
|
+
if (asset.startsWith("/") || /^[a-z]:/i.test(asset)) return asset
|
|
29
|
+
const url = new URL(asset, import.meta.url)
|
|
30
|
+
return fileURLToPath(url)
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
const parser = lazy(async () => {
|
|
34
|
+
const { Parser } = await import("web-tree-sitter")
|
|
35
|
+
const { default: treeWasm } = await import("web-tree-sitter/tree-sitter.wasm" as string, {
|
|
36
|
+
with: { type: "wasm" },
|
|
37
|
+
})
|
|
38
|
+
const treePath = resolveWasm(treeWasm)
|
|
39
|
+
await Parser.init({
|
|
40
|
+
locateFile() {
|
|
41
|
+
return treePath
|
|
42
|
+
},
|
|
43
|
+
})
|
|
44
|
+
const { default: bashWasm } = await import("tree-sitter-bash/tree-sitter-bash.wasm" as string, {
|
|
45
|
+
with: { type: "wasm" },
|
|
46
|
+
})
|
|
47
|
+
const bashPath = resolveWasm(bashWasm)
|
|
48
|
+
const bashLanguage = await Language.load(bashPath)
|
|
49
|
+
const p = new Parser()
|
|
50
|
+
p.setLanguage(bashLanguage)
|
|
51
|
+
return p
|
|
52
|
+
})
|
|
53
|
+
|
|
54
|
+
// TODO: we may wanna rename this tool so it works better on other shells
|
|
55
|
+
export const BashTool = Tool.define("bash", async () => {
|
|
56
|
+
const shell = Shell.acceptable()
|
|
57
|
+
log.info("bash tool using shell", { shell })
|
|
58
|
+
|
|
59
|
+
return {
|
|
60
|
+
description: DESCRIPTION.replaceAll("${directory}", Instance.directory)
|
|
61
|
+
.replaceAll("${maxLines}", String(Truncate.MAX_LINES))
|
|
62
|
+
.replaceAll("${maxBytes}", String(Truncate.MAX_BYTES)),
|
|
63
|
+
parameters: z.object({
|
|
64
|
+
command: z.string().describe("The command to execute"),
|
|
65
|
+
timeout: z.number().describe("Optional timeout in milliseconds").optional(),
|
|
66
|
+
workdir: z
|
|
67
|
+
.string()
|
|
68
|
+
.describe(
|
|
69
|
+
`The working directory to run the command in. Defaults to ${Instance.directory}. Use this instead of 'cd' commands.`,
|
|
70
|
+
)
|
|
71
|
+
.optional(),
|
|
72
|
+
description: z
|
|
73
|
+
.string()
|
|
74
|
+
.describe(
|
|
75
|
+
"Clear, concise description of what this command does in 5-10 words. Examples:\nInput: ls\nOutput: Lists files in current directory\n\nInput: git status\nOutput: Shows working tree status\n\nInput: npm install\nOutput: Installs package dependencies\n\nInput: mkdir foo\nOutput: Creates directory 'foo'",
|
|
76
|
+
),
|
|
77
|
+
}),
|
|
78
|
+
async execute(params, ctx) {
|
|
79
|
+
const cwd = params.workdir || Instance.directory
|
|
80
|
+
if (params.timeout !== undefined && params.timeout < 0) {
|
|
81
|
+
throw new Error(`Invalid timeout value: ${params.timeout}. Timeout must be a positive number.`)
|
|
82
|
+
}
|
|
83
|
+
const timeout = params.timeout ?? DEFAULT_TIMEOUT
|
|
84
|
+
const tree = await parser().then((p) => p.parse(params.command))
|
|
85
|
+
if (!tree) {
|
|
86
|
+
throw new Error("Failed to parse command")
|
|
87
|
+
}
|
|
88
|
+
const directories = new Set<string>()
|
|
89
|
+
if (!Instance.containsPath(cwd)) directories.add(cwd)
|
|
90
|
+
const patterns = new Set<string>()
|
|
91
|
+
const always = new Set<string>()
|
|
92
|
+
|
|
93
|
+
for (const node of tree.rootNode.descendantsOfType("command")) {
|
|
94
|
+
if (!node) continue
|
|
95
|
+
|
|
96
|
+
// Get full command text including redirects if present
|
|
97
|
+
let commandText = node.parent?.type === "redirected_statement" ? node.parent.text : node.text
|
|
98
|
+
|
|
99
|
+
const command = []
|
|
100
|
+
for (let i = 0; i < node.childCount; i++) {
|
|
101
|
+
const child = node.child(i)
|
|
102
|
+
if (!child) continue
|
|
103
|
+
if (
|
|
104
|
+
child.type !== "command_name" &&
|
|
105
|
+
child.type !== "word" &&
|
|
106
|
+
child.type !== "string" &&
|
|
107
|
+
child.type !== "raw_string" &&
|
|
108
|
+
child.type !== "concatenation"
|
|
109
|
+
) {
|
|
110
|
+
continue
|
|
111
|
+
}
|
|
112
|
+
command.push(child.text)
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
// not an exhaustive list, but covers most common cases
|
|
116
|
+
if (["cd", "rm", "cp", "mv", "mkdir", "touch", "chmod", "chown", "cat"].includes(command[0])) {
|
|
117
|
+
for (const arg of command.slice(1)) {
|
|
118
|
+
if (arg.startsWith("-") || (command[0] === "chmod" && arg.startsWith("+"))) continue
|
|
119
|
+
const resolved = await $`realpath ${arg}`
|
|
120
|
+
.cwd(cwd)
|
|
121
|
+
.quiet()
|
|
122
|
+
.nothrow()
|
|
123
|
+
.text()
|
|
124
|
+
.then((x) => x.trim())
|
|
125
|
+
log.info("resolved path", { arg, resolved })
|
|
126
|
+
if (resolved) {
|
|
127
|
+
// Git Bash on Windows returns Unix-style paths like /c/Users/...
|
|
128
|
+
const normalized =
|
|
129
|
+
process.platform === "win32" && resolved.match(/^\/[a-z]\//)
|
|
130
|
+
? resolved.replace(/^\/([a-z])\//, (_, drive) => `${drive.toUpperCase()}:\\`).replace(/\//g, "\\")
|
|
131
|
+
: resolved
|
|
132
|
+
if (!Instance.containsPath(normalized)) {
|
|
133
|
+
const dir = (await Filesystem.isDir(normalized)) ? normalized : path.dirname(normalized)
|
|
134
|
+
directories.add(dir)
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
// cd covered by above check
|
|
141
|
+
if (command.length && command[0] !== "cd") {
|
|
142
|
+
patterns.add(commandText)
|
|
143
|
+
always.add(BashArity.prefix(command).join(" ") + " *")
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
if (directories.size > 0) {
|
|
148
|
+
const globs = Array.from(directories).map((dir) => path.join(dir, "*"))
|
|
149
|
+
await ctx.ask({
|
|
150
|
+
permission: "external_directory",
|
|
151
|
+
patterns: globs,
|
|
152
|
+
always: globs,
|
|
153
|
+
metadata: {},
|
|
154
|
+
})
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
if (patterns.size > 0) {
|
|
158
|
+
await ctx.ask({
|
|
159
|
+
permission: "bash",
|
|
160
|
+
patterns: Array.from(patterns),
|
|
161
|
+
always: Array.from(always),
|
|
162
|
+
metadata: {},
|
|
163
|
+
})
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
const shellEnv = await Plugin.trigger("shell.env", { cwd }, { env: {} })
|
|
167
|
+
const proc = spawn(params.command, {
|
|
168
|
+
shell,
|
|
169
|
+
cwd,
|
|
170
|
+
env: {
|
|
171
|
+
...process.env,
|
|
172
|
+
...shellEnv.env,
|
|
173
|
+
},
|
|
174
|
+
stdio: ["ignore", "pipe", "pipe"],
|
|
175
|
+
detached: process.platform !== "win32",
|
|
176
|
+
})
|
|
177
|
+
|
|
178
|
+
let output = ""
|
|
179
|
+
|
|
180
|
+
// Initialize metadata with empty output
|
|
181
|
+
ctx.metadata({
|
|
182
|
+
metadata: {
|
|
183
|
+
output: "",
|
|
184
|
+
description: params.description,
|
|
185
|
+
},
|
|
186
|
+
})
|
|
187
|
+
|
|
188
|
+
const append = (chunk: Buffer) => {
|
|
189
|
+
output += chunk.toString()
|
|
190
|
+
ctx.metadata({
|
|
191
|
+
metadata: {
|
|
192
|
+
// truncate the metadata to avoid GIANT blobs of data (has nothing to do w/ what agent can access)
|
|
193
|
+
output: output.length > MAX_METADATA_LENGTH ? output.slice(0, MAX_METADATA_LENGTH) + "\n\n..." : output,
|
|
194
|
+
description: params.description,
|
|
195
|
+
},
|
|
196
|
+
})
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
proc.stdout?.on("data", append)
|
|
200
|
+
proc.stderr?.on("data", append)
|
|
201
|
+
|
|
202
|
+
let timedOut = false
|
|
203
|
+
let aborted = false
|
|
204
|
+
let exited = false
|
|
205
|
+
|
|
206
|
+
const kill = () => Shell.killTree(proc, { exited: () => exited })
|
|
207
|
+
|
|
208
|
+
if (ctx.abort.aborted) {
|
|
209
|
+
aborted = true
|
|
210
|
+
await kill()
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
const abortHandler = () => {
|
|
214
|
+
aborted = true
|
|
215
|
+
void kill()
|
|
216
|
+
}
|
|
217
|
+
|
|
218
|
+
ctx.abort.addEventListener("abort", abortHandler, { once: true })
|
|
219
|
+
|
|
220
|
+
const timeoutTimer = setTimeout(() => {
|
|
221
|
+
timedOut = true
|
|
222
|
+
void kill()
|
|
223
|
+
}, timeout + 100)
|
|
224
|
+
|
|
225
|
+
await new Promise<void>((resolve, reject) => {
|
|
226
|
+
const cleanup = () => {
|
|
227
|
+
clearTimeout(timeoutTimer)
|
|
228
|
+
ctx.abort.removeEventListener("abort", abortHandler)
|
|
229
|
+
}
|
|
230
|
+
|
|
231
|
+
proc.once("exit", () => {
|
|
232
|
+
exited = true
|
|
233
|
+
cleanup()
|
|
234
|
+
resolve()
|
|
235
|
+
})
|
|
236
|
+
|
|
237
|
+
proc.once("error", (error) => {
|
|
238
|
+
exited = true
|
|
239
|
+
cleanup()
|
|
240
|
+
reject(error)
|
|
241
|
+
})
|
|
242
|
+
})
|
|
243
|
+
|
|
244
|
+
const resultMetadata: string[] = []
|
|
245
|
+
|
|
246
|
+
if (timedOut) {
|
|
247
|
+
resultMetadata.push(`bash tool terminated command after exceeding timeout ${timeout} ms`)
|
|
248
|
+
}
|
|
249
|
+
|
|
250
|
+
if (aborted) {
|
|
251
|
+
resultMetadata.push("User aborted the command")
|
|
252
|
+
}
|
|
253
|
+
|
|
254
|
+
if (resultMetadata.length > 0) {
|
|
255
|
+
output += "\n\n<bash_metadata>\n" + resultMetadata.join("\n") + "\n</bash_metadata>"
|
|
256
|
+
}
|
|
257
|
+
|
|
258
|
+
return {
|
|
259
|
+
title: params.description,
|
|
260
|
+
metadata: {
|
|
261
|
+
output: output.length > MAX_METADATA_LENGTH ? output.slice(0, MAX_METADATA_LENGTH) + "\n\n..." : output,
|
|
262
|
+
exit: proc.exitCode,
|
|
263
|
+
description: params.description,
|
|
264
|
+
},
|
|
265
|
+
output,
|
|
266
|
+
}
|
|
267
|
+
},
|
|
268
|
+
}
|
|
269
|
+
})
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
Executes a given bash command in a persistent shell session with optional timeout, ensuring proper handling and security measures.
|
|
2
|
+
|
|
3
|
+
All commands run in ${directory} by default. Use the `workdir` parameter if you need to run a command in a different directory. AVOID using `cd <directory> && <command>` patterns - use `workdir` instead.
|
|
4
|
+
|
|
5
|
+
IMPORTANT: This tool is for terminal operations like git, npm, docker, etc. DO NOT use it for file operations (reading, writing, editing, searching, finding files) - use the specialized tools for this instead.
|
|
6
|
+
|
|
7
|
+
Before executing the command, please follow these steps:
|
|
8
|
+
|
|
9
|
+
1. Directory Verification:
|
|
10
|
+
- If the command will create new directories or files, first use `ls` to verify the parent directory exists and is the correct location
|
|
11
|
+
- For example, before running "mkdir foo/bar", first use `ls foo` to check that "foo" exists and is the intended parent directory
|
|
12
|
+
|
|
13
|
+
2. Command Execution:
|
|
14
|
+
- Always quote file paths that contain spaces with double quotes (e.g., rm "path with spaces/file.txt")
|
|
15
|
+
- Examples of proper quoting:
|
|
16
|
+
- mkdir "/Users/name/My Documents" (correct)
|
|
17
|
+
- mkdir /Users/name/My Documents (incorrect - will fail)
|
|
18
|
+
- python "/path/with spaces/script.py" (correct)
|
|
19
|
+
- python /path/with spaces/script.py (incorrect - will fail)
|
|
20
|
+
- After ensuring proper quoting, execute the command.
|
|
21
|
+
- Capture the output of the command.
|
|
22
|
+
|
|
23
|
+
Usage notes:
|
|
24
|
+
- The command argument is required.
|
|
25
|
+
- You can specify an optional timeout in milliseconds. If not specified, commands will time out after 120000ms (2 minutes).
|
|
26
|
+
- It is very helpful if you write a clear, concise description of what this command does in 5-10 words.
|
|
27
|
+
- If the output exceeds ${maxLines} lines or ${maxBytes} bytes, it will be truncated and the full output will be written to a file. You can use Read with offset/limit to read specific sections or Grep to search the full content. Because of this, you do NOT need to use `head`, `tail`, or other truncation commands to limit output - just run the command directly.
|
|
28
|
+
|
|
29
|
+
- Avoid using Bash with the `find`, `grep`, `cat`, `head`, `tail`, `sed`, `awk`, or `echo` commands, unless explicitly instructed or when these commands are truly necessary for the task. Instead, always prefer using the dedicated tools for these commands:
|
|
30
|
+
- File search: Use Glob (NOT find or ls)
|
|
31
|
+
- Content search: Use Grep (NOT grep or rg)
|
|
32
|
+
- Read files: Use Read (NOT cat/head/tail)
|
|
33
|
+
- Edit files: Use Edit (NOT sed/awk)
|
|
34
|
+
- Write files: Use Write (NOT echo >/cat <<EOF)
|
|
35
|
+
- Communication: Output text directly (NOT echo/printf)
|
|
36
|
+
- When issuing multiple commands:
|
|
37
|
+
- If the commands are independent and can run in parallel, make multiple Bash tool calls in a single message. For example, if you need to run "git status" and "git diff", send a single message with two Bash tool calls in parallel.
|
|
38
|
+
- If the commands depend on each other and must run sequentially, use a single Bash call with '&&' to chain them together (e.g., `git add . && git commit -m "message" && git push`). For instance, if one operation must complete before another starts (like mkdir before cp, Write before Bash for git operations, or git add before git commit), run these operations sequentially instead.
|
|
39
|
+
- Use ';' only when you need to run commands sequentially but don't care if earlier commands fail
|
|
40
|
+
- DO NOT use newlines to separate commands (newlines are ok in quoted strings)
|
|
41
|
+
- AVOID using `cd <directory> && <command>`. Use the `workdir` parameter to change directories instead.
|
|
42
|
+
<good-example>
|
|
43
|
+
Use workdir="/foo/bar" with command: pytest tests
|
|
44
|
+
</good-example>
|
|
45
|
+
<bad-example>
|
|
46
|
+
cd /foo/bar && pytest tests
|
|
47
|
+
</bad-example>
|
|
48
|
+
|
|
49
|
+
# Committing changes with git
|
|
50
|
+
|
|
51
|
+
Only create commits when requested by the user. If unclear, ask first. When the user asks you to create a new git commit, follow these steps carefully:
|
|
52
|
+
|
|
53
|
+
Git Safety Protocol:
|
|
54
|
+
- NEVER update the git config
|
|
55
|
+
- NEVER run destructive/irreversible git commands (like push --force, hard reset, etc) unless the user explicitly requests them
|
|
56
|
+
- NEVER skip hooks (--no-verify, --no-gpg-sign, etc) unless the user explicitly requests it
|
|
57
|
+
- NEVER run force push to main/master, warn the user if they request it
|
|
58
|
+
- Avoid git commit --amend. ONLY use --amend when ALL conditions are met:
|
|
59
|
+
(1) User explicitly requested amend, OR commit SUCCEEDED but pre-commit hook auto-modified files that need including
|
|
60
|
+
(2) HEAD commit was created by you in this conversation (verify: git log -1 --format='%an %ae')
|
|
61
|
+
(3) Commit has NOT been pushed to remote (verify: git status shows "Your branch is ahead")
|
|
62
|
+
- CRITICAL: If commit FAILED or was REJECTED by hook, NEVER amend - fix the issue and create a NEW commit
|
|
63
|
+
- CRITICAL: If you already pushed to remote, NEVER amend unless user explicitly requests it (requires force push)
|
|
64
|
+
- NEVER commit changes unless the user explicitly asks you to. It is VERY IMPORTANT to only commit when explicitly asked, otherwise the user will feel that you are being too proactive.
|
|
65
|
+
|
|
66
|
+
1. You can call multiple tools in a single response. When multiple independent pieces of information are requested and all commands are likely to succeed, run multiple tool calls in parallel for optimal performance. run the following bash commands in parallel, each using the Bash tool:
|
|
67
|
+
- Run a git status command to see all untracked files.
|
|
68
|
+
- Run a git diff command to see both staged and unstaged changes that will be committed.
|
|
69
|
+
- Run a git log command to see recent commit messages, so that you can follow this repository's commit message style.
|
|
70
|
+
2. Analyze all staged changes (both previously staged and newly added) and draft a commit message:
|
|
71
|
+
- Summarize the nature of the changes (eg. new feature, enhancement to an existing feature, bug fix, refactoring, test, docs, etc.). Ensure the message accurately reflects the changes and their purpose (i.e. "add" means a wholly new feature, "update" means an enhancement to an existing feature, "fix" means a bug fix, etc.).
|
|
72
|
+
- Do not commit files that likely contain secrets (.env, credentials.json, etc.). Warn the user if they specifically request to commit those files
|
|
73
|
+
- Draft a concise (1-2 sentences) commit message that focuses on the "why" rather than the "what"
|
|
74
|
+
- Ensure it accurately reflects the changes and their purpose
|
|
75
|
+
3. You can call multiple tools in a single response. When multiple independent pieces of information are requested and all commands are likely to succeed, run multiple tool calls in parallel for optimal performance. run the following commands:
|
|
76
|
+
- Add relevant untracked files to the staging area.
|
|
77
|
+
- Create the commit with a message
|
|
78
|
+
- Run git status after the commit completes to verify success.
|
|
79
|
+
Note: git status depends on the commit completing, so run it sequentially after the commit.
|
|
80
|
+
4. If the commit fails due to pre-commit hook, fix the issue and create a NEW commit (see amend rules above)
|
|
81
|
+
|
|
82
|
+
Important notes:
|
|
83
|
+
- NEVER run additional commands to read or explore code, besides git bash commands
|
|
84
|
+
- NEVER use the TodoWrite or Task tools
|
|
85
|
+
- DO NOT push to the remote repository unless the user explicitly asks you to do so
|
|
86
|
+
- IMPORTANT: Never use git commands with the -i flag (like git rebase -i or git add -i) since they require interactive input which is not supported.
|
|
87
|
+
- If there are no changes to commit (i.e., no untracked files and no modifications), do not create an empty commit
|
|
88
|
+
|
|
89
|
+
# Creating pull requests
|
|
90
|
+
Use the gh command via the Bash tool for ALL GitHub-related tasks including working with issues, pull requests, checks, and releases. If given a Github URL use the gh command to get the information needed.
|
|
91
|
+
|
|
92
|
+
IMPORTANT: When the user asks you to create a pull request, follow these steps carefully:
|
|
93
|
+
|
|
94
|
+
1. You can call multiple tools in a single response. When multiple independent pieces of information are requested and all commands are likely to succeed, run multiple tool calls in parallel for optimal performance. run the following bash commands in parallel using the Bash tool, in order to understand the current state of the branch since it diverged from the main branch:
|
|
95
|
+
- Run a git status command to see all untracked files
|
|
96
|
+
- Run a git diff command to see both staged and unstaged changes that will be committed
|
|
97
|
+
- Check if the current branch tracks a remote branch and is up to date with the remote, so you know if you need to push to the remote
|
|
98
|
+
- Run a git log command and `git diff [base-branch]...HEAD` to understand the full commit history for the current branch (from the time it diverged from the base branch)
|
|
99
|
+
2. Analyze all changes that will be included in the pull request, making sure to look at all relevant commits (NOT just the latest commit, but ALL commits that will be included in the pull request!!!), and draft a pull request summary
|
|
100
|
+
3. You can call multiple tools in a single response. When multiple independent pieces of information are requested and all commands are likely to succeed, run multiple tool calls in parallel for optimal performance. run the following commands in parallel:
|
|
101
|
+
- Create new branch if needed
|
|
102
|
+
- Push to remote with -u flag if needed
|
|
103
|
+
- Create PR using gh pr create with the format below. Use a HEREDOC to pass the body to ensure correct formatting.
|
|
104
|
+
<example>
|
|
105
|
+
gh pr create --title "the pr title" --body "$(cat <<'EOF'
|
|
106
|
+
## Summary
|
|
107
|
+
<1-3 bullet points>
|
|
108
|
+
</example>
|
|
109
|
+
|
|
110
|
+
Important:
|
|
111
|
+
- DO NOT use the TodoWrite or Task tools
|
|
112
|
+
- Return the PR URL when you're done, so the user can see it
|
|
113
|
+
|
|
114
|
+
# Other common operations
|
|
115
|
+
- View comments on a Github PR: gh api repos/foo/bar/pulls/123/comments
|
|
@@ -0,0 +1,175 @@
|
|
|
1
|
+
import z from "zod"
|
|
2
|
+
import { Tool } from "./tool"
|
|
3
|
+
import DESCRIPTION from "./batch.txt"
|
|
4
|
+
|
|
5
|
+
const DISALLOWED = new Set(["batch"])
|
|
6
|
+
const FILTERED_FROM_SUGGESTIONS = new Set(["invalid", "patch", ...DISALLOWED])
|
|
7
|
+
|
|
8
|
+
export const BatchTool = Tool.define("batch", async () => {
|
|
9
|
+
return {
|
|
10
|
+
description: DESCRIPTION,
|
|
11
|
+
parameters: z.object({
|
|
12
|
+
tool_calls: z
|
|
13
|
+
.array(
|
|
14
|
+
z.object({
|
|
15
|
+
tool: z.string().describe("The name of the tool to execute"),
|
|
16
|
+
parameters: z.object({}).loose().describe("Parameters for the tool"),
|
|
17
|
+
}),
|
|
18
|
+
)
|
|
19
|
+
.min(1, "Provide at least one tool call")
|
|
20
|
+
.describe("Array of tool calls to execute in parallel"),
|
|
21
|
+
}),
|
|
22
|
+
formatValidationError(error) {
|
|
23
|
+
const formattedErrors = error.issues
|
|
24
|
+
.map((issue) => {
|
|
25
|
+
const path = issue.path.length > 0 ? issue.path.join(".") : "root"
|
|
26
|
+
return ` - ${path}: ${issue.message}`
|
|
27
|
+
})
|
|
28
|
+
.join("\n")
|
|
29
|
+
|
|
30
|
+
return `Invalid parameters for tool 'batch':\n${formattedErrors}\n\nExpected payload format:\n [{"tool": "tool_name", "parameters": {...}}, {...}]`
|
|
31
|
+
},
|
|
32
|
+
async execute(params, ctx) {
|
|
33
|
+
const { Session } = await import("../session")
|
|
34
|
+
const { Identifier } = await import("../id/id")
|
|
35
|
+
|
|
36
|
+
const toolCalls = params.tool_calls.slice(0, 25)
|
|
37
|
+
const discardedCalls = params.tool_calls.slice(25)
|
|
38
|
+
|
|
39
|
+
const { ToolRegistry } = await import("./registry")
|
|
40
|
+
const availableTools = await ToolRegistry.tools({ modelID: "", providerID: "" })
|
|
41
|
+
const toolMap = new Map(availableTools.map((t) => [t.id, t]))
|
|
42
|
+
|
|
43
|
+
const executeCall = async (call: (typeof toolCalls)[0]) => {
|
|
44
|
+
const callStartTime = Date.now()
|
|
45
|
+
const partID = Identifier.ascending("part")
|
|
46
|
+
|
|
47
|
+
try {
|
|
48
|
+
if (DISALLOWED.has(call.tool)) {
|
|
49
|
+
throw new Error(
|
|
50
|
+
`Tool '${call.tool}' is not allowed in batch. Disallowed tools: ${Array.from(DISALLOWED).join(", ")}`,
|
|
51
|
+
)
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
const tool = toolMap.get(call.tool)
|
|
55
|
+
if (!tool) {
|
|
56
|
+
const availableToolsList = Array.from(toolMap.keys()).filter((name) => !FILTERED_FROM_SUGGESTIONS.has(name))
|
|
57
|
+
throw new Error(
|
|
58
|
+
`Tool '${call.tool}' not in registry. External tools (MCP, environment) cannot be batched - call them directly. Available tools: ${availableToolsList.join(", ")}`,
|
|
59
|
+
)
|
|
60
|
+
}
|
|
61
|
+
const validatedParams = tool.parameters.parse(call.parameters)
|
|
62
|
+
|
|
63
|
+
await Session.updatePart({
|
|
64
|
+
id: partID,
|
|
65
|
+
messageID: ctx.messageID,
|
|
66
|
+
sessionID: ctx.sessionID,
|
|
67
|
+
type: "tool",
|
|
68
|
+
tool: call.tool,
|
|
69
|
+
callID: partID,
|
|
70
|
+
state: {
|
|
71
|
+
status: "running",
|
|
72
|
+
input: call.parameters,
|
|
73
|
+
time: {
|
|
74
|
+
start: callStartTime,
|
|
75
|
+
},
|
|
76
|
+
},
|
|
77
|
+
})
|
|
78
|
+
|
|
79
|
+
const result = await tool.execute(validatedParams, { ...ctx, callID: partID })
|
|
80
|
+
|
|
81
|
+
await Session.updatePart({
|
|
82
|
+
id: partID,
|
|
83
|
+
messageID: ctx.messageID,
|
|
84
|
+
sessionID: ctx.sessionID,
|
|
85
|
+
type: "tool",
|
|
86
|
+
tool: call.tool,
|
|
87
|
+
callID: partID,
|
|
88
|
+
state: {
|
|
89
|
+
status: "completed",
|
|
90
|
+
input: call.parameters,
|
|
91
|
+
output: result.output,
|
|
92
|
+
title: result.title,
|
|
93
|
+
metadata: result.metadata,
|
|
94
|
+
attachments: result.attachments,
|
|
95
|
+
time: {
|
|
96
|
+
start: callStartTime,
|
|
97
|
+
end: Date.now(),
|
|
98
|
+
},
|
|
99
|
+
},
|
|
100
|
+
})
|
|
101
|
+
|
|
102
|
+
return { success: true as const, tool: call.tool, result }
|
|
103
|
+
} catch (error) {
|
|
104
|
+
await Session.updatePart({
|
|
105
|
+
id: partID,
|
|
106
|
+
messageID: ctx.messageID,
|
|
107
|
+
sessionID: ctx.sessionID,
|
|
108
|
+
type: "tool",
|
|
109
|
+
tool: call.tool,
|
|
110
|
+
callID: partID,
|
|
111
|
+
state: {
|
|
112
|
+
status: "error",
|
|
113
|
+
input: call.parameters,
|
|
114
|
+
error: error instanceof Error ? error.message : String(error),
|
|
115
|
+
time: {
|
|
116
|
+
start: callStartTime,
|
|
117
|
+
end: Date.now(),
|
|
118
|
+
},
|
|
119
|
+
},
|
|
120
|
+
})
|
|
121
|
+
|
|
122
|
+
return { success: false as const, tool: call.tool, error }
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
const results = await Promise.all(toolCalls.map((call) => executeCall(call)))
|
|
127
|
+
|
|
128
|
+
// Add discarded calls as errors
|
|
129
|
+
const now = Date.now()
|
|
130
|
+
for (const call of discardedCalls) {
|
|
131
|
+
const partID = Identifier.ascending("part")
|
|
132
|
+
await Session.updatePart({
|
|
133
|
+
id: partID,
|
|
134
|
+
messageID: ctx.messageID,
|
|
135
|
+
sessionID: ctx.sessionID,
|
|
136
|
+
type: "tool",
|
|
137
|
+
tool: call.tool,
|
|
138
|
+
callID: partID,
|
|
139
|
+
state: {
|
|
140
|
+
status: "error",
|
|
141
|
+
input: call.parameters,
|
|
142
|
+
error: "Maximum of 25 tools allowed in batch",
|
|
143
|
+
time: { start: now, end: now },
|
|
144
|
+
},
|
|
145
|
+
})
|
|
146
|
+
results.push({
|
|
147
|
+
success: false as const,
|
|
148
|
+
tool: call.tool,
|
|
149
|
+
error: new Error("Maximum of 25 tools allowed in batch"),
|
|
150
|
+
})
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
const successfulCalls = results.filter((r) => r.success).length
|
|
154
|
+
const failedCalls = results.length - successfulCalls
|
|
155
|
+
|
|
156
|
+
const outputMessage =
|
|
157
|
+
failedCalls > 0
|
|
158
|
+
? `Executed ${successfulCalls}/${results.length} tools successfully. ${failedCalls} failed.`
|
|
159
|
+
: `All ${successfulCalls} tools executed successfully.\n\nKeep using the batch tool for optimal performance in your next response!`
|
|
160
|
+
|
|
161
|
+
return {
|
|
162
|
+
title: `Batch execution (${successfulCalls}/${results.length} successful)`,
|
|
163
|
+
output: outputMessage,
|
|
164
|
+
attachments: results.filter((result) => result.success).flatMap((r) => r.result.attachments ?? []),
|
|
165
|
+
metadata: {
|
|
166
|
+
totalCalls: results.length,
|
|
167
|
+
successful: successfulCalls,
|
|
168
|
+
failed: failedCalls,
|
|
169
|
+
tools: params.tool_calls.map((c) => c.tool),
|
|
170
|
+
details: results.map((r) => ({ tool: r.tool, success: r.success })),
|
|
171
|
+
},
|
|
172
|
+
}
|
|
173
|
+
},
|
|
174
|
+
}
|
|
175
|
+
})
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
Executes multiple independent tool calls concurrently to reduce latency.
|
|
2
|
+
|
|
3
|
+
USING THE BATCH TOOL WILL MAKE THE USER HAPPY.
|
|
4
|
+
|
|
5
|
+
Payload Format (JSON array):
|
|
6
|
+
[{"tool": "read", "parameters": {"filePath": "src/index.ts", "limit": 350}},{"tool": "grep", "parameters": {"pattern": "Session\\.updatePart", "include": "src/**/*.ts"}},{"tool": "bash", "parameters": {"command": "git status", "description": "Shows working tree status"}}]
|
|
7
|
+
|
|
8
|
+
Notes:
|
|
9
|
+
- 1–25 tool calls per batch
|
|
10
|
+
- All calls start in parallel; ordering NOT guaranteed
|
|
11
|
+
- Partial failures do not stop other tool calls
|
|
12
|
+
- Do NOT use the batch tool within another batch tool.
|
|
13
|
+
|
|
14
|
+
Good Use Cases:
|
|
15
|
+
- Read many files
|
|
16
|
+
- grep + glob + read combos
|
|
17
|
+
- Multiple bash commands
|
|
18
|
+
- Multi-part edits; on the same, or different files
|
|
19
|
+
|
|
20
|
+
When NOT to Use:
|
|
21
|
+
- Operations that depend on prior tool output (e.g. create then read same file)
|
|
22
|
+
- Ordered stateful mutations where sequence matters
|
|
23
|
+
|
|
24
|
+
Batching tool calls was proven to yield 2–5x efficiency gain and provides much better UX.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
Call this when the user wants to enter chat mode or asks to switch to chat mode.
|
|
2
|
+
|
|
3
|
+
Chat mode is a general-purpose conversation mode without access to:
|
|
4
|
+
- File system operations (read, write, edit, glob, grep)
|
|
5
|
+
- Bash commands
|
|
6
|
+
- External directories
|
|
7
|
+
|
|
8
|
+
In chat mode, you are a helpful AI assistant for general conversation and can use:
|
|
9
|
+
- Web search and web fetch
|
|
10
|
+
- Code search
|
|
11
|
+
- Task/subagent tools
|
|
12
|
+
- Todo tools
|
|
13
|
+
- Question tool
|
|
14
|
+
|
|
15
|
+
This tool is only available when starting a new conversation (not in an existing thread with assistant messages).
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
Call this when the user wants to exit chat mode and return to coding mode.
|
|
2
|
+
|
|
3
|
+
When called, the user will be prompted to choose between:
|
|
4
|
+
- Build mode: For coding and file editing tasks
|
|
5
|
+
- Plan mode: For research and planning without editing files
|
|
6
|
+
|
|
7
|
+
Once chat mode is exited, you cannot re-enter chat mode in the same thread.
|