basecamp/basecamp-cli
GitHub: basecamp/basecamp-cli
Basecamp 官方命令行工具,支持通过终端或 AI Agent 管理项目、待办、消息等,实现高效的项目协作自动化。
Stars: 137 | Forks: 8
#
Basecamp CLI
`basecamp` 是 Basecamp 的官方命令行界面。通过终端或 AI agent 管理项目、待办事项、消息等。
- 可独立运行或与任何 AI agent(Claude、Codex、Copilot、Gemini)配合使用
- 带有导航路径(breadcrumbs)的 JSON 输出,方便导航
- OAuth 身份验证,支持自动 token 刷新
- 包含 agent 技能和 Claude 插件
## 快速开始
```
curl -fsSL https://basecamp.com/install-cli | bash
```
就是这样。您现在可以在终端中完全访问 Basecamp 了。
## 使用方法
```
basecamp projects list # List projects
basecamp todos list --in 12345 # Todos in a project
basecamp todo "Fix bug" --in 12345 # Create todo
basecamp done 67890 # Complete todo
basecamp search "authentication" # Search across projects
basecamp files list --in 12345 # List docs & files
basecamp cards list --in 12345 # List cards (Kanban)
basecamp chat post "Hello" --in 12345 # Post to chat
basecamp comment 67890 "@Jane.Smith, done!" # Comment with @mention
```
### 输出格式
```
basecamp projects # Styled output in terminal, JSON when piped
basecamp projects --json # JSON with envelope and breadcrumbs
basecamp projects --quiet # Raw JSON data only
```
### JSON Envelope
每个命令都支持 `--json` 以获得结构化输出:
```
{
"ok": true,
"data": [...],
"summary": "5 projects",
"breadcrumbs": [{"action": "show", "cmd": "basecamp projects show "}]
}
```
导航路径(Breadcrumbs)会建议后续命令,方便人类和 agent 进行导航。
## 身份验证
采用 OAuth 2.1 并支持自动 token 刷新。首次登录会打开您的浏览器:
```
basecamp auth login # Authenticate with Basecamp
basecamp auth login --scope read # Read-only access (BC3 OAuth only, default)
basecamp auth login --scope full # Full read+write access (BC3 OAuth only)
basecamp auth token # Print token for scripts
```
### 自定义 OAuth 凭证
如需使用您自己的 OAuth 应用(例如自定义 Launchpad 集成):
| 变量 | 用途 |
|----------|---------|
| `BASECAMP_OAUTH_CLIENT_ID` | OAuth client ID |
| `BASECAMP_OAUTH_CLIENT_SECRET` | OAuth client secret |
| `BASECAMP_OAUTH_REDIRECT_URI` | 重定向 URI(必须是带显式端口的 `http://` 回环地址) |
`BASECAMP_OAUTH_CLIENT_ID` 和 `BASECAMP_OAUTH_CLIENT_SECRET` 必须同时设置。
## AI Agent 集成
`basecamp` 可与任何能运行 shell 命令的 AI agent 配合使用。
**Claude Code:** `basecamp setup claude` — 安装包含技能、hooks 和 agent 工作流支持的插件。
**其他 agent:** 让您的 agent 指向 [`skills/basecamp/SKILL.md`](skills/basecamp/SKILL.md) 以获取 Basecamp 工作流覆盖范围。
**Agent 发现:** 每个命令都支持 `--help --agent` 以获取结构化 JSON 输出(flags、注意事项、子命令)。使用 `basecamp commands --json` 获取完整目录。
有关分步设置说明,请参阅 [install.md](install.md)。
## 配置
```
~/.config/basecamp/ # Your Basecamp identity
├── credentials.json # OAuth tokens (fallback when keyring unavailable)
├── client.json # DCR client registration
└── config.json # Global preferences
~/.config/basecamp/theme/ # Tool display (optional)
└── colors.toml # TUI color scheme
~/.cache/basecamp/ # Ephemeral tool data
├── completion.json # Tab completion cache
└── resilience/ # Circuit breaker state
.basecamp/ # Per-repo (committed to git)
└── config.json # Project, account defaults
```
## 故障排除
```
basecamp doctor # Check CLI health and diagnose issues
basecamp doctor --verbose # Verbose output with details
```
## 开发
```
make build # Build binary
make test # Run Go tests
make test-e2e # Run e2e tests
make lint # Run linter
make check # All checks (fmt-check, vet, lint, test, test-e2e)
```
开发设置请参阅 [CONTRIBUTING.md](CONTRIBUTING.md)。
## 许可证
[MIT](MIT-LICENSE)
其他安装方式
**Brew / macOS** ``` brew install --cask basecamp/tap/basecamp-cli ``` **Arch Linux / Omarchy (AUR):** ``` yay -S basecamp-cli ``` **Linux (deb/rpm/apk):** ``` # 从 https://github.com/basecamp/basecamp-cli/releases/latest 下载 sudo apt install ./basecamp-cli_*_linux_amd64.deb # Debian/Ubuntu sudo dnf install ./basecamp-cli_*_linux_amd64.rpm # Fedora/RHEL sudo apk add --allow-untrusted ./basecamp-cli_*_linux_amd64.apk # Alpine ``` Arm64:在文件名中将 `arm64` 替换 `amd64`。在安装未签名的 Alpine 包之前,请验证 `checksums.txt` 中的 SHA-256 校验和。 **Scoop (Windows):** ``` scoop bucket add basecamp https://github.com/basecamp/homebrew-tap scoop install basecamp-cli ``` **Shell 脚本:** ``` curl -fsSL https://raw.githubusercontent.com/basecamp/basecamp-cli/main/scripts/install.sh | bash ``` **Nix:** ``` nix profile install github:basecamp/basecamp-cli ``` **Go install:** ``` go install github.com/basecamp/basecamp-cli/cmd/basecamp@latest ``` **GitHub Release:** 从 [Releases](https://github.com/basecamp/basecamp-cli/releases) 下载。标签:AI代理, API客户端, ASN信息, Basecamp, Claude插件, CLI, EVTX分析, Golang, Homebrew安装, Linux 内核安全, OAuth认证, PPID欺骗, WiFi技术, 协作平台, 安全编程, 待办事项, 效率工具, 日志审计, 生产力, 网络调试, 自动化, 项目管理