README.md

metadata

title: CLIProxyAPI
emoji: 😻
colorFrom: purple
colorTo: yellow
sdk: docker
pinned: false
app_port: 8317

CLIProxyAPI

CLIProxyAPI 是一个基于 Hugging Face Spaces 部署的 API 代理服务，用于提供 CLI 工具的 Web API 接口。

功能特性

• 提供 CLI 工具的 HTTP API 接口
• 支持多种命令行工具的远程调用
• 基于 Docker 容器化部署
• 适用于 Hugging Face Spaces 环境
• 支持通过环境变量自定义配置

部署信息

本部署使用以下 Docker 镜像：

• 镜像名称：ghcr.io/gdtiti/cliproxy-api:1.1
• 基础环境：Python
• 端口：8317 (CLIProxyAPI 默认端口)

环境变量配置

Gemini CLI 配置

您可以通过以下环境变量自定义 Gemini CLI 的镜像节点配置：

• GEMINI_CODE_ASSIST_ENDPOINT: Code Assist API 端点（必配）
• GEMINI_OAUTH_ENDPOINT: OAuth2 认证端点（必配）
• GEMINI_GOOGLE_APIS_ENDPOINT: Google APIs 基础端点（必配）
• GEMINI_RESOURCE_MANAGER_ENDPOINT: Resource Manager API 端点（可选）
• GEMINI_SERVICE_USAGE_ENDPOINT: Service Usage API 端点（可选）

远程管理配置

您可以通过以下环境变量自定义远程管理设置：

• REMOTE_MANAGEMENT_ALLOW_REMOTE: 是否允许远程管理访问（true/false）
• REMOTE_MANAGEMENT_SECRET_KEY: 管理密钥（如果设置，将覆盖配置文件中的默认值）

使用方法

部署完成后，您可以通过以下方式访问 API：

1. 直接访问 Space 页面查看 API 文档
2. 发送 HTTP 请求到 API 端点

API 端点示例

# 基本健康检查
curl https://your-space.hf.space/health

# 执行命令
curl -X POST https://your-space.hf.space/api/execute \
  -H "Content-Type: application/json" \
  -d '{"command": "ls -la"}'

配置说明

本部署使用以下环境变量：

• PORT=8317: 服务端口
• HOST=0.0.0.0: 监听地址

开发与部署

如需在本地开发或自定义部署，请参考原始项目 CLIProxyAPI。

许可证

请参考原始项目的许可证条款。

---

Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference