Skip to content

feat(tool): enhance bash tool with session persistence and safety #11381

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chindris-mihai-alexandru wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

feat(tool): enhance bash tool with session persistence and safety #11381

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 41 additions & 1 deletion packages/opencode/src/tool/bash.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ import { Truncate } from "./truncation"
const MAX_METADATA_LENGTH = 30_000
const DEFAULT_TIMEOUT = Flag.OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS || 2 * 60 * 1000

// Session storage for CWD persistence
const sessions = new Map<string, { cwd: string }>()

export const log = Log.create({ service: "bash-tool" })

const resolveWasm = (asset: string) => {
Expand Down Expand Up @@ -73,9 +76,17 @@ export const BashTool = Tool.define("bash", async () => {
.describe(
"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'",
),
session: z.string().describe("Optional session name to persist CWD between commands").optional(),
}),
async execute(params, ctx) {
const cwd = params.workdir || Instance.directory
let cwd = params.workdir || Instance.directory
if (params.session) {
const session = sessions.get(params.session)
if (session) {
cwd = session.cwd
}
}

if (params.timeout !== undefined && params.timeout < 0) {
throw new Error(`Invalid timeout value: ${params.timeout}. Timeout must be a positive number.`)
}
Expand Down Expand Up @@ -113,6 +124,14 @@ export const BashTool = Tool.define("bash", async () => {

// not an exhaustive list, but covers most common cases
if (["cd", "rm", "cp", "mv", "mkdir", "touch", "chmod", "chown", "cat"].includes(command[0])) {
// Safety Guardrails
if (command[0] === "rm" && command.includes("-rf") && command.includes("/")) {
throw new Error("Safety Block: 'rm -rf /' is not allowed.")
}
if (command[0] === "chmod" && command.includes("777")) {
throw new Error("Safety Block: 'chmod 777' is discouraged. Please use specific permissions.")
}

for (const arg of command.slice(1)) {
if (arg.startsWith("-") || (command[0] === "chmod" && arg.startsWith("+"))) continue
const resolved = await $`realpath ${arg}`
Expand All @@ -131,6 +150,27 @@ export const BashTool = Tool.define("bash", async () => {
if (!Instance.containsPath(normalized)) directories.add(normalized)
}
}

// Session CWD Persistence for 'cd'
if (command[0] === "cd" && params.session) {
const targetArg = command[1] || "~"
// Resolve the new CWD
try {
const newCwd = await $`realpath ${targetArg}`
.cwd(cwd)
.quiet()
.nothrow()
.text()
.then((x) => x.trim())

if (newCwd) {
sessions.set(params.session, { cwd: newCwd })
log.info("updated session cwd", { session: params.session, cwd: newCwd })
}
} catch (e) {
log.warn("failed to resolve session cwd", { error: e })
}
}
}

// cd covered by above check
Expand Down