diff --git a/README.md b/README.md new file mode 100644 index 0000000..d44d409 --- /dev/null +++ b/README.md @@ -0,0 +1,290 @@ +# MyClaude + +一个基于 Claude Code 的个人助理工具,支持通过飞书机器人进行远程交互。 + +## 功能特性 + +- 🤖 多模型支持:Claude、DeepSeek、Kimi、Kimi Code +- 💬 飞书机器人集成:随时随地与 AI 助手对话 +- 📝 智能记忆:自动保存对话历史和项目上下文 +- 🔧 技能扩展:支持自定义 Skill 增强功能 + +## 视频教程 + +📺 **部署流程详解**:[Bilibili - MyClaude 完整部署指南](https://www.bilibili.com/video/BV15TPrzeELm/) + +## 快速开始 + +### 1. 安装 Claude Code + +**macOS/Linux:** + +```bash +curl -fsSL https://claude.ai/install.sh | sh +# 或使用 npm: npm install -g @anthropic-ai/claude-code +``` + +**Windows:** + +```powershell +irm https://claude.ai/install.ps1 | iex +# 或: winget install Anthropic.ClaudeCode +``` + +> **注意**:Windows 用户需先安装 [Git for Windows](https://git-scm.com/download/win) +> +> **💡 认证提示**:运行 `claude login` 后,建议选择 **方案 2 (API Key)**,但将 API Token 留空。这样 Claude 会使用 cc-switch 的配置,方便后续通过 cc-switch 切换不同模型。 +> +> **来源**:[Claude Code 官方文档](https://code.claude.com/docs/en/quickstart) + +### 2. 开通大模型会员(推荐) + +| 服务 | 说明 | 开通地址 | +|------|------|---------| +| DeepSeek | 国产高性能大模型 | https://platform.deepseek.com | +| Kimi | 长文本处理专家,API 按量计费 | https://kimi.moonshot.cn | +| Kimi Code | 代码专用模型,包月/包年订阅更实惠 | Kimi 内开通 Code 会员 | + +### 3. 安装 cc-switch(多模型切换) + +**macOS:** + +```bash +brew tap farion1231/tap +brew install cc-switch +``` + +**Windows:** + +1. 访问 https://github.com/farion1231/cc-switch/releases +2. 下载 `.msi` 安装包运行 + +**配置模型:** + +```bash +cc-switch add deepseek --api-key YOUR_KEY +cc-switch add kimi --api-key YOUR_KEY +cc-switch default claude +``` + +### 4. 安装 Metabot + +**快速安装:** + +```bash +# macOS/Linux +curl -fsSL https://raw.githubusercontent.com/xvirobotics/metabot/main/install.sh | bash + +# Windows (PowerShell) +irm https://raw.githubusercontent.com/xvirobotics/metabot/main/install.ps1 | iex +``` + +安装器会引导完成:工作目录设置 → Claude 认证 → IM 平台选择 → 机器人配置 → PM2 自启动 + +### 5. 配置飞书机器人 + +#### 5.1 创建飞书应用 + +1. 访问 [飞书开发者平台](https://open.feishu.cn/) +2. 创建企业自建应用,添加「机器人」能力 +3. 获取 **AppID** 和 **AppSecret** +4. 开通权限: + - `im:message` - 发送消息 + - `im:message:readonly` - 读取消息 + - `im:resource` - 上传下载资源 +5. **事件订阅**:在「事件与回调」中,订阅 `im.message.receive_v1` 事件(接收用户消息) + - 订阅方式选择「长连接」(无需公网 IP) + - 或在「请求地址配置」中填写回调 URL(需要 HTTPS) + +#### 5.2 配置 bots.json + +在 `metabot/bots.json` 创建配置(与 myclaude 项目同级目录): + +```json +{ + "feishuBots": [ + { + "name": "myclaude", + "feishuAppId": "cli_xxxxx", + "feishuAppSecret": "xxxxxxxxxxxxx", + "defaultWorkingDirectory": "~/Documents/myResearch/myProjects/apaam/repo/myclaude" + } + ] +} +``` + +> 💡 提示:飞书应用需要先发布,再开启「长连接」事件订阅 + +--- + +## 使用指南 + +### 配置环境变量(首次) + +将 `metabot` 和 `myclaude` 命令添加到 PATH,方便全局调用: + +```bash +# 编辑 zshrc +vim ~/.zshrc + +# 添加以下行(根据实际安装路径调整) +export PATH="$PATH:$HOME/.metabot/bin" +export PATH="$PATH:$HOME/.local/bin" + +# 使配置生效 +source ~/.zshrc +``` + +> 💡 **提示**:Metabot 安装器通常会将命令安装到 `~/.metabot/bin/` 或 `~/.local/bin/`,请根据实际路径调整。 + +### 启动服务 + +```bash +# 启动飞书机器人 +metabot start + +# 本地交互模式 +myclaude chat +``` + +### 首次使用 + +告诉 Claude: + +> "我是第一次使用,请引导式地问我一些问题,帮我建立个性化配置并更新到 CLAUDE.md 中。" + +这会帮你设置:身份背景、技术栈、沟通偏好、工作模式等。 + +### 日常交互 + +**方式 1:飞书对话** +- 在飞书中找到机器人 +- 直接发送消息即可对话 + +**方式 2:本地终端** + +```bash +cd ~/Documents/myResearch/myProjects/apaam/repo/myclaude +myclaude chat +``` + +--- + +## 进阶配置 + +### Skill 管理 + +**方式 1:让 Claude 帮你找** + +```bash +# 安装 find-skills +npx skills add -g shubhamsaboo/awesome-llm-apps@find-skills +/skill skills-sync +``` + +然后直接对话: +> "帮我找一个能处理 PDF 的 skill" 或 "我想找个前端设计的 skill" + +**方式 2:手动安装** + +```bash +# 项目级(仅当前项目) +mkdir -p .claude/skills/my-skill +cp SKILL.md .claude/skills/my-skill/ + +# 全局(所有项目) +mkdir -p ~/.claude/skills/my-skill +cp SKILL.md ~/.claude/skills/my-skill/ +``` + +**推荐 Skills:** + +| Skill | 用途 | 安装 | +|-------|------|------| +| `pdf` | PDF 处理 | `npx skills add -g anthropic/skills@pdf` | +| `git-proxy-clone` | 加速 Git 下载 | `npx skills add -g xvirobotics/metabot@git-proxy-clone` | +| `metabot` | 飞书 API 调用 | `npx skills add -g xvirobotics/metabot@metabot` | +| `metamemory` | 共享知识库 | `npx skills add -g xvirobotics/metabot@metamemory` | + +### Workspace 与资料管理 + +**创建项目工作区**(告诉 Claude 让它帮你操作): + +> "在 workspace 下创建 myproject 目录,并链接我的 Works 文件夹和 iCloud 知识库" + +Claude 会自动执行: +- 创建 `workspace/myproject/` +- 建立软连接到常用目录 +- 初始化项目结构 + +**Obsidian 集成**(可选): + +告诉 Claude: +> "帮我在 iCloud 创建 ClaudeWorkspace 文件夹,软连接到 workspace,并配置 Obsidian" + +优势: +- 📱 iPhone/iPad 随时查看 Claude 生成的内容 +- 📝 双向编辑(Obsidian ↔ Claude) +- 🔍 Obsidian 全文检索资料 + +--- + +## 常用指令 + +| 指令 | 说明 | +|------|------| +| `/help` | 显示帮助 | +| `/reset` | 重置对话(飞书卡住时用) | +| `/stop` | 停止当前任务 | +| `/skills` | 列出可用 skills | +| `/memory` | 查看记忆内容 | + +--- + +## 常见问题 + +**Q1: 飞书回复 error 或卡住** +发送 `/reset` 重置对话 + +**Q2: 切换模型** +```bash +cc-switch list +cc-switch use deepseek +``` + +**Q3: 飞书机器人不响应** +1. 检查 `metabot start` 是否启动 +2. 检查 `bots.json` 凭证是否正确 +3. 飞书应用是否已发布、长连接是否开启 + +**Q4: Windows 找不到 Git Bash** +在 `~/.claude/settings.json` 添加: +```json +{ + "env": { + "CLAUDE_CODE_GIT_BASH_PATH": "C:\\Program Files\\Git\\bin\\bash.exe" + } +} +``` + +--- + +## 项目结构 + +``` +myclaude/ +├── .claude/ +│ ├── skills/ # 自定义技能 +│ ├── memory/ # 持久化记忆 +│ └── conversations/ # 对话记录 +├── workspace/ # 工作目录 +│ ├── archives/ # 归档资料 +│ ├── references/ # 参考资料 +│ └── templates/ # 常用模板 +├── CLAUDE.md # 项目配置(自动生成) +└── README.md # 本文件 +``` + +## License + +MIT