@tinfoilsh/tinfoil-terminal 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +27 -0
- package/Dockerfile +18 -0
- package/README.md +15 -0
- package/bin/opencode +88 -0
- package/bunfig.toml +7 -0
- package/package.json +134 -0
- package/parsers-config.ts +253 -0
- package/script/build.ts +176 -0
- package/script/postinstall.mjs +122 -0
- package/script/publish-registries.ts +187 -0
- package/script/publish.ts +70 -0
- package/script/schema.ts +47 -0
- package/src/acp/README.md +164 -0
- package/src/acp/agent.ts +1124 -0
- package/src/acp/session.ts +101 -0
- package/src/acp/types.ts +22 -0
- package/src/agent/agent.ts +284 -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 +43 -0
- package/src/auth/index.ts +73 -0
- package/src/bun/index.ts +130 -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 +69 -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 +29 -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 +1546 -0
- package/src/cli/cmd/import.ts +98 -0
- package/src/cli/cmd/mcp.ts +671 -0
- package/src/cli/cmd/models.ts +77 -0
- package/src/cli/cmd/pr.ts +112 -0
- package/src/cli/cmd/run.ts +395 -0
- package/src/cli/cmd/serve.ts +16 -0
- package/src/cli/cmd/session.ts +135 -0
- package/src/cli/cmd/stats.ts +402 -0
- package/src/cli/cmd/tui/app.tsx +743 -0
- package/src/cli/cmd/tui/attach.ts +31 -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 +124 -0
- package/src/cli/cmd/tui/component/dialog-mcp.tsx +86 -0
- package/src/cli/cmd/tui/component/dialog-model.tsx +168 -0
- package/src/cli/cmd/tui/component/dialog-provider.tsx +47 -0
- package/src/cli/cmd/tui/component/dialog-session-list.tsx +115 -0
- package/src/cli/cmd/tui/component/dialog-session-rename.tsx +31 -0
- package/src/cli/cmd/tui/component/dialog-stash.tsx +86 -0
- package/src/cli/cmd/tui/component/dialog-status.tsx +162 -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/did-you-know.tsx +85 -0
- package/src/cli/cmd/tui/component/logo.tsx +33 -0
- package/src/cli/cmd/tui/component/prompt/autocomplete.tsx +718 -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 +1083 -0
- package/src/cli/cmd/tui/component/prompt/stash.tsx +101 -0
- package/src/cli/cmd/tui/component/textarea-keybindings.ts +73 -0
- package/src/cli/cmd/tui/component/tips.ts +103 -0
- package/src/cli/cmd/tui/component/todo-item.tsx +32 -0
- package/src/cli/cmd/tui/context/args.tsx +14 -0
- package/src/cli/cmd/tui/context/directory.ts +13 -0
- package/src/cli/cmd/tui/context/exit.tsx +23 -0
- package/src/cli/cmd/tui/context/helper.tsx +25 -0
- package/src/cli/cmd/tui/context/keybind.tsx +101 -0
- package/src/cli/cmd/tui/context/kv.tsx +49 -0
- package/src/cli/cmd/tui/context/local.tsx +393 -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 +94 -0
- package/src/cli/cmd/tui/context/sync.tsx +427 -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/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 +95 -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 +1150 -0
- package/src/cli/cmd/tui/event.ts +46 -0
- package/src/cli/cmd/tui/routes/home.tsx +138 -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 +88 -0
- package/src/cli/cmd/tui/routes/session/header.tsx +105 -0
- package/src/cli/cmd/tui/routes/session/index.tsx +1897 -0
- package/src/cli/cmd/tui/routes/session/permission.tsx +416 -0
- package/src/cli/cmd/tui/routes/session/question.tsx +368 -0
- package/src/cli/cmd/tui/routes/session/sidebar.tsx +279 -0
- package/src/cli/cmd/tui/spawn.ts +46 -0
- package/src/cli/cmd/tui/thread.ts +174 -0
- package/src/cli/cmd/tui/ui/dialog-alert.tsx +57 -0
- package/src/cli/cmd/tui/ui/dialog-confirm.tsx +83 -0
- package/src/cli/cmd/tui/ui/dialog-export-options.tsx +204 -0
- package/src/cli/cmd/tui/ui/dialog-help.tsx +38 -0
- package/src/cli/cmd/tui/ui/dialog-prompt.tsx +77 -0
- package/src/cli/cmd/tui/ui/dialog-select.tsx +345 -0
- package/src/cli/cmd/tui/ui/dialog.tsx +172 -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 +128 -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 +95 -0
- package/src/cli/cmd/uninstall.ts +344 -0
- package/src/cli/cmd/upgrade.ts +67 -0
- package/src/cli/cmd/web.ts +73 -0
- package/src/cli/error.ts +57 -0
- package/src/cli/network.ts +53 -0
- package/src/cli/ui.ts +87 -0
- package/src/cli/upgrade.ts +25 -0
- package/src/command/index.ts +131 -0
- package/src/command/template/initialize.txt +10 -0
- package/src/command/template/review.txt +97 -0
- package/src/config/config.ts +1226 -0
- package/src/config/markdown.ts +41 -0
- package/src/env/index.ts +26 -0
- package/src/file/ignore.ts +83 -0
- package/src/file/index.ts +411 -0
- package/src/file/ripgrep.ts +409 -0
- package/src/file/time.ts +64 -0
- package/src/file/watcher.ts +118 -0
- package/src/flag/flag.ts +51 -0
- package/src/format/formatter.ts +359 -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 +161 -0
- package/src/installation/index.ts +205 -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 +2032 -0
- package/src/mcp/auth.ts +135 -0
- package/src/mcp/index.ts +874 -0
- package/src/mcp/oauth-callback.ts +200 -0
- package/src/mcp/oauth-provider.ts +154 -0
- package/src/patch/index.ts +622 -0
- package/src/permission/arity.ts +163 -0
- package/src/permission/index.ts +210 -0
- package/src/permission/next.ts +269 -0
- package/src/plugin/codex.ts +524 -0
- package/src/plugin/index.ts +118 -0
- package/src/project/bootstrap.ts +31 -0
- package/src/project/instance.ts +78 -0
- package/src/project/project.ts +316 -0
- package/src/project/state.ts +65 -0
- package/src/project/vcs.ts +76 -0
- package/src/provider/auth.ts +147 -0
- package/src/provider/models-macro.ts +11 -0
- package/src/provider/models.ts +86 -0
- package/src/provider/provider.ts +429 -0
- package/src/provider/sdk/openai-compatible/src/README.md +5 -0
- package/src/provider/sdk/openai-compatible/src/index.ts +2 -0
- package/src/provider/sdk/openai-compatible/src/openai-compatible-provider.ts +100 -0
- package/src/provider/sdk/openai-compatible/src/responses/convert-to-openai-responses-input.ts +303 -0
- package/src/provider/sdk/openai-compatible/src/responses/map-openai-responses-finish-reason.ts +22 -0
- package/src/provider/sdk/openai-compatible/src/responses/openai-config.ts +18 -0
- package/src/provider/sdk/openai-compatible/src/responses/openai-error.ts +22 -0
- package/src/provider/sdk/openai-compatible/src/responses/openai-responses-api-types.ts +207 -0
- package/src/provider/sdk/openai-compatible/src/responses/openai-responses-language-model.ts +1713 -0
- package/src/provider/sdk/openai-compatible/src/responses/openai-responses-prepare-tools.ts +177 -0
- package/src/provider/sdk/openai-compatible/src/responses/openai-responses-settings.ts +1 -0
- package/src/provider/sdk/openai-compatible/src/responses/tool/code-interpreter.ts +88 -0
- package/src/provider/sdk/openai-compatible/src/responses/tool/file-search.ts +128 -0
- package/src/provider/sdk/openai-compatible/src/responses/tool/image-generation.ts +115 -0
- package/src/provider/sdk/openai-compatible/src/responses/tool/local-shell.ts +65 -0
- package/src/provider/sdk/openai-compatible/src/responses/tool/web-search-preview.ts +104 -0
- package/src/provider/sdk/openai-compatible/src/responses/tool/web-search.ts +103 -0
- package/src/provider/transform.ts +654 -0
- package/src/pty/index.ts +229 -0
- package/src/question/index.ts +170 -0
- package/src/server/error.ts +36 -0
- package/src/server/mdns.ts +57 -0
- package/src/server/project.ts +79 -0
- package/src/server/question.ts +95 -0
- package/src/server/server.ts +2878 -0
- package/src/server/tui.ts +71 -0
- package/src/session/compaction.ts +225 -0
- package/src/session/index.ts +476 -0
- package/src/session/llm.ts +235 -0
- package/src/session/message-v2.ts +683 -0
- package/src/session/message.ts +189 -0
- package/src/session/processor.ts +406 -0
- package/src/session/prompt/anthropic-20250930.txt +166 -0
- package/src/session/prompt/anthropic.txt +105 -0
- package/src/session/prompt/anthropic_spoof.txt +1 -0
- package/src/session/prompt/beast.txt +147 -0
- package/src/session/prompt/build-switch.txt +5 -0
- package/src/session/prompt/codex.txt +318 -0
- package/src/session/prompt/codex_header.txt +318 -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.ts +1652 -0
- package/src/session/retry.ts +90 -0
- package/src/session/revert.ts +108 -0
- package/src/session/status.ts +76 -0
- package/src/session/summary.ts +194 -0
- package/src/session/system.ts +138 -0
- package/src/session/todo.ts +37 -0
- package/src/share/share-next.ts +194 -0
- package/src/share/share.ts +87 -0
- package/src/shell/shell.ts +67 -0
- package/src/skill/index.ts +1 -0
- package/src/skill/skill.ts +127 -0
- package/src/snapshot/index.ts +199 -0
- package/src/storage/storage.ts +226 -0
- package/src/tool/bash.ts +258 -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/codesearch.ts +132 -0
- package/src/tool/codesearch.txt +12 -0
- package/src/tool/edit.ts +645 -0
- package/src/tool/edit.txt +10 -0
- package/src/tool/external-directory.ts +33 -0
- package/src/tool/glob.ts +77 -0
- package/src/tool/glob.txt +6 -0
- package/src/tool/grep.ts +136 -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/patch.ts +201 -0
- package/src/tool/patch.txt +1 -0
- package/src/tool/question.ts +33 -0
- package/src/tool/question.txt +10 -0
- package/src/tool/read.ts +200 -0
- package/src/tool/read.txt +12 -0
- package/src/tool/registry.ts +141 -0
- package/src/tool/skill.ts +75 -0
- package/src/tool/task.ts +181 -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 +88 -0
- package/src/tool/truncation.ts +98 -0
- package/src/tool/webfetch.ts +182 -0
- package/src/tool/webfetch.txt +13 -0
- package/src/tool/websearch.ts +144 -0
- package/src/tool/websearch.txt +11 -0
- package/src/tool/write.ts +80 -0
- package/src/tool/write.txt +8 -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 +83 -0
- package/src/util/fn.ts +11 -0
- package/src/util/iife.ts +3 -0
- package/src/util/keybind.ts +102 -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/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 +54 -0
- package/src/worktree/index.ts +217 -0
- package/sst-env.d.ts +9 -0
- package/test/agent/agent.test.ts +511 -0
- package/test/bun.test.ts +53 -0
- package/test/cli/github-action.test.ts +129 -0
- package/test/cli/github-remote.test.ts +80 -0
- package/test/cli/tui/transcript.test.ts +297 -0
- package/test/config/agent-color.test.ts +66 -0
- package/test/config/config.test.ts +1235 -0
- package/test/config/markdown.test.ts +89 -0
- package/test/file/ignore.test.ts +10 -0
- package/test/file/path-traversal.test.ts +115 -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/patch/patch.test.ts +348 -0
- package/test/permission/arity.test.ts +33 -0
- package/test/permission/next.test.ts +652 -0
- package/test/permission-task.test.ts +319 -0
- package/test/plugin/codex.test.ts +123 -0
- package/test/preload.ts +65 -0
- package/test/project/project.test.ts +120 -0
- package/test/provider/amazon-bedrock.test.ts +205 -0
- package/test/provider/provider.test.ts +2127 -0
- package/test/provider/transform.test.ts +1155 -0
- package/test/question/question.test.ts +300 -0
- package/test/server/session-select.test.ts +78 -0
- package/test/session/compaction.test.ts +251 -0
- package/test/session/message-v2.test.ts +570 -0
- package/test/session/retry.test.ts +131 -0
- package/test/session/revert-compact.test.ts +285 -0
- package/test/session/session.test.ts +71 -0
- package/test/skill/skill.test.ts +185 -0
- package/test/snapshot/snapshot.test.ts +939 -0
- package/test/tool/__snapshots__/tool.test.ts.snap +9 -0
- package/test/tool/bash.test.ts +320 -0
- package/test/tool/external-directory.test.ts +126 -0
- package/test/tool/fixtures/large-image.png +0 -0
- package/test/tool/fixtures/models-api.json +33453 -0
- package/test/tool/grep.test.ts +109 -0
- package/test/tool/patch.test.ts +261 -0
- package/test/tool/read.test.ts +303 -0
- package/test/tool/truncation.test.ts +159 -0
- package/test/util/iife.test.ts +36 -0
- package/test/util/lazy.test.ts +50 -0
- package/test/util/timeout.test.ts +21 -0
- package/test/util/wildcard.test.ts +55 -0
- package/tsconfig.json +16 -0
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
import type { Argv } from "yargs"
|
|
2
|
+
import { UI } from "../ui"
|
|
3
|
+
import * as prompts from "@clack/prompts"
|
|
4
|
+
import { Installation } from "../../installation"
|
|
5
|
+
|
|
6
|
+
export const UpgradeCommand = {
|
|
7
|
+
command: "upgrade [target]",
|
|
8
|
+
describe: "upgrade opencode to the latest or a specific version",
|
|
9
|
+
builder: (yargs: Argv) => {
|
|
10
|
+
return yargs
|
|
11
|
+
.positional("target", {
|
|
12
|
+
describe: "version to upgrade to, for ex '0.1.48' or 'v0.1.48'",
|
|
13
|
+
type: "string",
|
|
14
|
+
})
|
|
15
|
+
.option("method", {
|
|
16
|
+
alias: "m",
|
|
17
|
+
describe: "installation method to use",
|
|
18
|
+
type: "string",
|
|
19
|
+
choices: ["curl", "npm", "pnpm", "bun", "brew"],
|
|
20
|
+
})
|
|
21
|
+
},
|
|
22
|
+
handler: async (args: { target?: string; method?: string }) => {
|
|
23
|
+
UI.empty()
|
|
24
|
+
UI.println(UI.logo(" "))
|
|
25
|
+
UI.empty()
|
|
26
|
+
prompts.intro("Upgrade")
|
|
27
|
+
const detectedMethod = await Installation.method()
|
|
28
|
+
const method = (args.method as Installation.Method) ?? detectedMethod
|
|
29
|
+
if (method === "unknown") {
|
|
30
|
+
prompts.log.error(`opencode is installed to ${process.execPath} and may be managed by a package manager`)
|
|
31
|
+
const install = await prompts.select({
|
|
32
|
+
message: "Install anyways?",
|
|
33
|
+
options: [
|
|
34
|
+
{ label: "Yes", value: true },
|
|
35
|
+
{ label: "No", value: false },
|
|
36
|
+
],
|
|
37
|
+
initialValue: false,
|
|
38
|
+
})
|
|
39
|
+
if (!install) {
|
|
40
|
+
prompts.outro("Done")
|
|
41
|
+
return
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
prompts.log.info("Using method: " + method)
|
|
45
|
+
const target = args.target ? args.target.replace(/^v/, "") : await Installation.latest()
|
|
46
|
+
|
|
47
|
+
if (Installation.VERSION === target) {
|
|
48
|
+
prompts.log.warn(`opencode upgrade skipped: ${target} is already installed`)
|
|
49
|
+
prompts.outro("Done")
|
|
50
|
+
return
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
prompts.log.info(`From ${Installation.VERSION} → ${target}`)
|
|
54
|
+
const spinner = prompts.spinner()
|
|
55
|
+
spinner.start("Upgrading...")
|
|
56
|
+
const err = await Installation.upgrade(method, target).catch((err) => err)
|
|
57
|
+
if (err) {
|
|
58
|
+
spinner.stop("Upgrade failed", 1)
|
|
59
|
+
if (err instanceof Installation.UpgradeFailedError) prompts.log.error(err.data.stderr)
|
|
60
|
+
else if (err instanceof Error) prompts.log.error(err.message)
|
|
61
|
+
prompts.outro("Done")
|
|
62
|
+
return
|
|
63
|
+
}
|
|
64
|
+
spinner.stop("Upgrade complete")
|
|
65
|
+
prompts.outro("Done")
|
|
66
|
+
},
|
|
67
|
+
}
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
import { Server } from "../../server/server"
|
|
2
|
+
import { UI } from "../ui"
|
|
3
|
+
import { cmd } from "./cmd"
|
|
4
|
+
import { withNetworkOptions, resolveNetworkOptions } from "../network"
|
|
5
|
+
import open from "open"
|
|
6
|
+
import { networkInterfaces } from "os"
|
|
7
|
+
|
|
8
|
+
function getNetworkIPs() {
|
|
9
|
+
const nets = networkInterfaces()
|
|
10
|
+
const results: string[] = []
|
|
11
|
+
|
|
12
|
+
for (const name of Object.keys(nets)) {
|
|
13
|
+
const net = nets[name]
|
|
14
|
+
if (!net) continue
|
|
15
|
+
|
|
16
|
+
for (const netInfo of net) {
|
|
17
|
+
// Skip internal and non-IPv4 addresses
|
|
18
|
+
if (netInfo.internal || netInfo.family !== "IPv4") continue
|
|
19
|
+
|
|
20
|
+
// Skip Docker bridge networks (typically 172.x.x.x)
|
|
21
|
+
if (netInfo.address.startsWith("172.")) continue
|
|
22
|
+
|
|
23
|
+
results.push(netInfo.address)
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
return results
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
export const WebCommand = cmd({
|
|
31
|
+
command: "web",
|
|
32
|
+
builder: (yargs) => withNetworkOptions(yargs),
|
|
33
|
+
describe: "start opencode server and open web interface",
|
|
34
|
+
handler: async (args) => {
|
|
35
|
+
const opts = await resolveNetworkOptions(args)
|
|
36
|
+
const server = Server.listen(opts)
|
|
37
|
+
UI.empty()
|
|
38
|
+
UI.println(UI.logo(" "))
|
|
39
|
+
UI.empty()
|
|
40
|
+
|
|
41
|
+
if (opts.hostname === "0.0.0.0") {
|
|
42
|
+
// Show localhost for local access
|
|
43
|
+
const localhostUrl = `http://localhost:${server.port}`
|
|
44
|
+
UI.println(UI.Style.TEXT_INFO_BOLD + " Local access: ", UI.Style.TEXT_NORMAL, localhostUrl)
|
|
45
|
+
|
|
46
|
+
// Show network IPs for remote access
|
|
47
|
+
const networkIPs = getNetworkIPs()
|
|
48
|
+
if (networkIPs.length > 0) {
|
|
49
|
+
for (const ip of networkIPs) {
|
|
50
|
+
UI.println(
|
|
51
|
+
UI.Style.TEXT_INFO_BOLD + " Network access: ",
|
|
52
|
+
UI.Style.TEXT_NORMAL,
|
|
53
|
+
`http://${ip}:${server.port}`,
|
|
54
|
+
)
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
if (opts.mdns) {
|
|
59
|
+
UI.println(UI.Style.TEXT_INFO_BOLD + " mDNS: ", UI.Style.TEXT_NORMAL, "opencode.local")
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
// Open localhost in browser
|
|
63
|
+
open(localhostUrl.toString()).catch(() => {})
|
|
64
|
+
} else {
|
|
65
|
+
const displayUrl = server.url.toString()
|
|
66
|
+
UI.println(UI.Style.TEXT_INFO_BOLD + " Web interface: ", UI.Style.TEXT_NORMAL, displayUrl)
|
|
67
|
+
open(displayUrl).catch(() => {})
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
await new Promise(() => {})
|
|
71
|
+
await server.stop()
|
|
72
|
+
},
|
|
73
|
+
})
|
package/src/cli/error.ts
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
import { ConfigMarkdown } from "@/config/markdown"
|
|
2
|
+
import { Config } from "../config/config"
|
|
3
|
+
import { MCP } from "../mcp"
|
|
4
|
+
import { Provider } from "../provider/provider"
|
|
5
|
+
import { UI } from "./ui"
|
|
6
|
+
|
|
7
|
+
export function FormatError(input: unknown) {
|
|
8
|
+
if (MCP.Failed.isInstance(input))
|
|
9
|
+
return `MCP server "${input.data.name}" failed. Note, opencode does not support MCP authentication yet.`
|
|
10
|
+
if (Provider.ModelNotFoundError.isInstance(input)) {
|
|
11
|
+
const { providerID, modelID, suggestions } = input.data
|
|
12
|
+
return [
|
|
13
|
+
`Model not found: ${providerID}/${modelID}`,
|
|
14
|
+
...(Array.isArray(suggestions) && suggestions.length ? ["Did you mean: " + suggestions.join(", ")] : []),
|
|
15
|
+
`Try: \`opencode models\` to list available models`,
|
|
16
|
+
`Or check your config (opencode.json) provider/model names`,
|
|
17
|
+
].join("\n")
|
|
18
|
+
}
|
|
19
|
+
if (Provider.InitError.isInstance(input)) {
|
|
20
|
+
return `Failed to initialize provider "${input.data.providerID}". Check credentials and configuration.`
|
|
21
|
+
}
|
|
22
|
+
if (Config.JsonError.isInstance(input)) {
|
|
23
|
+
return (
|
|
24
|
+
`Config file at ${input.data.path} is not valid JSON(C)` + (input.data.message ? `: ${input.data.message}` : "")
|
|
25
|
+
)
|
|
26
|
+
}
|
|
27
|
+
if (Config.ConfigDirectoryTypoError.isInstance(input)) {
|
|
28
|
+
return `Directory "${input.data.dir}" in ${input.data.path} is not valid. Rename the directory to "${input.data.suggestion}" or remove it. This is a common typo.`
|
|
29
|
+
}
|
|
30
|
+
if (ConfigMarkdown.FrontmatterError.isInstance(input)) {
|
|
31
|
+
return `Failed to parse frontmatter in ${input.data.path}:\n${input.data.message}`
|
|
32
|
+
}
|
|
33
|
+
if (Config.InvalidError.isInstance(input))
|
|
34
|
+
return [
|
|
35
|
+
`Configuration is invalid${input.data.path && input.data.path !== "config" ? ` at ${input.data.path}` : ""}` +
|
|
36
|
+
(input.data.message ? `: ${input.data.message}` : ""),
|
|
37
|
+
...(input.data.issues?.map((issue) => "↳ " + issue.message + " " + issue.path.join(".")) ?? []),
|
|
38
|
+
].join("\n")
|
|
39
|
+
|
|
40
|
+
if (UI.CancelledError.isInstance(input)) return ""
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
export function FormatUnknownError(input: unknown): string {
|
|
44
|
+
if (input instanceof Error) {
|
|
45
|
+
return input.stack ?? `${input.name}: ${input.message}`
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
if (typeof input === "object" && input !== null) {
|
|
49
|
+
try {
|
|
50
|
+
return JSON.stringify(input, null, 2)
|
|
51
|
+
} catch {
|
|
52
|
+
return "Unexpected error (unserializable)"
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
return String(input)
|
|
57
|
+
}
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import type { Argv, InferredOptionTypes } from "yargs"
|
|
2
|
+
import { Config } from "../config/config"
|
|
3
|
+
|
|
4
|
+
const options = {
|
|
5
|
+
port: {
|
|
6
|
+
type: "number" as const,
|
|
7
|
+
describe: "port to listen on",
|
|
8
|
+
default: 0,
|
|
9
|
+
},
|
|
10
|
+
hostname: {
|
|
11
|
+
type: "string" as const,
|
|
12
|
+
describe: "hostname to listen on",
|
|
13
|
+
default: "127.0.0.1",
|
|
14
|
+
},
|
|
15
|
+
mdns: {
|
|
16
|
+
type: "boolean" as const,
|
|
17
|
+
describe: "enable mDNS service discovery (defaults hostname to 0.0.0.0)",
|
|
18
|
+
default: false,
|
|
19
|
+
},
|
|
20
|
+
cors: {
|
|
21
|
+
type: "string" as const,
|
|
22
|
+
array: true,
|
|
23
|
+
describe: "additional domains to allow for CORS",
|
|
24
|
+
default: [] as string[],
|
|
25
|
+
},
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
export type NetworkOptions = InferredOptionTypes<typeof options>
|
|
29
|
+
|
|
30
|
+
export function withNetworkOptions<T>(yargs: Argv<T>) {
|
|
31
|
+
return yargs.options(options)
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
export async function resolveNetworkOptions(args: NetworkOptions) {
|
|
35
|
+
const config = await Config.global()
|
|
36
|
+
const portExplicitlySet = process.argv.includes("--port")
|
|
37
|
+
const hostnameExplicitlySet = process.argv.includes("--hostname")
|
|
38
|
+
const mdnsExplicitlySet = process.argv.includes("--mdns")
|
|
39
|
+
const corsExplicitlySet = process.argv.includes("--cors")
|
|
40
|
+
|
|
41
|
+
const mdns = mdnsExplicitlySet ? args.mdns : (config?.server?.mdns ?? args.mdns)
|
|
42
|
+
const port = portExplicitlySet ? args.port : (config?.server?.port ?? args.port)
|
|
43
|
+
const hostname = hostnameExplicitlySet
|
|
44
|
+
? args.hostname
|
|
45
|
+
: mdns && !config?.server?.hostname
|
|
46
|
+
? "0.0.0.0"
|
|
47
|
+
: (config?.server?.hostname ?? args.hostname)
|
|
48
|
+
const configCors = config?.server?.cors ?? []
|
|
49
|
+
const argsCors = Array.isArray(args.cors) ? args.cors : args.cors ? [args.cors] : []
|
|
50
|
+
const cors = [...configCors, ...argsCors]
|
|
51
|
+
|
|
52
|
+
return { hostname, port, mdns, cors }
|
|
53
|
+
}
|
package/src/cli/ui.ts
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import z from "zod"
|
|
2
|
+
import { EOL } from "os"
|
|
3
|
+
import { NamedError } from "@opencode-ai/util/error"
|
|
4
|
+
|
|
5
|
+
export namespace UI {
|
|
6
|
+
const LOGO = [
|
|
7
|
+
[` ███ `, ` ▄ `],
|
|
8
|
+
[` █████ `, `█▀▀▀ █▀▀█ █▀▀█ █▀▀█`],
|
|
9
|
+
[` ███████ `, `█░░░ █░░█ █░░█ █▀▀▀`],
|
|
10
|
+
[` █████████ `, `▀▀▀▀ ▀▀▀▀ ▀▀▀▀ ▀▀▀▀`],
|
|
11
|
+
[` ███████████ `, `▀█▀ ██▀ █▀▀ █ █ `],
|
|
12
|
+
[` █████████████ `, ` █ █▄▄ █▀▀ █▄▄█ `],
|
|
13
|
+
[` ███████████████ `, ` ▀ ▀▀▀ ▀▀▀ ▀ ▀ `],
|
|
14
|
+
]
|
|
15
|
+
|
|
16
|
+
export const CancelledError = NamedError.create("UICancelledError", z.void())
|
|
17
|
+
|
|
18
|
+
export const Style = {
|
|
19
|
+
TEXT_HIGHLIGHT: "\x1b[96m",
|
|
20
|
+
TEXT_HIGHLIGHT_BOLD: "\x1b[96m\x1b[1m",
|
|
21
|
+
TEXT_DIM: "\x1b[90m",
|
|
22
|
+
TEXT_DIM_BOLD: "\x1b[90m\x1b[1m",
|
|
23
|
+
TEXT_NORMAL: "\x1b[0m",
|
|
24
|
+
TEXT_NORMAL_BOLD: "\x1b[1m",
|
|
25
|
+
TEXT_WARNING: "\x1b[93m",
|
|
26
|
+
TEXT_WARNING_BOLD: "\x1b[93m\x1b[1m",
|
|
27
|
+
TEXT_DANGER: "\x1b[91m",
|
|
28
|
+
TEXT_DANGER_BOLD: "\x1b[91m\x1b[1m",
|
|
29
|
+
TEXT_SUCCESS: "\x1b[92m",
|
|
30
|
+
TEXT_SUCCESS_BOLD: "\x1b[92m\x1b[1m",
|
|
31
|
+
TEXT_INFO: "\x1b[94m",
|
|
32
|
+
TEXT_INFO_BOLD: "\x1b[94m\x1b[1m",
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
export function println(...message: string[]) {
|
|
36
|
+
print(...message)
|
|
37
|
+
Bun.stderr.write(EOL)
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
export function print(...message: string[]) {
|
|
41
|
+
blank = false
|
|
42
|
+
Bun.stderr.write(message.join(" "))
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
let blank = false
|
|
46
|
+
export function empty() {
|
|
47
|
+
if (blank) return
|
|
48
|
+
println("" + Style.TEXT_NORMAL)
|
|
49
|
+
blank = true
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
export function logo(pad?: string) {
|
|
53
|
+
const result = []
|
|
54
|
+
for (const row of LOGO) {
|
|
55
|
+
if (pad) result.push(pad)
|
|
56
|
+
result.push(Bun.color("gray", "ansi"))
|
|
57
|
+
result.push(row[0])
|
|
58
|
+
result.push("\x1b[0m")
|
|
59
|
+
result.push(row[1])
|
|
60
|
+
result.push(EOL)
|
|
61
|
+
}
|
|
62
|
+
return result.join("").trimEnd()
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
export async function input(prompt: string): Promise<string> {
|
|
66
|
+
const readline = require("readline")
|
|
67
|
+
const rl = readline.createInterface({
|
|
68
|
+
input: process.stdin,
|
|
69
|
+
output: process.stdout,
|
|
70
|
+
})
|
|
71
|
+
|
|
72
|
+
return new Promise((resolve) => {
|
|
73
|
+
rl.question(prompt, (answer: string) => {
|
|
74
|
+
rl.close()
|
|
75
|
+
resolve(answer.trim())
|
|
76
|
+
})
|
|
77
|
+
})
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
export function error(message: string) {
|
|
81
|
+
println(Style.TEXT_DANGER_BOLD + "Error: " + Style.TEXT_NORMAL + message)
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
export function markdown(text: string): string {
|
|
85
|
+
return text
|
|
86
|
+
}
|
|
87
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { Bus } from "@/bus"
|
|
2
|
+
import { Config } from "@/config/config"
|
|
3
|
+
import { Flag } from "@/flag/flag"
|
|
4
|
+
import { Installation } from "@/installation"
|
|
5
|
+
|
|
6
|
+
export async function upgrade() {
|
|
7
|
+
const config = await Config.global()
|
|
8
|
+
const method = await Installation.method()
|
|
9
|
+
const latest = await Installation.latest(method).catch(() => {})
|
|
10
|
+
if (!latest) return
|
|
11
|
+
if (Installation.VERSION === latest) return
|
|
12
|
+
|
|
13
|
+
if (config.autoupdate === false || Flag.OPENCODE_DISABLE_AUTOUPDATE) {
|
|
14
|
+
return
|
|
15
|
+
}
|
|
16
|
+
if (config.autoupdate === "notify") {
|
|
17
|
+
await Bus.publish(Installation.Event.UpdateAvailable, { version: latest })
|
|
18
|
+
return
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
if (method === "unknown") return
|
|
22
|
+
await Installation.upgrade(method, latest)
|
|
23
|
+
.then(() => Bus.publish(Installation.Event.Updated, { version: latest }))
|
|
24
|
+
.catch(() => {})
|
|
25
|
+
}
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
import { BusEvent } from "@/bus/bus-event"
|
|
2
|
+
import z from "zod"
|
|
3
|
+
import { Config } from "../config/config"
|
|
4
|
+
import { Instance } from "../project/instance"
|
|
5
|
+
import { Identifier } from "../id/id"
|
|
6
|
+
import PROMPT_INITIALIZE from "./template/initialize.txt"
|
|
7
|
+
import PROMPT_REVIEW from "./template/review.txt"
|
|
8
|
+
import { MCP } from "../mcp"
|
|
9
|
+
|
|
10
|
+
export namespace Command {
|
|
11
|
+
export const Event = {
|
|
12
|
+
Executed: BusEvent.define(
|
|
13
|
+
"command.executed",
|
|
14
|
+
z.object({
|
|
15
|
+
name: z.string(),
|
|
16
|
+
sessionID: Identifier.schema("session"),
|
|
17
|
+
arguments: z.string(),
|
|
18
|
+
messageID: Identifier.schema("message"),
|
|
19
|
+
}),
|
|
20
|
+
),
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
export const Info = z
|
|
24
|
+
.object({
|
|
25
|
+
name: z.string(),
|
|
26
|
+
description: z.string().optional(),
|
|
27
|
+
agent: z.string().optional(),
|
|
28
|
+
model: z.string().optional(),
|
|
29
|
+
mcp: z.boolean().optional(),
|
|
30
|
+
// workaround for zod not supporting async functions natively so we use getters
|
|
31
|
+
// https://zod.dev/v4/changelog?id=zfunction
|
|
32
|
+
template: z.promise(z.string()).or(z.string()),
|
|
33
|
+
subtask: z.boolean().optional(),
|
|
34
|
+
hints: z.array(z.string()),
|
|
35
|
+
})
|
|
36
|
+
.meta({
|
|
37
|
+
ref: "Command",
|
|
38
|
+
})
|
|
39
|
+
|
|
40
|
+
// for some reason zod is inferring `string` for z.promise(z.string()).or(z.string()) so we have to manually override it
|
|
41
|
+
export type Info = Omit<z.infer<typeof Info>, "template"> & { template: Promise<string> | string }
|
|
42
|
+
|
|
43
|
+
export function hints(template: string): string[] {
|
|
44
|
+
const result: string[] = []
|
|
45
|
+
const numbered = template.match(/\$\d+/g)
|
|
46
|
+
if (numbered) {
|
|
47
|
+
for (const match of [...new Set(numbered)].sort()) result.push(match)
|
|
48
|
+
}
|
|
49
|
+
if (template.includes("$ARGUMENTS")) result.push("$ARGUMENTS")
|
|
50
|
+
return result
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
export const Default = {
|
|
54
|
+
INIT: "init",
|
|
55
|
+
REVIEW: "review",
|
|
56
|
+
} as const
|
|
57
|
+
|
|
58
|
+
const state = Instance.state(async () => {
|
|
59
|
+
const cfg = await Config.get()
|
|
60
|
+
|
|
61
|
+
const result: Record<string, Info> = {
|
|
62
|
+
[Default.INIT]: {
|
|
63
|
+
name: Default.INIT,
|
|
64
|
+
description: "create/update AGENTS.md",
|
|
65
|
+
get template() {
|
|
66
|
+
return PROMPT_INITIALIZE.replace("${path}", Instance.worktree)
|
|
67
|
+
},
|
|
68
|
+
hints: hints(PROMPT_INITIALIZE),
|
|
69
|
+
},
|
|
70
|
+
[Default.REVIEW]: {
|
|
71
|
+
name: Default.REVIEW,
|
|
72
|
+
description: "review changes [commit|branch|pr], defaults to uncommitted",
|
|
73
|
+
get template() {
|
|
74
|
+
return PROMPT_REVIEW.replace("${path}", Instance.worktree)
|
|
75
|
+
},
|
|
76
|
+
subtask: true,
|
|
77
|
+
hints: hints(PROMPT_REVIEW),
|
|
78
|
+
},
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
for (const [name, command] of Object.entries(cfg.command ?? {})) {
|
|
82
|
+
result[name] = {
|
|
83
|
+
name,
|
|
84
|
+
agent: command.agent,
|
|
85
|
+
model: command.model,
|
|
86
|
+
description: command.description,
|
|
87
|
+
get template() {
|
|
88
|
+
return command.template
|
|
89
|
+
},
|
|
90
|
+
subtask: command.subtask,
|
|
91
|
+
hints: hints(command.template),
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
for (const [name, prompt] of Object.entries(await MCP.prompts())) {
|
|
95
|
+
result[name] = {
|
|
96
|
+
name,
|
|
97
|
+
mcp: true,
|
|
98
|
+
description: prompt.description,
|
|
99
|
+
get template() {
|
|
100
|
+
// since a getter can't be async we need to manually return a promise here
|
|
101
|
+
return new Promise<string>(async (resolve, reject) => {
|
|
102
|
+
const template = await MCP.getPrompt(
|
|
103
|
+
prompt.client,
|
|
104
|
+
prompt.name,
|
|
105
|
+
prompt.arguments
|
|
106
|
+
? // substitute each argument with $1, $2, etc.
|
|
107
|
+
Object.fromEntries(prompt.arguments?.map((argument, i) => [argument.name, `$${i + 1}`]))
|
|
108
|
+
: {},
|
|
109
|
+
).catch(reject)
|
|
110
|
+
resolve(
|
|
111
|
+
template?.messages
|
|
112
|
+
.map((message) => (message.content.type === "text" ? message.content.text : ""))
|
|
113
|
+
.join("\n") || "",
|
|
114
|
+
)
|
|
115
|
+
})
|
|
116
|
+
},
|
|
117
|
+
hints: prompt.arguments?.map((_, i) => `$${i + 1}`) ?? [],
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
return result
|
|
122
|
+
})
|
|
123
|
+
|
|
124
|
+
export async function get(name: string) {
|
|
125
|
+
return state().then((x) => x[name])
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
export async function list() {
|
|
129
|
+
return state().then((x) => Object.values(x))
|
|
130
|
+
}
|
|
131
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
Please analyze this codebase and create an AGENTS.md file containing:
|
|
2
|
+
1. Build/lint/test commands - especially for running a single test
|
|
3
|
+
2. Code style guidelines including imports, formatting, types, naming conventions, error handling, etc.
|
|
4
|
+
|
|
5
|
+
The file you create will be given to agentic coding agents (such as yourself) that operate in this repository. Make it about 150 lines long.
|
|
6
|
+
If there are Cursor rules (in .cursor/rules/ or .cursorrules) or Copilot rules (in .github/copilot-instructions.md), make sure to include them.
|
|
7
|
+
|
|
8
|
+
If there's already an AGENTS.md, improve it if it's located in ${path}
|
|
9
|
+
|
|
10
|
+
$ARGUMENTS
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
You are a code reviewer. Your job is to review code changes and provide actionable feedback.
|
|
2
|
+
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
Input: $ARGUMENTS
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Determining What to Review
|
|
10
|
+
|
|
11
|
+
Based on the input provided, determine which type of review to perform:
|
|
12
|
+
|
|
13
|
+
1. **No arguments (default)**: Review all uncommitted changes
|
|
14
|
+
- Run: `git diff` for unstaged changes
|
|
15
|
+
- Run: `git diff --cached` for staged changes
|
|
16
|
+
|
|
17
|
+
2. **Commit hash** (40-char SHA or short hash): Review that specific commit
|
|
18
|
+
- Run: `git show $ARGUMENTS`
|
|
19
|
+
|
|
20
|
+
3. **Branch name**: Compare current branch to the specified branch
|
|
21
|
+
- Run: `git diff $ARGUMENTS...HEAD`
|
|
22
|
+
|
|
23
|
+
4. **PR URL or number** (contains "github.com" or "pull" or looks like a PR number): Review the pull request
|
|
24
|
+
- Run: `gh pr view $ARGUMENTS` to get PR context
|
|
25
|
+
- Run: `gh pr diff $ARGUMENTS` to get the diff
|
|
26
|
+
|
|
27
|
+
Use best judgement when processing input.
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## Gathering Context
|
|
32
|
+
|
|
33
|
+
**Diffs alone are not enough.** After getting the diff, read the entire file(s) being modified to understand the full context. Code that looks wrong in isolation may be correct given surrounding logic—and vice versa.
|
|
34
|
+
|
|
35
|
+
- Use the diff to identify which files changed
|
|
36
|
+
- Read the full file to understand existing patterns, control flow, and error handling
|
|
37
|
+
- Check for existing style guide or conventions files (CONVENTIONS.md, AGENTS.md, .editorconfig, etc.)
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## What to Look For
|
|
42
|
+
|
|
43
|
+
**Bugs** - Your primary focus.
|
|
44
|
+
- Logic errors, off-by-one mistakes, incorrect conditionals
|
|
45
|
+
- If-else guards: missing guards, incorrect branching, unreachable code paths
|
|
46
|
+
- Edge cases: null/empty/undefined inputs, error conditions, race conditions
|
|
47
|
+
- Security issues: injection, auth bypass, data exposure
|
|
48
|
+
- Broken error handling that swallows failures, throws unexpectedly or returns error types that are not caught.
|
|
49
|
+
|
|
50
|
+
**Structure** - Does the code fit the codebase?
|
|
51
|
+
- Does it follow existing patterns and conventions?
|
|
52
|
+
- Are there established abstractions it should use but doesn't?
|
|
53
|
+
- Excessive nesting that could be flattened with early returns or extraction
|
|
54
|
+
|
|
55
|
+
**Performance** - Only flag if obviously problematic.
|
|
56
|
+
- O(n²) on unbounded data, N+1 queries, blocking I/O on hot paths
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
|
|
60
|
+
## Before You Flag Something
|
|
61
|
+
|
|
62
|
+
**Be certain.** If you're going to call something a bug, you need to be confident it actually is one.
|
|
63
|
+
|
|
64
|
+
- Only review the changes - do not review pre-existing code that wasn't modified
|
|
65
|
+
- Don't flag something as a bug if you're unsure - investigate first
|
|
66
|
+
- Don't invent hypothetical problems - if an edge case matters, explain the realistic scenario where it breaks
|
|
67
|
+
- If you need more context to be sure, use the tools below to get it
|
|
68
|
+
|
|
69
|
+
**Don't be a zealot about style.** When checking code against conventions:
|
|
70
|
+
|
|
71
|
+
- Verify the code is *actually* in violation. Don't complain about else statements if early returns are already being used correctly.
|
|
72
|
+
- Some "violations" are acceptable when they're the simplest option. A `let` statement is fine if the alternative is convoluted.
|
|
73
|
+
- Excessive nesting is a legitimate concern regardless of other style choices.
|
|
74
|
+
- Don't flag style preferences as issues unless they clearly violate established project conventions.
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
## Tools
|
|
79
|
+
|
|
80
|
+
Use these to inform your review:
|
|
81
|
+
|
|
82
|
+
- **Explore agent** - Find how existing code handles similar problems. Check patterns, conventions, and prior art before claiming something doesn't fit.
|
|
83
|
+
- **Exa Code Context** - Verify correct usage of libraries/APIs before flagging something as wrong.
|
|
84
|
+
- **Exa Web Search** - Research best practices if you're unsure about a pattern.
|
|
85
|
+
|
|
86
|
+
If you're uncertain about something and can't verify it with these tools, say "I'm not sure about X" rather than flagging it as a definite issue.
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## Output
|
|
91
|
+
|
|
92
|
+
1. If there is a bug, be direct and clear about why it is a bug.
|
|
93
|
+
2. Clearly communicate severity of issues. Do not overstate severity.
|
|
94
|
+
3. Critiques should clearly and explicitly communicate the scenarios, environments, or inputs that are necessary for the bug to arise. The comment should immediately indicate that the issue's severity depends on these factors.
|
|
95
|
+
4. Your tone should be matter-of-fact and not accusatory or overly positive. It should read as a helpful AI assistant suggestion without sounding too much like a human reviewer.
|
|
96
|
+
5. Write so the reader can quickly understand the issue without reading too closely.
|
|
97
|
+
6. AVOID flattery, do not give any comments that are not helpful to the reader. Avoid phrasing like "Great job ...", "Thanks for ...".
|