Sidekick CLI：一个开源的 Claude Code 替代工具

Derniers outils d'IAPosté il y a 3 mois Sharenet.ai

506 0

Introduction générale

Sidekick CLI 是一个开源的命令行工具，旨在通过 AI 辅助简化开发者的项目开发和部署流程。它受到 Claude Code、Copilot 和 Curseur 的启发，提供类似的功能，但允许用户自由选择大型语言模型（LLM）提供商，避免厂商锁定。Sidekick CLI 采用“CLI 优先”设计，支持 Model Context Protocol（MCP）服务器，扩展了 AI 交互能力。它适合独立开发者或小型团队，能快速配置项目、部署到 VPS，并通过 AI 提供代码生成和调试支持。目前项目处于 Beta 阶段，托管在 GitHub，由开发者 Gavin Vickery（geekforbrains）维护，采用 MIT 许可证，欢迎社区贡献和反馈。

Liste des fonctions

AI 辅助开发：通过自然语言提示生成代码、调试问题或查询文档，支持多种 LLM 提供商。
灵活模型切换：在同一会话中无缝切换不同 AI 模型，适应不同任务需求。
MCP 服务器支持：连接外部工具和数据源，增强 AI 功能，如 GitHub 代码检索。
项目导引文件: à travers SIDEKICK.md 自定义项目的技术栈和开发偏好。
VPS 一键部署：自动配置 VPS 环境，安装 Docker 和 Traefik，支持 HTTPS 域名。
撤销功能: Utilisation /undo 快速撤销 AI 造成的错误更改。
成本与令牌追踪：监控 LLM 使用成本和令牌消耗，设置预算限制。
遥测控制: à travers --no-telemetry 禁用 Sentry 错误追踪和使用分析。
命令确认控制: Soutien /yolo 模式跳过确认，或按会话调整确认设置。

Utiliser l'aide

Processus d'installation

Sidekick CLI 的安装简单，支持通过 pip 或源码安装。以下是详细步骤：

检查系统要求
确保系统已安装 Python 3.8+ 和 pip。Windows 用户建议安装 Git Bash 或 WSL 以获得更好的终端体验。macOS 和 Linux 用户无需额外配置。
通过 pip 安装
运行以下命令安装 Sidekick CLI：
```
pip install sidekick-cli
```

安装完成后，检查版本：

sidekick --version

Installation à partir de la source（适合开发者）
克隆 GitHub 仓库：
```
git clone https://github.com/geekforbrains/sidekick-cli.git
cd sidekick-cli
```
Installer la dépendance :
```
pip install .
```
若需开发模式（代码修改实时生效），运行：
```
pip install -e .
```
初始配置
首次运行 Sidekick CLI：
```
sidekick
```
系统会提示配置 LLM 提供商（如 OpenAI、Anthropic）。配置信息保存在 ~/.config/sidekick.json。示例配置：
```
{
"llm_providers": {
"openai": {
"api_key": "<你的API密钥>",
"model": "gpt-4"
}
},
"mcpServers": {
"fetch": {
"command": "uvx",
"args": ["mcp-server-fetch"]
}
}
}
```
你可以手动编辑该文件，添加更多 LLM 提供商或 MCP 服务器。
Vérifier l'installation
运行以下命令确认 Sidekick CLI 正常工作：
```
sidekick --version
```
若返回版本号（如 0.1.0），安装成功。

Guide d'utilisation des fonctions

1. AI 辅助开发

Sidekick CLI 的核心功能是 AI 辅助开发。运行以下命令生成代码：

sidekick generate --prompt "编写一个 Flask REST API"

AI 会根据提示生成代码并保存到指定文件。你还可以调试代码：

sidekick debug --file app.py

此命令分析代码，指出错误并提供修复建议。若 AI 修改造成问题，可使用撤销功能：

sidekick /undo

撤销操作会恢复最近的更改，适合快速修复错误。

2. 灵活模型切换

Sidekick CLI 允许在会话中切换 AI 模型。查看可用模型：

