> For the complete documentation index, see [llms.txt](https://docs.computesdk.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.computesdk.com/providers/just-bash.md).

# Just Bash

just-bash provider for ComputeSDK — local sandboxed bash execution with a virtual filesystem. No external services, containers, or authentication required.

## Installation & Setup

```bash
npm install @computesdk/just-bash
```

No environment variables or credentials are required. just-bash runs entirely locally, interpreting commands in TypeScript against an in-memory virtual filesystem.

## Usage

```typescript
import { justBash } from '@computesdk/just-bash';

const compute = justBash({});

// Create sandbox
const sandbox = await compute.sandbox.create();

// Run a command
const result = await sandbox.runCommand('echo "Hello from just-bash!"');
console.log(result.stdout); // "Hello from just-bash!"

// Clean up
await sandbox.destroy();
```

### Configuration Options

```typescript
interface JustBashConfig {
  /** Enable Python support via pyodide (disabled by default) */
  python?: boolean;
  /** Initial files to populate in the virtual filesystem */
  files?: BashOptions['files'];
  /** Initial environment variables */
  env?: Record<string, string>;
  /** Working directory (defaults to /home/user) */
  cwd?: string;
  /** Custom filesystem implementation (InMemoryFs by default; also OverlayFs, ReadWriteFs, MountableFs) */
  fs?: BashOptions['fs'];
  /** Custom commands created with defineCommand() */
  customCommands?: BashOptions['customCommands'];
  /** Network configuration for curl (disabled by default) */
  network?: BashOptions['network'];
}
```

### Supported Operations

| Method       | Supported | Notes                                                                       |
| ------------ | --------- | --------------------------------------------------------------------------- |
| `create`     | ✅         | Creates an in-process sandbox; `runtime: 'python'` also enables Python.     |
| `getById`    | ✅         | Looks up sandboxes tracked in the current process.                          |
| `list`       | ✅         |                                                                             |
| `destroy`    | ✅         | Removes the sandbox from the in-process registry.                           |
| `runCommand` | ✅         | Supports `env` and `cwd`. 60+ built-in commands (jq, awk, sed, grep, etc.). |
| `getInfo`    | ✅         |                                                                             |
| `getUrl`     | ❌         | Throws — just-bash is a local sandbox with no network capabilities.         |
| `filesystem` | ✅         | `readFile`, `writeFile`, `mkdir`, `readdir`, `exists`, `remove`.            |

### Notes

* **Local, no network** — no API keys, containers, or external services. Ideal for tests, CI, AI-agent tooling, and offline use.
* **In-memory by default** — files do not persist across process restarts unless you supply an `OverlayFs`, `ReadWriteFs`, or `MountableFs` backend via `fs`.
* **Not real processes** — commands are interpreted in TypeScript, not executed as OS processes; there is no real Node.js runtime.
* **Python via pyodide** — requires `python: true` and runs a WebAssembly-based interpreter.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.computesdk.com/providers/just-bash.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.