Gru Sandbox

🚀 gbox - 強大的容器化工具

gbox 是一款功能強大的容器化工具，旨在助力開發者輕鬆管理 sandbox 容器。它提供了一套完整的命令行界面（CLI），可用於創建、啟動、停止和刪除容器，還支持與 MCP 服務器集成，為容器管理帶來極大便利。

🚀 快速開始

gbox 提供了豐富的功能，通過它您可以：

• 利用 Docker 兼容的卷 mounts，輕鬆將主機目錄與容器目錄進行映射。
• 靈活配置和導出 MCP 配置，以便與 Claude Desktop 等工具進行交互。
• 便捷地檢查和管理正在運行的容器。
• 快速開發和構建新的功能。

✨ 主要特性

• 完整的命令行界面：提供創建、啟動、停止和刪除容器等操作的命令。
• MCP 服務器集成：支持與 MCP 服務器集成，方便配置和導出 MCP 配置。
• Docker 兼容卷掛載：可將主機目錄與容器目錄進行映射。
• 功能開發便捷：有助於快速開發和構建新功能。

📦 安裝指南

通過系統包管理器安裝

# Debian/Ubuntu 系統
sudo apt-get install gbox

# CentOS/RHEL 系統
sudo yum install gbox

手動安裝

下載最新版本的 gbox 並按照 官方文檔 中的說明進行安裝。

💻 使用示例

基礎用法

容器管理

# 創建新容器
gbox box create --image 鏡像名稱 [--env 環境變量] [-w 工作目錄] [-v 主機路徑:容器路徑[:只讀][:傳播模式]]

# 列出所有容器
gbox box list

# 啟動指定容器
gbox box start <容器ID>

# 停止指定容器
gbox box stop <容器ID>

# 刪除指定容器
gbox box delete <容器ID>

# 在容器內執行命令
gbox box exec <容器ID> -- <可執行文件> [<參數>...]

# 查看容器詳細信息
gbox box inspect <容器ID>

MCP 配置

# 導出 MCP 配置
gbox mcp export

# 將配置合併到 Claude Desktop 中
gbox mcp export --merge-to claude

# 預覽合併結果而不實際應用更改
gbox mcp export --dry-run

高級用法

體積掛載

gbox box create 命令支持 Docker 兼容的卷掛載格式：

-v /主機路徑:/容器路徑[:只讀][:傳播模式]

示例

# 基本綁定掛載
gbox box create -v /data:/data --image python:3.9

# 只讀綁定掛載
gbox box create -v /data:/data:ro

# 多個綁定掛載
gbox box create \
  -v /config:/etc/myapp \
  -v /data:/var/lib/myapp:ro \
  -v /logs:/var/log/myapp:ro:rprivate \
  --image python:3.9

⚠️ 重要提示

主機路徑必須在創建容器之前存在，容器路徑將在需要時自動創建。

📚 詳細文檔

開發環境搭建

先決條件

• Go 1.21 或更高版本
• Docker Desktop
• Make 工具
• pnpm（通過 corepack 安裝）
• Node.js 16.13 或更高版本

編譯項目

# 編譯所有組件
make build

# 創建發行版包
make dist

運行服務

# 啟動 API 服務器
npm run dev

# 測試 API 服務器
npm test

# 執行類型檢查
npm run type-check

貢獻指南

歡迎任何貢獻！請參考 CONTRIBUTING.md 文件獲取詳細信息。

提交規範

• 為每個提交提供清晰的描述。
• 在合併請求中包含相關的測試用例和文檔更新。
• 遵循代碼風格指南。

📄 許可證

本項目受 MIT 許可證 保護。