ccapi-cli
v0.2.0
Published
CLI tool to launch Claude Code as an HTTP API via pm2
Downloads
102
Maintainers
Readme
ccapi-cli
ccapi 的 CLI 工具。在任意 workspace 目录下执行 ccapi start,即可通过 pm2 启动一个由 Claude Code 驱动的 API —— 支持 HTTP 和 WebSocket 传输。
安装
npm install -g ccapi-cli快速开始
1. 创建 workspace 目录并编写系统提示词:
my-api/
├── CLAUDE.md # 在这里定义 Claude 的行为
└── .claude/
└── settings.json # 可选:限制 Claude 可用的工具翻译 API 的 CLAUDE.md 示例:
你是一个专业翻译引擎。
规则:
- 只输出译文,不要解释、不要注释
- 自动检测源语言
- 默认翻译为中文,如果源语言是中文则翻译为英文
- 保持原文格式(markdown、代码块等)2. 启动服务:
cd my-api
ccapi start
# 首次启动:交互式配置(传输方式、执行模式、会话等)
# 配置保存到 ccapi.json,后续启动直接复用3. 调用 API(HTTP 模式):
curl -X POST http://localhost:3000 -H 'Content-Type: application/json' -d '{"prompt": "Hello World"}'
# {"result":"你好世界","cost":0.001,"duration_ms":1234}命令
| 命令 | 说明 |
| --------------- | ----------------- |
| ccapi start | 通过 pm2 启动服务 |
| ccapi stop | 停止服务 |
| ccapi restart | 重启服务 |
| ccapi logs | 查看日志 |
| ccapi status | 查看 pm2 状态 |
| ccapi delete | 从 pm2 移除 |
配置
首次 ccapi start 时通过交互式引导配置传输方式、执行模式、会话和认证。配置保存到 ccapi.json:
{
"transport": "http", // "http" | "ws"
"port": 3000, // 仅 HTTP 模式
"wsUrl": "", // WS 模式:中继服务器 URL
"execution": "spawn", // "spawn" | "docker"
"session": true, // 多轮会话
"maxTurns": 10,
"timeout": 300000,
}示例
参考 examples/ 目录,里面有可直接使用的 workspace 配置。
