import { Schema } from "effect" import DESCRIPTION from "./shell.txt" import { PositiveInt } from "@opencode-ai/core/schema" import { Global } from "@opencode-ai/core/global" import { ShellID } from "./id" const PS = new Set(["powershell", "pwsh"]) const CMD = new Set(["cmd"]) const descriptions = { bash: "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'", powershell: 'Clear, concise description of what this command does in 5-10 words. Examples:\nInput: Get-ChildItem -LiteralPath "."\nOutput: Lists current directory\n\nInput: git status\nOutput: Shows working tree status\n\nInput: npm install\nOutput: Installs package dependencies\n\nInput: New-Item -ItemType Directory -Path "tmp"\nOutput: Creates directory tmp', cmd: 'Clear, concise description of what this command does in 5-10 words. Examples:\nInput: dir\nOutput: Lists current directory\n\nInput: if exist "package.json" type "package.json"\nOutput: Prints package.json when it exists\n\nInput: mkdir tmp\nOutput: Creates directory tmp', } export type Limits = { maxLines: number maxBytes: number } export function parameterSchema(description: string) { return Schema.Struct({ command: Schema.String.annotate({ description: "The command to execute" }), timeout: Schema.optional(PositiveInt).annotate({ description: "Optional timeout in milliseconds" }), workdir: Schema.optional(Schema.String).annotate({ description: `The working directory to run the command in. Defaults to the current directory. Use this instead of 'cd' commands.`, }), description: Schema.String.annotate({ description }), }) } export const Parameters = parameterSchema(descriptions.bash) export type Parameters = Schema.Schema.Type function renderPrompt(template: string, values: Record) { return template.replace(/\$\{(\w+)\}/g, (_, key: string) => { const value = values[key] if (value === undefined) throw new Error(`Missing shell prompt value: ${key}`) return value }) } function shellDisplayName(name: string) { if (name === "pwsh") return "PowerShell (7+)" if (name === "powershell") return "Windows PowerShell (5.1)" if (name === "cmd") return "cmd.exe" return name } function powershellNotes(name: string) { if (name === "pwsh") { return `# PowerShell (7+) shell notes - This cross-platform shell supports pipeline chain operators (\`&&\` and \`||\`). - Use double quotes for interpolated strings (\`"Hello $name"\`), single quotes for verbatim strings. - Prefer full cmdlet names like \`Get-ChildItem\`, \`Set-Content\`, \`Remove-Item\`, and \`New-Item\` over aliases. - Use \`$(...)\` for subexpressions. Use \`@(...)\` for array expressions. - To call a native executable whose path contains spaces, use the call operator: \`& "path/to/exe" args\`. - Escape special characters with the PowerShell backtick character.` } if (name === "powershell") { return `# Windows PowerShell (5.1) shell notes - Use \`cmd1; if ($?) { cmd2 }\` to chain dependent commands. - Use double quotes for interpolated strings (\`"Hello $name"\`), single quotes for verbatim strings. - Prefer full cmdlet names like \`Get-ChildItem\`, \`Set-Content\`, \`Remove-Item\`, and \`New-Item\` over aliases. - Use \`$(...)\` for subexpressions. Use \`@(...)\` for array expressions. - To call a native executable whose path contains spaces, use the call operator: \`& "path/to/exe" args\`. - Escape special characters with the PowerShell backtick character.` } return "" } function chainGuidance(name: string) { if (name === "powershell") { return "If the commands depend on each other and must run sequentially, avoid '&&' in this shell because Windows PowerShell (5.1) does not support it. Use PowerShell conditionals such as `cmd1; if ($?) { cmd2 }` when later commands must depend on earlier success." } if (PS.has(name)) { return "If the commands depend on each other and must run sequentially, use a single bash tool 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 New-Item before Copy-Item, Write before bash for git operations, or git add before git commit), run these operations sequentially instead." } if (CMD.has(name)) { return "If the commands depend on each other and must run sequentially, use a single bash tool call with `&&` to chain them together (e.g., `mkdir out && dir out`). For instance, if one operation must complete before another starts, run these operations sequentially instead." } return "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." } function bashCommandSection(chain: string, limits: Limits, defaultTimeoutMs: number) { return `Before executing the command, please follow these steps: 1. Directory Verification: - If the command will create new directories or files, first use \`ls\` to verify the parent directory exists and is the correct location - For example, before running "mkdir foo/bar", first use \`ls foo\` to check that "foo" exists and is the intended parent directory 2. Command Execution: - Always quote file paths that contain spaces with double quotes (e.g., rm "path with spaces/file.txt") - Examples of proper quoting: - mkdir "/Users/name/My Documents" (correct) - mkdir /Users/name/My Documents (incorrect - will fail) - python "/path/with spaces/script.py" (correct) - python /path/with spaces/script.py (incorrect - will fail) - After ensuring proper quoting, execute the command. - Capture the output of the command. Usage notes: - The command argument is required. - You can specify an optional timeout in milliseconds. If not specified, commands will time out after ${defaultTimeoutMs}ms. - It is very helpful if you write a clear, concise description of what this command does in 5-10 words. - If the output exceeds ${limits.maxLines} lines or ${limits.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. Do NOT use \`head\`, \`tail\`, or other truncation commands to limit output; the full output will already be captured to a file for more precise searching. - 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: - File search: Use Glob (NOT find or ls) - Content search: Use Grep (NOT grep or rg) - Read files: Use Read (NOT cat/head/tail) - Edit files: Use Edit (NOT sed/awk) - Write files: Use Write (NOT echo >/cat < && \`. Use the \`workdir\` parameter to change directories instead. Use workdir="/foo/bar" with command: pytest tests cd /foo/bar && pytest tests ` } function powershellCommandSection( name: string, chain: string, pathSep: string, limits: Limits, defaultTimeoutMs: number, ) { return `${powershellNotes(name)} Before executing the command, please follow these steps: 1. Directory Verification: - If the command will create new directories or files, first use \`Test-Path -LiteralPath \` to verify the parent directory exists and is the correct location - For example, before creating \`foo${pathSep}bar\`, first use \`Test-Path -LiteralPath "foo"\` to check that \`foo\` exists and is the intended parent directory 2. Command Execution: - Always quote file paths that contain spaces with double quotes (e.g., Remove-Item -LiteralPath "path with spaces${pathSep}file.txt") - Examples of proper quoting: - New-Item -ItemType Directory -Path "My Documents" (correct) - New-Item -ItemType Directory -Path My Documents (incorrect - path is split) - & "path with spaces${pathSep}script.ps1" (correct) - path with spaces${pathSep}script.ps1 (incorrect - path is split and not invoked) - After ensuring proper quoting, execute the command. - Capture the output of the command. Usage notes: - The command argument is required. - You can specify an optional timeout in milliseconds. If not specified, commands will time out after ${defaultTimeoutMs}ms. - It is very helpful if you write a clear, concise description of what this command does in 5-10 words. - If the output exceeds ${limits.maxLines} lines or ${limits.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. Do NOT use \`Select-Object -First\`, \`Select-Object -Last\`, or other truncation commands to limit output; the full output will already be captured to a file for more precise searching. - Avoid using Shell with PowerShell file/content cmdlets unless explicitly instructed or when these cmdlets are truly necessary for the task. Instead, always prefer using the dedicated tools for these commands: - File search: Use Glob (NOT Get-ChildItem) - Content search: Use Grep (NOT Select-String) - Read files: Use Read (NOT Get-Content) - Edit files: Use Edit (NOT Set-Content) - Write files: Use Write (NOT Set-Content/Out-File or here-strings) - Communication: Output text directly (NOT Write-Output/Write-Host) - When issuing multiple commands: - 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. - ${chain} - Use \`;\` only when you need to run commands sequentially but don't care if earlier commands fail - DO NOT use newlines to separate commands (newlines are ok in quoted strings) - AVOID changing directories inside the command. Use the \`workdir\` parameter to change directories instead. Use workdir="project${pathSep}subdir" with command: pytest tests ${name === "powershell" ? `Set-Location -LiteralPath "project${pathSep}subdir"; if ($?) { pytest tests }` : `Set-Location -LiteralPath "project${pathSep}subdir" && pytest tests`} ` } function cmdCommandSection(chain: string, limits: Limits, defaultTimeoutMs: number) { return `# cmd.exe shell notes - Use double quotes for paths with spaces. - Use %VAR% for environment variables. - Use \`if exist\` for existence checks. - Use \`call\` when invoking batch files from another batch-style command. Before executing the command, please follow these steps: 1. Directory Verification: - If the command will create new directories or files, first use \`if exist\` to verify the parent directory exists and is the correct location - For example, before creating \`foo\\bar\`, first use \`if exist "foo\\" dir "foo"\` to check that \`foo\` exists and is the intended parent directory 2. Command Execution: - Always quote file paths that contain spaces with double quotes (e.g., del "path with spaces\\file.txt") - Examples of proper quoting: - mkdir "My Documents" (correct) - mkdir My Documents (incorrect - path is split) - call "path with spaces\\script.bat" (correct) - path with spaces\\script.bat (incorrect - path is split and not invoked correctly) - After ensuring proper quoting, execute the command. - Capture the output of the command. Usage notes: - The command argument is required. - You can specify an optional timeout in milliseconds. If not specified, commands will time out after ${defaultTimeoutMs}ms. - It is very helpful if you write a clear, concise description of what this command does in 5-10 words. - If the output exceeds ${limits.maxLines} lines or ${limits.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. Do NOT use \`more\` or other pagination commands to limit output; the full output will already be captured to a file for more precise searching. - Avoid using Shell with cmd.exe file/content commands unless explicitly instructed or when these commands are truly necessary for the task. Instead, always prefer using the dedicated tools for these commands: - File search: Use Glob (NOT dir /s) - Content search: Use Grep (NOT findstr) - Read files: Use Read (NOT type) - Edit files: Use Edit (NOT copy) - Write files: Use Write (NOT echo > file) - Communication: Output text directly (NOT echo) - When issuing multiple commands: - 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 "dir" and "where cmd", send a single message with two bash tool calls in parallel. - ${chain} - Use \`&\` only when you need to run commands sequentially but don't care if earlier commands fail - DO NOT use newlines to separate commands (newlines are ok in quoted strings) - AVOID changing directories inside the command. Use the \`workdir\` parameter to change directories instead. Use workdir="project\\subdir" with command: dir cd /d "project\\subdir" && dir ` } function profile(name: string, platform: NodeJS.Platform, limits: Limits, defaultTimeoutMs: number) { const isPowerShell = PS.has(name) const chain = chainGuidance(name) if (CMD.has(name)) { return { intro: `Executes a given ${shellDisplayName(name)} command with optional timeout, ensuring proper handling and security measures.`, workdirSection: "All commands run in the current working directory by default. Use the `workdir` parameter if you need to run a command in a different directory. AVOID changing directories inside the command - use `workdir` instead.", commandSection: cmdCommandSection(chain, limits, defaultTimeoutMs), gitCommands: "git commands", gitCommandRestriction: "git commands", createPrInstruction: "Create PR using a temporary body file so cmd.exe quoting stays simple.", createPrExample: `(\n echo ## Summary\n echo - ^<1-3 bullet points^>\n) > pr-body.txt\ngh pr create --title "the pr title" --body-file pr-body.txt`, parameterDescription: descriptions.cmd, } } if (isPowerShell) { return { intro: `Executes a given ${shellDisplayName(name)} command with optional timeout, ensuring proper handling and security measures.`, workdirSection: "All commands run in the current working directory by default. Use the `workdir` parameter if you need to run a command in a different directory. AVOID changing directories inside the command - use `workdir` instead.", commandSection: powershellCommandSection( name, chain, platform === "win32" ? "\\" : "/", limits, defaultTimeoutMs, ), gitCommands: "git commands", gitCommandRestriction: "git commands", createPrInstruction: "Create PR using gh pr create with a PowerShell here-string to pass the body correctly.", createPrExample: `gh pr create --title "the pr title" --body @' ## Summary - <1-3 bullet points> '@`, parameterDescription: descriptions.powershell, } } return { intro: "Executes a given bash command in a persistent shell session with optional timeout, ensuring proper handling and security measures.", workdirSection: "All commands run in the current working directory by default. Use the `workdir` parameter if you need to run a command in a different directory. AVOID using `cd && ` patterns - use `workdir` instead.", commandSection: bashCommandSection(chain, limits, defaultTimeoutMs), gitCommands: "bash commands", gitCommandRestriction: "git bash commands", createPrInstruction: "Create PR using gh pr create with the format below. Use a HEREDOC to pass the body to ensure correct formatting.", createPrExample: `gh pr create --title "the pr title" --body "$(cat <<'EOF' ## Summary <1-3 bullet points>`, parameterDescription: descriptions.bash, } } export function render(name: string, platform: NodeJS.Platform, limits: Limits, defaultTimeoutMs: number) { const selected = profile(name, platform, limits, defaultTimeoutMs) return { description: renderPrompt(DESCRIPTION, { intro: selected.intro, os: platform, shell: name, tmp: Global.Path.tmp, workdirSection: selected.workdirSection, commandSection: selected.commandSection, gitCommands: selected.gitCommands, toolName: ShellID.ToolID, gitCommandRestriction: selected.gitCommandRestriction, createPrInstruction: selected.createPrInstruction, createPrExample: selected.createPrExample, }), parameters: parameterSchema(selected.parameterDescription), } } export * as ShellPrompt from "./prompt"