sidekick /model

Exemple de sortie :

0: gpt-4 (OpenAI)
1: claude-3 (Anthropic)

切换到特定模型：

sidekick /model 0

此功能适合根据任务需求选择更合适的模型。

3. MCP 服务器支持

MCP 服务器扩展了 Sidekick CLI 的能力。例如，配置 GitHub MCP 服务器以检索代码：

{
"mcpServers": {
"github": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-github"],
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "<你的GitHub令牌>"
}
}
}
}

保存后，运行以下命令测试 MCP 功能：

sidekick fetch --repo <GitHub仓库地址>

MCP 服务器让 AI 能直接访问外部数据源，增强代码生成和分析能力。

4. 项目导引文件

Sidekick CLI 支持在项目根目录创建 SIDEKICK.md 文件，定义项目的技术栈和开发偏好。示例 SIDEKICK.md: :

# Sidekick Guide
- Tech Stack: Python, Flask, PostgreSQL
- Coding Style: PEP 8
- Project Structure: MVC
- Preferred LLM: gpt-4

创建后，Sidekick CLI 会根据该文件调整 AI 行为。运行以下命令应用导引：

sidekick init

5. VPS 一键部署

Sidekick CLI 简化 VPS 部署，适合 Ubuntu 20.04+ 系统。运行以下命令：

sidekick deploy --vps <VPS_IP地址>

Sidekick CLI 会自动：

配置 SSH 和用户权限。
安装 Docker 和 Traefik。
设置 HTTPS（默认使用 sslip.io 免费域名）。
检查部署状态：

sidekick status

更新应用：

sidekick deploy --update

此功能支持零停机部署，适合快速上线项目。

6. 成本与令牌追踪

Sidekick CLI 提供 LLM 使用监控。查看当前消耗：

sidekick cost

输出包括令牌数和费用估算。设置预算：

sidekick cost --set-budget 20.0

当费用接近预算时，Sidekick CLI 会发出警告。

7. 遥测控制

Sidekick CLI 默认启用 Sentry 遥测，收集错误和使用数据。禁用遥测：

sidekick --no-telemetry

此命令确保隐私敏感用户可完全关闭数据收集。

8. 命令确认控制

为加速操作，启用“yolo”模式跳过确认：

sidekick /yolo

恢复确认：

sidekick /yolo off

你也可以通过配置文件设置默认行为：

{
"skip_confirm": true
}

常用命令

/help：显示所有命令。
/clear：清除消息历史。
/compact：总结消息历史并清除旧记录。
/dump：显示当前消息历史（用于调试）。
exit：退出 Sidekick CLI。

mise en garde

API 密钥安全：确保 ~/.config/sidekick.json 中的密钥不泄露。
VPS 要求：部署需开放 SSH 端口（默认 22）和公网 IP。
Beta 阶段限制：当前版本可能存在 bug，建议关注 GitHub 仓库更新。

scénario d'application

Prototypage rapide
开发者需快速构建 Web 应用原型。Sidekick CLI 通过 AI 生成代码和自动化配置，几天内即可完成从想法到部署的流程。
低成本 VPS 部署
小型团队希望在低预算 VPS 上运行应用。Sidekick CLI 提供一键部署和成本追踪，确保高效利用资源。
AI 驱动的学习
初学者通过 Sidekick CLI 的 AI 功能学习新框架。输入自然语言提示即可生成示例代码，并通过调试功能理解代码逻辑。

QA

Sidekick CLI 是否需要始终联网？
是的，AI 功能依赖 LLM 提供商的 API，需联网。MCP 服务器和 VPS 部署也需网络连接。
如何禁用遥测？
être en mouvement sidekick --no-telemetry 或在 sidekick.json 中设置 "telemetry": false.
支持哪些 LLM 提供商？
当前支持 OpenAI、Anthropic 等，未来将添加 Ollama 等本地模型（见 Roadmap）。
如何贡献代码？
克隆仓库，安装开发依赖（make install），提交 Pull Request 至 GitHub。