okooooooo/CodePilot
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: correct README factual errors and add user-facing content

Browse Source 
P1 fixes:
- Replace "Extensions page" with actual MCP + Skills sidebar pages
- Update signing status: macOS is signed (not notarized), Win/Linux unsigned
- Fix Gatekeeper warning description to match signed-but-unnotarized state

P2 fixes:
- Correct Assistant Workspace file locations: soul.md/user.md/claude.md/memory.md
  are at workspace root, .assistant/ is state-only subdirectory
- Translate "Why CodePilot" section to full Japanese (was English regression)
- Add provider auth path clarification (CLI/env optional vs custom required)
- Add specific page names in First Launch (Settings > Providers, Settings > Assistant, MCP, Skills)

Missing content:
- Add structured Documentation section with user guides and developer docs
- Add FAQ section covering: claude not found, no models after provider config,
  dev vs electron:dev, workspace file locations, Bridge platform tokens
- Sync all additions across EN, CN, JA

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
7418andClaude Opus 4.6 committed 2026-03-08 15:51:35 +08:00
1 parent a249fb9c4f
commit 7ad66f82c4
3 files changed
+176 -26
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

README.md
+57 -7
View File
@@ -25,7 +25,7 @@
**Control from anywhere.** Bridge connects CodePilot to Telegram, Feishu, Discord, and QQ. Send a message from your phone, get the response on your desktop.
**An assistant that knows your project.** The .assistant workspace stores persona files, onboarding flows, daily check-ins, and persistent memory. Claude adapts to your project's conventions over time.
**An assistant that knows your project.** Set up a workspace directory with persona files (soul.md, user.md), rules (claude.md), and persistent memory (memory.md). Claude uses these to adapt to your project's conventions over time, with onboarding flows and daily check-ins.
**Built for daily use.** Pause, resume, and rewind sessions to any checkpoint. Work in split-screen with two conversations side by side. Track token usage and costs. Import CLI session history. Switch between dark and light themes.
@@ -62,10 +62,10 @@ npm run electron:dev # full desktop app
## First Launch
1. **Authenticate Claude** -- Run `claude login` in your terminal if you haven't already.
2. **Configure a Provider** -- Open Settings > Providers. Add an API key or use the CLI's default authentication.
2. **Configure a Provider** -- If you only use Anthropic via CLI authentication or `ANTHROPIC_API_KEY`, Providers setup is optional. For OpenRouter, Bedrock, Vertex, or custom endpoints, go to **Settings > Providers** and add the credentials first.
3. **Create a conversation** -- Pick a working directory, select a mode (Code / Plan / Ask), and choose a model.
4. **Set up Assistant Workspace** (optional) -- Enable Onboarding, daily check-ins, and persona files under the .assistant directory.
5. **Add MCP servers** (optional) -- Go to the Extensions page to connect external tools and services.
4. **Set up Assistant Workspace** (optional) -- Go to **Settings > Assistant**, choose a workspace directory, and enable Onboarding. CodePilot creates `soul.md`, `user.md`, `claude.md`, and `memory.md` at the workspace root (state is tracked in the `.assistant/` subdirectory).
5. **Add MCP servers** (optional) -- Go to the **MCP** page in the sidebar to add and manage MCP servers. Custom skills are managed on the separate **Skills** page.
---
@@ -99,7 +99,7 @@ npm run electron:dev # full desktop app
| Capability | Details |
|---|---|
| Assistant Workspace | .assistant directory, persona, onboarding, check-in, memory |
| Assistant Workspace | Workspace root files (soul.md, user.md, claude.md, memory.md), .assistant/ state, onboarding, check-in |
| File browser | Project file tree with syntax-highlighted preview |
| Usage analytics | Token counts, cost estimates, daily usage charts |
| Local storage | SQLite (WAL mode), all data stays on your machine |
@@ -118,10 +118,10 @@ npm run electron:dev # full desktop app
Download from the [Releases](https://github.com/op7418/CodePilot/releases) page.
CodePilot is not code-signed yet, so your OS will show a security warning on first launch.
macOS builds are code-signed with a Developer ID certificate but not notarized, so Gatekeeper may still prompt on first launch. Windows and Linux builds are unsigned.
<details>
<summary>macOS: "Apple cannot check it for malicious software"</summary>
<summary>macOS: Gatekeeper warning on first launch</summary>
**Option 1** -- Right-click `CodePilot.app` in Finder > Open > confirm.
@@ -145,12 +145,62 @@ xattr -cr /Applications/CodePilot.app
## Documentation
**Getting started:**
- [Quick Start](#quick-start) -- Download or build from source
- [First Launch](#first-launch) -- Authentication, providers, workspace setup
**User guides:**
- [Providers](#) -- Configuring Anthropic, OpenRouter, Bedrock, Vertex, and custom endpoints
- [MCP Servers](#) -- Adding and managing Model Context Protocol servers
- [Bridge](#) -- Remote control via Telegram, Feishu, Discord, QQ
- [Assistant Workspace](#) -- Persona files, onboarding, memory, daily check-ins
- [FAQ](#faq) -- Common issues and solutions
**Developer docs:**
- [ARCHITECTURE.md](./ARCHITECTURE.md) -- Architecture, tech stack, directory structure, data flow
- [docs/handover/](./docs/handover/) -- Design decisions and handover documents
- [docs/exec-plans/](./docs/exec-plans/) -- Execution plans and tech debt tracker
---
## FAQ
<details>
<summary><code>claude</code> command not found</summary>
Install the Claude Code CLI globally:
```bash
npm install -g @anthropic-ai/claude-code
```
Then authenticate with `claude login`. Make sure `claude --version` works before launching CodePilot.
</details>
<details>
<summary>Configured a Provider but no models appear</summary>
Verify the API key is valid and the endpoint is reachable. Some providers (Bedrock, Vertex) require additional environment variables or IAM configuration beyond the API key. Check the provider's documentation for required setup.
</details>
<details>
<summary>What is the difference between <code>npm run dev</code> and <code>npm run electron:dev</code>?</summary>
`npm run dev` starts only the Next.js dev server -- you use CodePilot in your browser at `http://localhost:3000`. `npm run electron:dev` starts both Next.js and the Electron shell, giving you the full desktop app experience with native window controls.
</details>
<details>
<summary>Where are the Assistant Workspace files?</summary>
When you set up a workspace, CodePilot creates four Markdown files at the **workspace root directory**: `soul.md` (personality), `user.md` (user profile), `claude.md` (rules), and `memory.md` (long-term notes). State tracking (onboarding progress, check-in dates) is stored in the `.assistant/` subdirectory. Daily memories go to `memory/daily/`.
</details>
<details>
<summary>Bridge requires additional setup per platform</summary>
Each Bridge channel (Telegram, Feishu, Discord, QQ) requires its own bot token or app credentials. Go to the **Bridge** page in the sidebar to configure channels. You will need to create a bot on the target platform first and provide the token to CodePilot.
</details>
---
## Community
<img src="docs/wechat-group-qr.png" width="240" alt="WeChat Group QR Code" />
README_CN.md
+57 -7
View File
@@ -25,7 +25,7 @@
**随时随地控制。** Bridge 连接 CodePilot 到 Telegram、飞书、Discord 和 QQ。在手机上发消息，在桌面上收回复。
**了解你项目的助手。** .assistant 工作区存储人设文件、Onboarding 流程、每日签到和持久记忆。Claude 会随时间适应你的项目惯例。
**了解你项目的助手。** 设置一个工作区目录，放入人设文件（soul.md、user.md）、规则（claude.md）和持久记忆（memory.md）。Claude 利用这些文件随时间适应你的项目惯例，支持 Onboarding 流程和每日签到。
**为日常使用而建。** 暂停、恢复和回退会话到任意检查点。分屏并排运行两个对话。追踪 Token 用量和费用。导入 CLI 会话历史。深浅主题一键切换。
@@ -62,10 +62,10 @@ npm run electron:dev # 完整桌面应用
## 首次使用
1. **认证 Claude** -- 如果还没有，先在终端运行 `claude login`。
2. **配置 Provider** -- 打开 设置 > Providers，添加 API Key 或使用 CLI 默认认证。
2. **配置 Provider** -- 如果只使用 Anthropic（通过 CLI 认证或 `ANTHROPIC_API_KEY`），Provider 配置可跳过。使用 OpenRouter、Bedrock、Vertex 或自定义端点时，需要先在 **设置 > Providers** 中添加凭证。
3. **创建对话** -- 选择工作目录、交互模式（Code / Plan / Ask）和模型。
4. **设置 Assistant Workspace**（可选）-- 在 .assistant 目录下开启 Onboarding、每日签到和人设文件。
5. **添加 MCP 服务器**（可选）-- 前往扩展页面连接外部工具和服务。
4. **设置 Assistant Workspace**（可选）-- 前往 **设置 > Assistant**，选择工作区目录并开启 Onboarding。CodePilot 会在工作区根目录创建 `soul.md`、`user.md`、`claude.md` 和 `memory.md`（状态跟踪保存在 `.assistant/` 子目录中）。
5. **添加 MCP 服务器**（可选）-- 在侧边栏的 **MCP** 页面添加和管理 MCP 服务器。自定义技能在单独的 **Skills** 页面管理。
---
@@ -99,7 +99,7 @@ npm run electron:dev # 完整桌面应用
| 能力 | 说明 |
|---|---|
| Assistant Workspace | .assistant 目录、人设、Onboarding、签到、记忆 |
| Assistant Workspace | 工作区根目录文件（soul.md、user.md、claude.md、memory.md），.assistant/ 状态，Onboarding，签到 |
| 文件浏览 | 项目文件树、语法高亮预览 |
| 用量分析 | Token 计数、费用估算、日用量图表 |
| 本地存储 | SQLite（WAL 模式），数据全部在本地 |
@@ -118,10 +118,10 @@ npm run electron:dev # 完整桌面应用
从 [Releases](https://github.com/op7418/CodePilot/releases) 页面下载。
CodePilot 尚未进行代码签名，首次启动时操作系统会显示安全警告。
macOS 构建已使用 Developer ID 证书签名，但未进行公证（notarize），因此 Gatekeeper 在首次启动时仍可能弹出提示。Windows 和 Linux 构建未签名。
<details>
<summary>macOS："无法验证开发者" / "Apple 无法检查其是否包含恶意软件"</summary>
<summary>macOS：Gatekeeper 首次启动提示</summary>
**方案一** -- 在访达中右键 `CodePilot.app` > 打开 > 确认。
@@ -145,12 +145,62 @@ xattr -cr /Applications/CodePilot.app
## 文档
**入门指南：**
- [快速开始](#快速开始) -- 下载或源码构建
- [首次使用](#首次使用) -- 认证、Provider 配置、工作区设置
**用户指南：**
- [Providers](#) -- 配置 Anthropic、OpenRouter、Bedrock、Vertex 和自定义端点
- [MCP 服务器](#) -- 添加和管理 Model Context Protocol 服务器
- [Bridge](#) -- 通过 Telegram、飞书、Discord、QQ 远程控制
- [Assistant Workspace](#) -- 人设文件、Onboarding、记忆、每日签到
- [常见问题](#常见问题) -- 常见问题和解决方案
**开发文档：**
- [ARCHITECTURE.md](./ARCHITECTURE.md) -- 架构、技术栈、目录结构、数据流
- [docs/handover/](./docs/handover/) -- 设计决策、交接文档
- [docs/exec-plans/](./docs/exec-plans/) -- 执行计划、技术债务
---
## 常见问题
<details>
<summary><code>claude</code> 命令找不到</summary>
全局安装 Claude Code CLI：
```bash
npm install -g @anthropic-ai/claude-code
```
然后运行 `claude login` 完成认证。确保 `claude --version` 能正常运行后再启动 CodePilot。
</details>
<details>
<summary>配置了 Provider 但没有模型出现</summary>
确认 API Key 有效且端点可访问。部分 Provider（Bedrock、Vertex）除 API Key 外还需要额外的环境变量或 IAM 配置。请查阅对应 Provider 的文档了解所需配置。
</details>
<details>
<summary><code>npm run dev</code> 和 <code>npm run electron:dev</code> 的区别</summary>
`npm run dev` 只启动 Next.js 开发服务器，在浏览器中访问 `http://localhost:3000` 使用 CodePilot。`npm run electron:dev` 同时启动 Next.js 和 Electron 外壳，提供完整的桌面应用体验，包含原生窗口控件。
</details>
<details>
<summary>Workspace 文件到底在哪</summary>
设置工作区后，CodePilot 在**工作区根目录**创建四个 Markdown 文件：`soul.md`（人设）、`user.md`（用户档案）、`claude.md`（规则）、`memory.md`（长期笔记）。状态跟踪（Onboarding 进度、签到日期）保存在 `.assistant/` 子目录中。每日记忆保存在 `memory/daily/` 中。
</details>
<details>
<summary>Bridge 需要额外的平台配置</summary>
每个 Bridge 通道（Telegram、飞书、Discord、QQ）都需要各自的 Bot Token 或应用凭证。在侧边栏的 **Bridge** 页面配置通道。你需要先在目标平台创建 Bot 并获取 Token，然后提供给 CodePilot。
</details>
---
## 社区
<img src="docs/wechat-group-qr.png" width="240" alt="微信用户群二维码" />
README_JA.md
+62 -12
View File
@@ -17,17 +17,17 @@
---
## Why CodePilot
## CodePilot を選ぶ理由
**Multi-provider, one interface.** Connect to Anthropic, OpenRouter, Bedrock, Vertex, or any custom endpoint. Switch providers and models mid-conversation without losing context.
**マルチプロバイダー、ひとつのインターフェース。** Anthropic、OpenRouter、Bedrock、Vertex、または任意のカスタムエンドポイントに接続。会話の途中でプロバイダーやモデルを切り替えても、コンテキストは維持されます。
**MCP + Skills extensibility.** Add MCP servers (stdio / sse / http) with runtime status monitoring. Define reusable prompt-based skills and invoke them as slash commands. Browse community skills from skills.sh.
**MCP + Skills で拡張。** MCP サーバー（stdio / sse / http）を追加し、ランタイム状態を監視。再利用可能なプロンプトベースのスキルを定義し、スラッシュコマンドとして呼び出せます。skills.sh からコミュニティスキルを閲覧・インストール可能。
**Control from anywhere.** Bridge connects CodePilot to Telegram, Feishu, Discord, and QQ. Send a message from your phone, get the response on your desktop.
**どこからでも制御。** Bridge で CodePilot を Telegram、Feishu、Discord、QQ に接続。スマートフォンからメッセージを送り、デスクトップで返答を受け取れます。
**An assistant that knows your project.** The .assistant workspace stores persona files, onboarding flows, daily check-ins, and persistent memory.
**プロジェクトを理解するアシスタント。** ワークスペースディレクトリにペルソナファイル（soul.md、user.md）、ルール（claude.md）、永続メモリ（memory.md）を配置。Claude はこれらを使い、プロジェクトの慣例に適応します。Onboarding フローやデイリーチェックインにも対応。
**Built for daily use.** Pause, resume, and rewind sessions. Split-screen dual conversations. Token usage tracking. CLI session import. Dark and light themes.
**日常使いのために設計。** セッションの一時停止、再開、チェックポイントへの巻き戻し。スプリットスクリーンで 2 つの会話を並行実行。トークン使用量の追跡。CLI セッション履歴のインポート。ダーク / ライトテーマ。
---
@@ -62,10 +62,10 @@ npm run electron:dev # フルデスクトップアプリ
## 初回起動
1. **Claude を認証** -- ターミナルで `claude login` を実行。
2. **プロバイダーを設定** -- 設定 > Providers で API キーを追加するか、CLI のデフォルト認証を使用。
2. **プロバイダーを設定** -- Anthropic のみ使用する場合（CLI 認証または `ANTHROPIC_API_KEY`）、プロバイダー設定は不要。OpenRouter、Bedrock、Vertex、カスタムエンドポイントを使用する場合は、先に **設定 > Providers** で認証情報を追加。
3. **会話を作成** -- 作業ディレクトリ、モード（Code / Plan / Ask）、モデルを選択。
4. **Assistant Workspace を設定**（任意）-- .assistant ディレクトリで Onboarding、デイリーチェックイン、ペルソナファイルを有効化。
5. **MCP サーバーを追加**（任意）-- エクステンションページで外部ツールやサービスを接続。
4. **Assistant Workspace を設定**（任意）-- **設定 > Assistant** でワークスペースディレクトリを選択し、Onboarding を有効化。CodePilot がワークスペースルートに `soul.md`、`user.md`、`claude.md`、`memory.md` を作成（状態は `.assistant/` サブディレクトリに保存）。
5. **MCP サーバーを追加**（任意）-- サイドバーの **MCP** ページで MCP サーバーを追加・管理。カスタムスキルは **Skills** ページで管理。
---
@@ -99,7 +99,7 @@ npm run electron:dev # フルデスクトップアプリ
| 機能 | 詳細 |
|---|---|
| Assistant Workspace | .assistant ディレクトリ、ペルソナ、Onboarding、チェックイン、メモリ |
| Assistant Workspace | ワークスペースルートファイル（soul.md、user.md、claude.md、memory.md）、.assistant/ 状態、Onboarding、チェックイン |
| ファイルブラウザ | プロジェクトファイルツリー、シンタックスハイライトプレビュー |
| 使用量分析 | トークン数、コスト見積もり、日次使用量チャート |
| ローカルストレージ | SQLite（WAL モード）、全データはローカルに保存 |
@@ -118,10 +118,10 @@ npm run electron:dev # フルデスクトップアプリ
[Releases](https://github.com/op7418/CodePilot/releases) ページからダウンロードしてください。
CodePilot はまだコード署名されていないため、初回起動時に OS がセキュリティ警告を表示します。
macOS ビルドは Developer ID 証明書で署名済みですが、公証（notarize）は行われていないため、Gatekeeper が初回起動時に警告を表示する場合があります。Windows と Linux ビルドは未署名です。
<details>
<summary>macOS:「Apple はこのソフトウェアを確認できません」</summary>
<summary>macOS: Gatekeeper の初回起動時警告</summary>
**オプション 1** -- Finder で `CodePilot.app` を右クリック > 開く > 確認。
@@ -145,12 +145,62 @@ xattr -cr /Applications/CodePilot.app
## ドキュメント
**はじめに:**
- [クイックスタート](#クイックスタート) -- ダウンロードまたはソースからビルド
- [初回起動](#初回起動) -- 認証、プロバイダー設定、ワークスペースセットアップ
**ユーザーガイド:**
- [Providers](#) -- Anthropic、OpenRouter、Bedrock、Vertex、カスタムエンドポイントの設定
- [MCP サーバー](#) -- Model Context Protocol サーバーの追加と管理
- [Bridge](#) -- Telegram、Feishu、Discord、QQ によるリモート制御
- [Assistant Workspace](#) -- ペルソナファイル、Onboarding、メモリ、デイリーチェックイン
- [FAQ](#faq) -- よくある質問と解決方法
**開発者ドキュメント:**
- [ARCHITECTURE.md](./ARCHITECTURE.md) -- アーキテクチャ、テックスタック、ディレクトリ構成、データフロー
- [docs/handover/](./docs/handover/) -- 設計決定、引き継ぎドキュメント
- [docs/exec-plans/](./docs/exec-plans/) -- 実行計画、技術的負債トラッカー
---
## FAQ
<details>
<summary><code>claude</code> コマンドが見つからない</summary>
Claude Code CLI をグローバルにインストール:
```bash
npm install -g @anthropic-ai/claude-code
```
`claude login` で認証を完了し、`claude --version` が動作することを確認してから CodePilot を起動してください。
</details>
<details>
<summary>プロバイダーを設定したがモデルが表示されない</summary>
API キーが有効でエンドポイントに到達可能であることを確認してください。一部のプロバイダー（Bedrock、Vertex）では、API キー以外に追加の環境変数や IAM 設定が必要です。
</details>
<details>
<summary><code>npm run dev</code> と <code>npm run electron:dev</code> の違い</summary>
`npm run dev` は Next.js 開発サーバーのみを起動し、ブラウザで `http://localhost:3000` を使用します。`npm run electron:dev` は Next.js と Electron シェルの両方を起動し、ネイティブウィンドウコントロールを含むフルデスクトップアプリを提供します。
</details>
<details>
<summary>ワークスペースファイルの場所</summary>
ワークスペース設定後、CodePilot は**ワークスペースルートディレクトリ**に 4 つの Markdown ファイルを作成: `soul.md`（パーソナリティ）、`user.md`（ユーザープロファイル）、`claude.md`（ルール）、`memory.md`（長期メモ）。状態管理（Onboarding 進捗、チェックイン日付）は `.assistant/` サブディレクトリに保存。デイリーメモリは `memory/daily/` に保存。
</details>
<details>
<summary>Bridge にはプラットフォームごとの追加設定が必要</summary>
各 Bridge チャンネル（Telegram、Feishu、Discord、QQ）には独自の Bot トークンまたはアプリ認証情報が必要です。サイドバーの **Bridge** ページでチャンネルを設定してください。
</details>
---
## コミュニティ
- [GitHub Issues](https://github.com/op7418/CodePilot/issues) -- バグ報告と機能リクエスト