OpenCodeStarterPack

# OpenCodeStarterPack <p align="center"> <a href="#english">🇬🇧 English</a> • <a href="#russian">🇷🇺 Русский</a> </p> **一键启动套件，适用于 [OpenCode](https://opencode.ai)。** 技能、MCP 配置、规则和提示 — 模块化、可预设和可更新。 ```bash # 选择您的安装方式： curl -fsSL https://raw.githubusercontent.com/PETERGS27/OpenCodeStarterPack/main/install.sh | bash npx opencode-starter-pack # 或 npx OpenCodeStarterPack brew install https://raw.githubusercontent.com/PETERGS27/OpenCodeStarterPack/main/Formula/opencode-starter-pack.rb git clone https://github.com/PETERGS27/OpenCodeStarterPack.git ``` --- ## 快速开始（适用于 impatient） ```bash curl -fsSL https://raw.githubusercontent.com/PETERGS27/OpenCodeStarterPack/main/install.sh | bash ``` 向导将询问您的 Obsidian 保险库的位置（或创建一个新保险库），并指导您选择所需的组件。 安装后： 1. 在 **Obsidian** 中打开该文件夹（Open vault → Open folder as vault） 2. 安装 **Local REST API** 插件（设置 → 社区插件） 3. 运行 `cd <your-vault> && opencode` 4. 在 opencode 中输入 `/start` 以查看可用技能 --- ## 先决条件 在安装之前，请确保您已具备： 1. **[Obsidian](https://obsidian.md)** 已安装，至少有一个保险库已创建 2. **Node.js** >= 18 （安装程序可以为您安装） 3. **Git** （可选，用于克隆） 此启动包创建的保险库旨在 Obsidian 中打开。所有技能和规则都期望 Obsidian 是您的笔记前端。 --- ## 功能 - **8 个现成的技能** — web-extract、research、raw-processor、sandbox、mcp-manager、vault-analyzer、skill-creator 和空白模板 - **6 个 MCP 配置** — Obsidian、Docker、Git、Sandbox、ByteStash、Context7 - **规则 + AGENTS.md** — 保险库管理规则和 AI 代理指令，带有持久内存（元文件） - **5 个提示** — code-review、debug、refactor、architecture、explain - **4 个预设** — minimal、study、full、custom - **幂等** — 安全重新运行，绝不覆盖，无需确认 - **多平台** — macOS、Linux、Windows --- ## 预设 | 预设 | 保险库结构 + 规则 + 元数据 | 技能 | MCP | 提示 | |--------|:-----------------------------:|:------:|:---:|:-------:| | **minimal** | ✅ 必需 | — | — | — | | **study** | ✅ 必需 | research、web-extract、raw-processor、vault-analyzer | Obsidian、Context7 | — | | **full** | ✅ 必需 | 所有 7 个 | 所有 6 个 | 所有 5 个 | | **custom** | ✅ 必需 | 您选择 ✅ | 您选择 ✅ | 您选择 ✅ | ### minimal 仅保险库骨架、OpenCode 配置、规则和 AGENTS.md，带有持久内存。无额外内容。适用于从头开始的用户。 ### study 适用于在 Obsidian 中记笔记的学生。研究工具、网页提取、原始数据处理和保险库分析。无开发工具。 ### full 所有内容 — 所有技能、MCP 服务器、提示和规则。适用于程序员、工程师和构建自己的 AI 工具的人员。 ### custom 使用交互式复选框选择您需要的功能。 --- ## 安装 ### curl | bash（无先决条件） ```bash curl -fsSL https://raw.githubusercontent.com/PETERGS27/OpenCodeStarterPack/main/install.sh | bash ``` 如果检测到 Node.js，交互式向导将自动启动。如果未检测到，则会询问您是否要安装它。 ### npx（需要 Node.js） ```bash npx opencode-starter-pack # 或 npx OpenCodeStarterPack ``` 具有完整模块选择、配置和应用的交互式向导。 ### 标志 ```bash curl -fsSL https://.../install.sh | bash -s -- \ --preset full \ --dir ~/Documents/MyVault \ --non-interactive ``` | 标志 | 描述 | |------|-------------| | `--preset <name>` | 跳过向导，使用预设：minimal、study、full | | `--dir <path>` | 保险库的目标目录 | | `--non-interactive` | 无提示，使用所有默认值 | | `--help` | 显示用法 | ### brew（macOS） ```bash brew install https://raw.githubusercontent.com/PETERGS27/OpenCodeStarterPack/main/Formula/opencode-starter-pack.rb ``` ### git clone ```bash git clone https://github.com/PETERGS27/OpenCodeStarterPack.git cd OpenCodeStarterPack ./install.sh ``` --- ## 安装内容 ### 保险库结构 ``` vault/ ├── .opencode/ │ ├── skills/ # 从选定的模块复制 │ └── rules/ # vault-rules.md + agents-instruct.md ├── INBOX/ │ ├── AI_READED/ # 用于 web-extract 技能 │ └── RAW/ # 用于 raw-processor 技能 ├── FILES/ # 按主题组织的笔记 ├── DESKTOP/ # 活动工作区 ├── CACHE/AI/ # 元文件（AGENTS.md、STRUCTURE.md 等） ├── INDEXES/ # 阅读列表和主题索引 ├── README.md # 保险库仪表盘 └── opencode.json # OpenCode 配置与 MCP ``` ### 技能 | 技能 | 描述 | |-------|-------------| | **web-extract** | 从网页和 YouTube 视频中提取内容，附带转录 | | **research** | 搜索网页，过滤结果，添加到阅读列表 | | **raw-processor** | 扫描 INBOX/，按主题聚类，创建索引，分配到 FILES/ | | **sandbox** | 基于 Docker 的代码沙盒（C/C++/Python） | | **mcp-manager** | 添加/删除 MCP 服务器 | | **vault-analyzer** | 分析保险库结构，查找孤立节点，建议连接 | | **skill-creator** | 交互式创建新技能 | | **template** | 空白技能模板，用于您自己的技能 | ### MCP 配置 | MCP | 类型 | |-----|------| | **Obsidian** | 远程（Local REST API） | | **Docker** | 本地（npx docker-mcp） | | **Git** | 本地（npx @cyanheads/git-mcp-server） | | **Sandbox** | 本地（npx server-filesystem） | | **ByteStash** | 远程（自托管的代码片段管理器） | | **Context7** | 远程（文档搜索） | ### 提示 | 提示 | 用例 | |--------|----------| | **code-review** | 审查代码的错误、风格和最佳实践 | | **debug** | 系统化的调试工作流程 | | **refactor** | 安全的重构，保留测试 | | **architecture** | 系统设计和架构决策 | | **explain** | 详细解释代码或概念 | --- ## 更新 ```bash # 如果通过 curl | bash（git clone）安装： cd /path/to/OpenCodeStarterPack && git pull && ./install.sh # 如果通过 npm 安装： npm update -g opencode-starter-pack # 如果通过 brew 安装： brew reinstall https://raw.githubusercontent.com/PETERGS27/OpenCodeStarterPack/main/Formula/opencode-starter-pack.rb ``` 更新程序检测到已安装的内容，并仅添加/更改新的内容。现有的自定义内容将被保留。 --- ## 开发 ```bash git clone https://github.com/PETERGS27/OpenCodeStarterPack.git cd OpenCodeStarterPack npm install ./install.sh --dir /tmp/test-vault --non-interactive ``` ### 项目结构 ``` OpenCodeStarterPack/ ├── README.md # 此文件 ├── install.sh # Bash 入口点（curl | bash） ├── package.json # npm 入口点 ├── src/wizard.js # 交互式 Node.js CLI ├── modules/ │ ├── index.json # 模块清单 │ ├── skills/ # 技能模板（*/SKILL.md） │ ├── mcp/ # MCP 配置（*.json） │ ├── rules/ # 保险库规则 + AGENTS 模板 │ └── prompts/ # 编程提示（*.md） ├── presets/ # 预设定义（*.json） ├── init/ # 应用 + 更新脚本 └── Formula/ # Homebrew 公式 ``` --- ## OpenCode 的 Obsidian 设置 要使 OpenCode 具备完整功能，请按以下方式配置 Obsidian： ### 1. Local REST API 插件 - 打开 Obsidian → 设置 → 社区插件 → 浏览 - 搜索并安装 **"Local REST API"** （by Coddington） - 启用它 → 复制 API 令牌 - 您需要此令牌用于 `opencode.json` ### 2. 推荐插件 - **Terminal** — 在 Obsidian 中运行 shell 命令（用于快速启动脚本） - **Surfing** — Obsidian 中的网页浏览器（如果使用 ByteStash + 快速启动，则需要） - **Excalidraw** — 白板/图表（推荐用于 vault-analyzer 技能） ### 3. Obsidian 设置 - 设置 → 文件和链接 → **自动更新内部链接** → 启用 - 设置 → 编辑器 → **拼写检查** → 按需选择 - 设置 → 快捷键 → 可选设置 OpenCode 集成快捷键 ### 4. 保险库路径 此启动包创建的保险库（默认为 `opencode-vault`）应作为 Obsidian 保险库打开： ``` Open Obsidian → Open another vault → Open folder as vault → select the directory ``` --- ## 构建于 [OpenCode](https://opencode.ai) OpenCodeStarterPack 是 **OpenCode** 的社区启动套件，OpenCode 是一个开源的 AI 编码助手，遵循 [MIT License](https://github.com/anomalyco/opencode/blob/main/LICENSE)。 原始作者：**anomalyco** ([OpenCode on GitHub](https://github.com/anomalyco/opencode)) --- ## 第三方组件 该项目包括以下第三方组件的配置，每个组件都有自己的许可证： | 组件 | 作者 | 许可证 | 备注 | |-----------|--------|---------|-------| | [docker-mcp](https://www.npmjs.com/package/docker-mcp) | dazza | MIT | 用于 Docker 的 MCP 服务器 | | [@cyanheads/git-mcp-server](https://www.npmjs.com/package/@cyanheads/git-mcp-server) | cyanheads | MIT | 用于 Git 的 MCP 服务器 | | [@modelcontextprotocol/server-filesystem](https://www.npmjs.com/package/@modelcontextprotocol/server-filesystem) | Anthropic / MCP team | MIT | MCP 文件系统沙盒 | | [Context7](https://context7.com) | Context7 team | 商业 | 需要在 context7.com **免费注册** | | [ByteStash](https://github.com/jordanistan/bytestash) | jordanistan | MIT | 自托管的代码片段管理器 | | Obsidian MCP 配置 | [PETERGS27](https://github.com/PETERGS27) | MIT | 自定义配置模板 | | ByteStash MCP 配置 | [PETERGS27](https://github.com/PETERGS27) | MIT | 自定义配置模板 | 此软件包中的所有自定义 MCP 配置均由 [PETERGS27](https://github.com/PETERGS27) 在 MIT 许可证下分发。 --- ## 词汇表 | 术语 | 含义 | |------|---------------| | **保险库** | Obsidian 文件夹 — 您的笔记和设置的集合 | | **OpenCode** | 一个 AI 编码助手，从您的终端工作 | | **MCP** | 模型上下文协议 — 一种连接 OpenCode 到其他工具的方式（Obsidian、Docker、Git） | | **MCP 服务器** | 一个小程序，允许 OpenCode 与特定工具通信（例如，“Obsidian MCP”让 OpenCode 读取和写入您的笔记） | | **技能** | 一组指示，教 OpenCode 如何执行特定任务（例如，“research”技能搜索网页） | | **预设** | 预定义的技能、MCP 服务器和提示的组合（例如，“study”预设具有研究工具，“full”具有所有功能） | | **API 密钥** | 一个秘密代码，允许 OpenCode 连接到 AI 提供商（如 Anthropic 或 OpenAI）或服务（如 Context7） | | **Local REST API** | Obsidian 插件，允许其他程序（如 OpenCode）读取和写入您的笔记 | | **令牌** | 一个类似密码的字符串，证明 OpenCode 有权限访问您的 Obsidian 保险库 | | **npm** | JavaScript 的包管理器 — 用于通过 `npx` 安装 OpenCodeStarterPack | | **brew / Homebrew** | macOS 的包管理器 — 一种安装软件的替代方式 | | **终端** | 您输入命令的应用程序（Terminal.app on macOS, PowerShell on Windows） | # 如果通过npm安装： npm update -g opencode-starter-pack # 如果通过brew安装： brew reinstall https://raw.githubusercontent.com/PETERGS27/OpenCodeStarterPack/main/Formula/opencode-starter-pack.rb 更新器会检查已安装的内容，并仅添加或替换新的内容。现有的自定义设置将保留。 --- ## 开发 ```bash git clone https://github.com/PETERGS27/OpenCodeStarterPack.git cd OpenCodeStarterPack npm install ./install.sh --dir /tmp/test-vault --non-interactive ``` ### 项目结构 ``` OpenCodeStarterPack/ ├── README.md # 本文件 ├── install.sh # Bash 入口（curl | bash） ├── package.json # npm 入口 ├── src/wizard.js # 交互式 Node.js CLI ├── modules/ │ ├── index.json # 模块清单 │ ├── skills/ # 技能模板（*/SKILL.md） │ ├── mcp/ # MCP 配置文件（*.json） │ ├── rules/ # 存储库规则 + AGENTS 模板 │ └── prompts/ # 编码提示（*.md） ├── presets/ # 预设定义（*.json） ├── init/ # 应用和更新脚本 └── Formula/ # Homebrew 公式 ``` --- ## 为 OpenCode 配置 Obsidian 要使 OpenCode 具有完整功能，请按以下方式配置 Obsidian： ### 1. Local REST API 插件 - 打开 Obsidian → 设置 → 社区插件 → 浏览 - 查找并安装 **"Local REST API"** （由 Coddington 开发） - 启用它 → 复制 API令牌 - 它将用于 `opencode.json` ### 2. 推荐插件 - **Terminal** — 从 Obsidian 运行命令（用于快速脚本） - **Surfing** — Obsidian 中的网页浏览器（需要 ByteStash 和快速启动） - **Excalidraw** — 板子和图表（推荐用于 vault-analyzer 技能） ### 3. Obsidian 设置 - 设置 → 文件和链接 → **自动更新内部链接** → 启用 - 设置 → 编辑器 → **拼写检查** → 根据需要 - 设置 → 热键 → 可选配置与 opencode 集成相关的热键 ### 4. 存储库路径 使用此启动包创建的存储库（默认为 `opencode-vault`），需要作为 Obsidian 存储库打开： ``` 打开 Obsidian → 打开另一个存储库 → 打开文件夹作为存储库 → 选择目录 ``` --- ## 由 [OpenCode](https://opencode.ai) 驱动 OpenCodeStarterPack 是 **OpenCode** 的启动包，OpenCode 是由 [MIT](https://github.com/anomalyco/opencode/blob/main/LICENSE) 许可的开源 AI 编码助手。 原始作者： **anomalyco** ([OpenCode on GitHub](https://github.com/anomalyco/opencode)) --- ## 第三方组件 本项目包含以下第三方组件的配置，每个组件都有其许可协议： | 组件 | 作者 | 许可协议 | 备注 | |-----------|-------|----------|------------| | [docker-mcp](https://www.npmjs.com/package/docker-mcp) | dazza | MIT | Docker 的 MCP 服务器 | | [@cyanheads/git-mcp-server](https://www.npmjs.com/package/@cyanheads/git-mcp-server) | cyanheads | MIT | Git 的 MCP 服务器 | | [@modelcontextprotocol/server-filesystem](https://www.npmjs.com/package/@modelcontextprotocol/server-filesystem) | Anthropic / MCP team | MIT | 文件系统 MCP 沙盒 | | [Context7](https://context7.com) | Context7 team | Commercial | 需要在 context7.com 上**免费注册** | | [ByteStash](https://github.com/jordanistan/bytestash) | jordanistan | MIT | 独立的代码片段管理器 | | Obsidian MCP 配置 | [PETERGS27](https://github.com/PETERGS27) | MIT | 配置模板 | | ByteStash MCP 配置 | [PETERGS27](https://github.com/PETERGS27) | MIT | 配置模板 | 此启动包中的所有自定义 MCP 配置均由 [PETERGS27](https://github.com/PETERGS27) 以 MIT 许可协议发布。 --- ## 词汇表 | 术语 | 含义 | |--------|----------| | **存储库（Vault）** | Obsidian 文件夹或您的笔记和设置集合 | | **OpenCode** | 从终端运行的 AI 编码助手 | | **MCP** | Model Context Protocol — 连接 OpenCode 到其他工具（Obsidian、Docker、Git）的方式 | | **MCP 服务器** | 允许 OpenCode 与特定工具通信的小程序 | | **技能（Skill）** | 教导 OpenCode 执行特定任务的指令集 | | **预设** | 技能、MCP 服务器和提示的预定义组合 | | **API 密钥** | 连接 OpenCode 到 AI 提供商或服务的密钥 | | **Local REST API** | 允许其他程序读取和写入您的笔记的 Obsidian 插件 | | **令牌** | 确认 OpenCode 可以访问您的 Obsidian 存储库的字符串密码 | | **npm** | JavaScript 包管理器 — 通过 `npx` 安装 OpenCodeStarterPack 的方式 | | **brew / Homebrew** | macOS 包管理器 — 安装软件的替代方法 | | **终端** | 用于输入命令的应用程序（macOS 上的 Terminal.app，Windows 上的 PowerShell） | ## 许可证 MIT © [PETERGS27](https://github.com/PETERGS27)