{
  "markdown": "# Ag-Bash: The AI-Native Shell Monorepo\n\n[![NPM Version](https://img.shields.io/npm/v/@ag-bash/bash.svg)](https://www.npmjs.com/package/@ag-bash/bash)\n[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://github.com/sairam0424/ag-bash/blob/main/LICENSE)\n[![Quality](https://github.com/sairam0424/ag-bash/actions/workflows/quality.yml/badge.svg?branch=main)](https://github.com/sairam0424/ag-bash/actions/workflows/quality.yml)\n[![Tests](https://github.com/sairam0424/ag-bash/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/sairam0424/ag-bash/actions/workflows/tests.yml)\n[![CodeQL](https://github.com/sairam0424/ag-bash/actions/workflows/codeql.yml/badge.svg?branch=main)](https://github.com/sairam0424/ag-bash/actions/workflows/codeql.yml)\n[![Bench](https://github.com/sairam0424/ag-bash/actions/workflows/bench.yml/badge.svg?branch=main)](https://github.com/sairam0424/ag-bash/actions/workflows/bench.yml)\n\nAg-Bash is a production-grade, sandboxed Bash environment designed specifically for AI agents. It provides a virtualized Unix-like experience entirely in-process, featuring an in-memory filesystem, integrated runtimes for Python and JavaScript, and full support for modern agentic protocols.\n\n## 🏗️ Monorepo Architecture\n\nThis repository is organized into a modular monorepo to support independent versioning and consumption of core engine components and protocol adapters.\n\n| Package | Version | Description |\n| :--- | :--- | :--- |\n| [`@ag-bash/bash`](./packages/bash) | [![npm](https://img.shields.io/npm/v/@ag-bash/bash.svg)](https://www.npmjs.com/package/@ag-bash/bash) | **Core Engine**: The virtual shell, filesystem, and sandboxed runtimes. |\n| [`@ag-bash/mcp-server`](./packages/mcp-server) | [![npm](https://img.shields.io/npm/v/@ag-bash/mcp-server.svg)](https://www.npmjs.com/package/@ag-bash/mcp-server) | **MCP Server**: A standalone Model Context Protocol server for seamless agent integration. |\n| [`@ag-bash/agent-bridge`](./packages/agent-bridge) | [![npm](https://img.shields.io/npm/v/@ag-bash/agent-bridge.svg)](https://www.npmjs.com/package/@ag-bash/agent-bridge) | **Agent Bridge**: Terminal UI bridge for AI agent communication. |\n\n---\n\n## What's New in v6.0.0\n\n| Feature | Description |\n| :--- | :--- |\n| **ExecutionPipeline** | The composable 6-stage pipeline (normalize, parse, transform, sandbox, interpret, persist) is now the sole execution engine. The legacy monolith path has been removed. |\n| **Fork-Speculation** | `bash.fork()` creates isolated copy-on-write branches; `bash.speculate()` runs N candidates in parallel and keeps the winner. Core moat for agentic workflows. |\n| **Observations at Source** | Every command produces typed `Observation` objects with `code` and `confidence` fields, surfacing issues without blocking execution. |\n| **True Streaming** | `bash.execStream()` yields stdout/stderr chunks via AsyncGenerator as statements produce output, byte-identical to buffered exec. |\n| **RunLoop v2** | Extended with `mode`, `healer`, and `memory` configuration. AgentMemory now persists across sessions. |\n| **MCP 2025-06-18** | Protocol bumped to latest spec with back-compat preserved for 2024-11-05 clients. Code Mode slice for structured output. |\n| **Destructive Detection** | AST-based gate detects `rm -rf /`, fork bombs, and decode-pipe-to-shell patterns structurally. Default policy: WARN. |\n| **OTEL at Exec Level** | Optional `AgBashTracer` wraps each `exec()` call in an OpenTelemetry span. Zero overhead when `@opentelemetry/api` is absent. |\n\n---\n\n## Installation & Distribution\n\n**Requires Node.js >=20.6.0.** For full ESM-hook security hardening, Node.js >=23.5 is recommended.\n\nAg-Bash ships across multiple channels (current version **6.0.4**, synchronized across all npm packages):\n\n### npm library\n\n```bash\n# Core engine (recommended)\nnpm i @ag-bash/bash\n\n# With the standalone MCP server\nnpm install @ag-bash/mcp-server\n```\n\n**Subpath imports** for tree-shaking and targeted use:\n\n```typescript\nimport { Bash, createShell } from \"@ag-bash/bash\";\nimport { RunLoop } from \"@ag-bash/bash/agent-runtime\";\nimport { createTestBash } from \"@ag-bash/bash/testing\";\n```\n\n### MCP server (npx / MCP Registry)\n\nThe MCP server exposes 70 tools over stdio. Add it to Claude Code in one command (no global install needed):\n\n```bash\nclaude mcp add ag-bash -- npx -y @ag-bash/mcp-server\n# or run it directly\nnpx @ag-bash/mcp-server\n```\n\nIt is also published to the [MCP Registry](https://registry.modelcontextprotocol.io) as `io.github.sairam0424/ag-bash`.\n\n> A submission to the Docker MCP Catalog (`docker/mcp-registry`) is currently in review.\n\n### Claude Code plugin\n\n```text\n/plugin marketplace add sairam0424/ag-bash\n/plugin install ag-bash@ag-bash\n```\n\n### Homebrew (macOS)\n\n```bash\nbrew tap sairam0424/tap\nbrew install ag-bash\n```\n\nThis also installs the `ag-shell` and `ag-bash-mcp` binaries.\n\n---\n\n## 🚀 Quick Start\n\n### For Developers (Library)\n\nIf you are building an application and want to embed a sandboxed shell:\n\n```bash\nnpm install @ag-bash/bash\n```\n\n```typescript\nimport { Bash, createShell } from \"@ag-bash/bash\";\n\n// Quick instantiation\nconst bash = new Bash();\nconst result = await bash.exec('echo \"Hello Ag-Bash\"');\nconsole.log(result.stdout); // \"Hello Ag-Bash\\n\"\n\n// Or use createShell for full configuration\nconst shell = createShell({ filesystem: \"overlay\", cwd: \"/workspace\" });\nawait shell.exec(\"ls -la\");\n```\n\n### 2. Standalone CLI & Shell (Global)\n\nFor human-in-the-loop debugging and interactive use, install the Ag-Bash suite globally.\n\n#### Via Homebrew (macOS)\n\n```bash\nbrew tap sairam0424/tap\nbrew install ag-bash\n```\n\nThis installs the `ag-bash`, `ag-shell`, and `ag-bash-mcp` binaries.\n\n#### Via NPM (Cross-platform)\n\n```bash\nnpm install -g @ag-bash/bash @ag-bash/mcp-server\n```\n\n---\n\n### For AI Agents (MCP)\n\nTo provide a bash environment to your agent (e.g., in Claude Code, Claude Desktop, or Cursor), register the MCP server via `npx` — no global install required:\n\n```bash\nclaude mcp add ag-bash -- npx -y @ag-bash/mcp-server\n```\n\nOr add the server to your MCP configuration manually:\n\n```json\n{\n  \"mcpServers\": {\n    \"ag-bash\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"@ag-bash/mcp-server\"]\n    }\n  }\n}\n```\n\n---\n\n## 🛡️ Key Features\n\n- **v6.0 Architecture**: ExecutionPipeline as sole engine, fork-speculation, observations-at-source, true streaming, OTEL tracing, destructive-detection gate.\n- **v6.0 RunLoop**: Autonomous LLM execution loop with observation forwarding, AgenticHealer self-correction, AgentMemory persistence, plan-mode write-gating, and BudgetManager stopping conditions.\n- **v3.0 DI** *(Breaking)*: Dependency Injection via `ServiceContainer`, restructured `BashOptions` API with grouped sub-objects, and zero singletons.\n- **FNV-1a ASTCache**: Non-cryptographic hashing with true LRU eviction for high-frequency script execution.\n- **Pipeline Early Termination**: Static AST analysis detects `head -N` patterns and truncates upstream output.\n- **Type-Safe Core**: Eliminated `any` types from core services, interpreter, and error hierarchy (`unknown` throughout).\n- **Hardened MCP Server**: Sanitized JSON-RPC error messages (path stripping, length cap), zero console leakage from library code.\n- **Project V-Next**: (v2.5.0+) Unified Permission Architecture, Real JSON-RPC MCP Client (Stdio/HTTP), and multi-step Planning Mode.\n- **Nexus Prime Suite**: (v2.0.0+) Intelligent semantic analysis (`ag-hover`, `ag-explain`), symbol discovery, and persistent project management.\n- **Agentic Healer 2.0**: (v2.4.0+) Tool-aware recovery loop with multi-keyword semantic scoring for automated remediation.\n- **High-Fidelity Observability**: (v2.4.0+) EventEmitter-driven tool tracking with `tool:start`, `tool:progress`, and `tool:end` hooks.\n- **Tree-sitter AST Parser**: High-fidelity shell parsing for complex scripts and security analysis.\n- **Virtual Filesystem**: Choose between `InMemoryFs`, `OverlayFs` (COW), or `ReadWriteFs`.\n- **Integrated Runtimes**: Out-of-the-box support for `jq`, `sqlite3`, `python3` (WASM), and `js-exec` (QuickJS).\n- **Protocol First**: Full Model Context Protocol (MCP) support with persistent session state.\n- **Defense in Depth**: Robust sandbox prevents prototype pollution and unauthorized filesystem access.\n- **No Dependencies**: The core engine is lightweight and runs in Node.js or the Browser.\n\n## 📖 Documentation\n\n- **[User Guide](./docs/user-guide.md)**: Narrative introduction to Ag-Bash, installation, and core concepts.\n- **[Command Registry](./docs/COMMAND_REGISTRY.md)**: Categorized reference for all 110+ supported tools.\n- **[Technical Architecture](./docs/ARCHITECTURE.md)**: Deep dive into the Nexus engine, performance, and resource accounting.\n- **[Shell Engine Deep-Dive](./packages/bash/README.md)**: Technical guide for filesystem options and custom commands.\n- **[MCP Server Configuration](./packages/mcp-server/README.md)**: Agentic integration patterns and configuration.\n- **[Security & Threat Model](./THREAT_MODEL.md)**: Detailed breakdown of the sandbox architecture.\n\n## Version History\n\n| Version | Codename | Highlights |\n| :--- | :--- | :--- |\n| **v6.0** | *Pipeline* | ExecutionPipeline default, fork-speculation, streaming, OTEL, destructive gate, Node >=20.6 |\n| **v5.0** | *Hardened* | Lazy ServiceContainer, defense-in-depth default ON, SSRF prevention, ASTCache 64-bit FNV-1a |\n| **v4.1** | *Runtime* | Introduced Agent RunLoop, Trap signal handlers, Self-Healing recovery, and OpenTelemetry spans (default/extended in v6.0) |\n| **v3.0** | *Breaking Redesign* | ServiceContainer DI, new `BashOptions` grouped API, zero singletons |\n| **v2.x** | *Nexus Prime* | Agentic tools (`ag-hover`, `ag-explain`), MCP integration, Planning Mode |\n| **v1.x** | *Genesis* | Initial release, core interpreter, in-memory filesystem, basic builtins |\n\nSee the [CHANGELOG](./CHANGELOG.md) for detailed release notes.\n\n---\n\n## 📜 License\n\nApache-2.0\n",
  "bytes": 9986,
  "sha": "732608adb8a1bc91c735f7c00b55b15521c1df631fe82ed628a36912bee57ff5",
  "repo_slug": "sairam0424/ag-bash",
  "fonte": "repo",
  "truncated": false,
  "api": "https://agentalog.com/api/listings/mcp_io_github_sairam0424_ag_bash_29d3b5f3/readme"
}