bash-tool weekly downloads statistics

bash-tool

Generic bash tool for AI agents, compatible with AI SDK.

Installation

For full VM support, install @vercel/sandbox or another sandbox product instead of just-bash.

Usage

Using AI SDK 6? Import stepCountIs instead of isStepCount, and use stopWhen: stepCountIs(20).

Tools

The tools object contains three tools that can be used by AI agents:

bash

Execute bash commands in the sandbox environment. For analysis agents, this may be the only tool you need to give to the agent.

Input:

• command (string): The bash command to execute

Returns:

• stdout (string): Standard output from the command • stderr (string): Standard error from the command • exitCode (number): Exit code of the command

readFile

Read the contents of a file from the sandbox.

Input:

• path (string): The path to the file to read

Returns:

• content (string): The file contents

writeFile

Write content to a file in the sandbox. Creates parent directories if needed.

Input:

• path (string): The path where the file should be written • content (string): The content to write to the file

Returns:

• success (boolean): true if the write succeeded

Advanced Usage

Upload a local directory

Use @vercel/sandbox for full VM

Persistent sandbox across serverless invocations

Use Sandbox.get to reconnect to an existing sandbox by ID:

Use a custom just-bash instance

Intercept bash commands

Custom sandbox implementation

Skills (Experimental)

Skills are modular capabilities that extend agent functionality. Each skill is a directory containing a SKILL.md file with instructions and optional scripts.

Full Example and see Skills.sh for a directory of publicly available skills.

Skill Directory Structure

See the example skills for a complete reference.

AI Agent Instructions

For AI agents working with bash-tool, additional guidance is available in AGENTS.md:

License

MIT

Description from the npm listing.