CodeAssist - AI 编程助手

注意：隨著我們將重心轉向主網，我們已停止在測試網上追蹤新的 CodeAssist 參與數據。所有歷史數據仍保留在鏈上。

CodeAssist 是由 Gensyn 開發的一款完全私密且本地運行的 AI 編程助手。它能幫助你練習編程問題，並訓練出一個全新的助手來協助你編寫代碼。

與一般的代碼助手不同，CodeAssist 會在你編寫代碼時直接在你的編輯器中進行補全。每一次鍵盤輸入——無論你是打字、修改、刪除，還是保留它的輸出——都會成為學習信號。隨著時間推移，它會逐漸適應你的編程習慣和風格，更像是一個從你的實踐中學習的學徒，而非僅僅遵循指令的工具。

文檔 | 教程 | 排行榜

安裝

開始安裝 CodeAssist。

Docker

根據你所在操作系統的說明，在你的系統上安裝 Docker。

Python

運行處理環境的主腳本需要 Python。我們要求版本不低於 3.10。

UV

UV 用於管理主腳本的依賴項。可以通過以下步驟安裝：

MacOS

brew install uv

Linux（或對於沒有 Brew 的用戶的替代安裝方法）

curl -LsSf https://astral.sh/uv/install.sh | sh

下載代碼

要下載代碼，只需克隆倉庫：

git clone https://github.com/gensyn-ai/codeassist.git
cd codeassist

運行

要運行 CodeAssist，只需執行以下命令：

uv run run.py

HuggingFace Token

要啟動 CodeAssist，你需要一個 HuggingFace Token。請按照 這些說明 生成一個具有「寫入」權限的 Token。

Web UI

腳本運行後，瀏覽器應該會自動打開；如果沒有打開，請手動打開窗口並訪問 localhost:3000，即可打開 CodeAssist。

當 Web UI 加載完成時，你會看到一個登錄模態框，可以使用電子郵件（會發送一次性驗證碼）或 Google 帳戶進行登錄。首次登錄後，你的本地憑據將被存儲在 persistent-data/auth/userKeyMap.json 中。

登錄後，你可以從側邊欄選擇簡單、中等或困難的題目。CodeAssist 會開始記錄一個劇集。每一次點擊、鍵盤輸入、編輯或刪除都會被記錄為訓練反饋。

當你停止輸入時，CodeAssist 會主動行動。它會直接將代碼插入到你的文件中，不會彈出任何提示或確認對話框。無論你接受、修改還是刪除它的編輯內容，每一次互動都會幫助模型更好地理解你的偏好。

小貼士與技巧

• 使用 Shift+Space 或點擊「暫停助手」按鈕來暫時停止助手。再次按下鍵盤時，助手會自動恢復。
• 請將光標保持在你正在編寫的部分附近，因為 CodeAssist 會根據光標位置插入代碼。
• 當助手產生「無操作」（即不做任何改變）時，它其實是在等待你的下一步動作。這是設計使然，表示現在輪到你來操作了。

训练

CodeAssist 會在 Web UI 運行時持續記錄你的互動。要結束一集並訓練你的模型，請在運行 CodeAssist 的終端中按下 Ctrl+C。

你不需要成功解決一道 LeetCode 題目才能訓練模型。你可以通過離開 CodeAssist 的 Web UI，回到運行 CodeAssist 的終端，然後使用 ctrl+c 命令來停止記錄並開始訓練。

在訓練過程中，CodeAssist 會：

• 比較你的編輯內容與助手的操作；
• 根據你的互動計算獎勵和懲罰；
• 更新你的本地模型檢查點；
• 將新的模型權重保存在 persistent-data/trainer/models 目錄下；
• 如果提供了有效的 Token，則將你訓練好的模型上傳到 Hugging Face。

訓練完成後（根據你的系統性能，可能需要幾分鐘），你可以重新啟動 CodeAssist，以使用基於最近一集數據訓練的新模型。

最佳實踐

• 保持耐心：助手會觀察你的打字速度和間隔。如果動作過快或過於激進地糾正，可能會降低訓練效果。
• 把它當作合作夥伴：讓它自然地插入代碼，並在編輯或刪除之前先保留有用的代碼一段時間。
• 不要立即刪除所有內容：如果你立刻刪除了它寫的所有內容，就相當於教它以後不要再做任何事情了。
• 記錄多種不同的題目：通過解決不同類型的問題來豐富它的學習信號。
• 預期逐步改善：早期的訓練可能會感覺不太穩定。經過 4–5 次訓練後，效果會更加明顯。

故障排除

異常：容器 不健康。

這表示某個容器未能成功啟動。你可以通過運行 docker logs <container-name> 查看日誌。請在提交新問題時上載相關日誌。

無法連接至 Docker 守護進程

2025-09-04 15:03:47,975 - ERROR - 無法連接至 Docker 守護進程：獲取服務 API 版本時發生錯誤：('連接中斷。', FileNotFoundError(2, '沒有這樣的檔案或目錄'))
2025-09-04 15:03:47,976 - ERROR - 請確保 Docker 已安裝並正在運行。

如果出現類似上述的錯誤信息，則表示 Docker 未運行，或者你沒有權限連接至 Docker。請確保 Docker 已正確安裝在你的系統上，並且正在運行。

綁定 0.0.0.0:3000 失敗：端口已被佔用

這表示已經有一個使用 3000 端口的 Docker 容器在運行。

你有兩種選擇：

1. 停止正在使用該端口的其他服務（例如 RL Swarm）。
2. 使用 --port 參數在另一個端口上運行 CodeAssist：

  uv run run.py --port 3001

注意：選擇新端口時，請避免使用 8000、8080、8001、8008、3003 和 11434，因為這些端口已被預留給其他 CodeAssist 服務。

貢獻

我們歡迎大家的貢獻！

Pre-Commit Hook

我們使用 pre-commit hook 在提交代碼前對倉庫進行代碼檢查。你可以按照以下說明安裝 pre-commit：

安裝 pre-commit

只需運行以下命令即可安裝 pre-commit：

pip install pre-commit

設置 pre-commit

設置 pre-commit 的命令如下：

pre-commit install

代碼格式化

本倉庫使用 ruff format 進行代碼格式化。任何不符合 Ruff 檢查規範的提交都將導致 GitHub Actions 失敗，必須在合併前修復。

授權條款

CodeAssist 依據 (MIT) 許可證發布。

CodeAssist 快速上手指南

CodeAssist 是由 Gensyn 开发的完全本地化、隐私保护的 AI 编程助手。它不像传统工具那样被动等待指令，而是像“学徒”一样观察你的每一次敲击、修改和删除，直接在编辑器中与你协同编写代码，并通过你的反馈不断适应你的编码习惯。

环境准备

在开始之前，请确保你的系统满足以下要求：

• 操作系统：支持 Docker 的 macOS 或 Linux 系统。
• Docker：必须安装并正在运行。
  • 安装指南：Docker 官方文档
• Python：版本需为 3.10 或更高。
• UV：用于管理脚本依赖的工具。
  • macOS (推荐):

    brew install uv
    

  • Linux / 其他 macOS 环境:

    curl -LsSf https://astral.sh/uv/install.sh | sh
    

• HuggingFace Token：需要一个具有 Write 权限的 Token 用于模型上传（可选但推荐）。
  • 获取方式：访问 HuggingFace Security Tokens 生成。

安装步骤

1. 克隆仓库 将 CodeAssist 源代码下载到本地：

   git clone https://github.com/gensyn-ai/codeassist.git
   cd codeassist
   

2. 启动服务 使用 uv 运行主脚本：

   uv run run.py
   

   注：如果端口 3000 被占用，可指定其他端口（避免使用 8000, 8080, 11434 等保留端口）：

   uv run run.py --port 3001
   

3. 访问界面 脚本运行后，浏览器应自动打开。若未自动打开，请在浏览器中访问： http://localhost:3000

基本使用

1. 登录账户 在弹出的登录框中，使用邮箱（接收一次性验证码）或 Google 账号登录。首次登录后，凭证将保存在本地的 persistent-data/auth/userKeyMap.json。

2. 选择题目并开始

   • 在侧边栏选择难度（Easy/Medium/Hard）。
   • CodeAssist 会自动开始记录当前“回合（Episode）”。
   • 核心交互：直接在编辑器中编写代码。CodeAssist 会根据你的光标位置实时插入代码建议。
     • 你可以保留、修改或删除它的建议，这些操作都会成为训练信号。
     • 当助手显示 "No-Op"（无操作）时，表示它在等待你输入。

3. 控制助手

   • 暂停/恢复：按下 Shift+Space 或点击界面上的 "Pause Assistant" 按钮可暂时停止助手自动编写。再次敲击键盘即可恢复。
   • 光标定位：确保持续将光标停留在你正在工作的代码区域附近。

4. 训练模型 完成练习后（无需完美解决题目），回到运行 CodeAssist 的终端窗口，按下 Ctrl+C 结束当前回合并触发训练。

   • 系统将对比你的编辑与助手的操作，计算奖励/惩罚。
   • 更新本地模型检查点（保存于 persistent-data/trainer/models）。
   • 若配置了 HuggingFace Token，模型将自动上传。
   • 训练完成后重启 CodeAssist，即可使用基于你最新行为优化后的模型。

最佳实践提示：

• 保持耐心，不要过快删除助手生成的所有代码，这会导致它停止行动。
• 将其视为协作者，允许它自然介入，经过 4-5 个不同题目的训练后效果会显著提升。