codeclaw (Ychampion)

CodeClaw

CodeClaw将Claude Code和Codex会话转换为具有审查门、背景同步和MCP内存检索的隐私安全培训数据集。

    

太长，读不下去了

• 跑 codeclaw setup 一次。
• 跑 codeclaw export --no-push 生成本地审查数据集。
• 跑 codeclaw confirm ... 通过审查门。
• 跑 codeclaw export --publish-attestation "..." 只有在明确批准后。

默认用户体验

• 跑步平原 codeclaw 打开全屏TUI。
• 跑步 codeclaw export ... 保持脚本CLI流。

为什么选择CodeClaw

• 将日常编码会话转化为结构化、可重用的培训数据。
• 通过编辑和手动审查门保持一流的隐私控制。
• 通过MCP可访问的会话内存保存历史问题解决上下文。

核心能力

• 多源摄入：

- Claude Code和Codex会话发现和解析。 - Cursor、Windsurf、Aider、Continue.dev、Antigravity、VS Code、Zed和Xcode测试日志的实验适配器路由。

• 隐私保护导出：

- 机密和PII编辑、用户名匿名化和项目级排除。 - 分层隐私引擎：正则表达式基线+可选ML NER(codeclaw[pii-ml]).

• 受控发布工作流程：

- 本地导出，用户审核证明，确认门，然后推。 - 不可变数据集版本快照+发布时的重复数据消除索引。

• 连续模式：

- 用于增量同步的后台监视守护进程。

• 内存工具：

- MCP服务器，具有搜索、项目模式、轨迹统计、会话查找、图相似性检索和索引刷新功能。

安装

pip install codeclaw

可选附加功能：

pip install "codeclaw[pii-ml]"    # Presidio + spaCy detection layer
pip install "codeclaw[mcp]"       # MCP server runtime
pip install "codeclaw[finetune]"  # Experimental local fine-tune scaffolding

来源：

git clone https://github.com/ychampion/codeclaw.git
cd codeclaw
pip install -e ".[dev]"

检查安装版本：

codeclaw --version

快速开始

# Guided onboarding (HF auth help, repo setup, project scope, MCP, watcher)
codeclaw setup

# Reset local setup for a clean re-test (config/state/MCP entry)
codeclaw reset --all --yes

# Verify environment and connected scope
codeclaw doctor
codeclaw projects --source both
codeclaw stats
codeclaw diff --format json
codeclaw config --encryption status

# Export locally first
codeclaw export --no-push

# Review and confirm
codeclaw confirm \
  --full-name "YOUR FULL NAME" \
  --attest-full-name "Asked for full name and scanned export." \
  --attest-sensitive "Reviewed for company/client/private identifiers." \
  --attest-manual-scan "Manually reviewed representative sessions."

# Publish only after explicit approval
codeclaw export --publish-attestation "User explicitly approved publishing to Hugging Face."

# Optional one-command sharing flow
codeclaw share --publish --publish-attestation "User explicitly approved publishing to Hugging Face."

命令

其他源过滤器可用于适配器支持的摄取：

• cursor, windsurf, aider, continue, antigravity, vscode, zed, xcode-beta

观看透明度示例：

codeclaw watch --status
codeclaw watch --monitor --follow
codeclaw watch --logs --follow
codeclaw watch --pause
codeclaw watch --resume
codeclaw watch --switch-project "codex:codeclaw"

交互式控制台模式：

codeclaw console --source codex
# Then inside the prompt:
/status
/projects
/scope codex:codeclaw
/logs 80
/run export --no-push

全屏TUI模式：

codeclaw
# equivalent explicit command:
codeclaw tui --source both

如果简单 codeclaw 打印导出/确认JSON而不是打开TUI，您使用的是旧版本。 升级并验证：

pip install --upgrade codeclaw
codeclaw --version

TUI内部：

/help
/status
/source codex
/watch on
/logs 80
/projects
/scope codex:codeclaw
/export --dry-run
/jobs
/plugins list

最小本地插件示例(./plugins/echo):

plugins/
  echo/
    plugin.json
    plugin.py

plugin.json:

{
  "name": "echo",
  "version": "0.1.0",
  "entrypoint": "plugin.py",
  "description": "Simple echo command"
}

plugin.py:

from codeclaw.tui.types import CommandResult

def register(ctx):
    def _echo(_app, args):
        return CommandResult(ok=True, message=" ".join(args) if args else "echo")

    ctx.register_command("echo", _echo, "Echo input text", usage="/echo ")

MCP内存服务器

安装可选的MCP依赖项：

pip install "codeclaw[mcp]"
codeclaw install-mcp

可用的MCP工具：

• search_past_solutions(query, max_results=5)
• get_project_patterns(project=None)
• get_trajectory_stats()
• get_session(session_id)
• find_similar_sessions(context, max_results=5)
• refresh_index()

隐私和安全

CodeClaw是为默认情况下的私有工作流设计的：

• 路径和用户名匿名化
• 秘密和高熵令牌检测
• 自定义编辑列表
• 发布前手动确认和认证门
• 通过密钥环支持的密钥管理为本地工件提供静态加密支持

自动编辑并不完美。在发布之前，一定要审查当地的出口情况。

包装分发

• 初级：PyPI(pip install codeclaw)
• 发布工件：wheel/sdist附加到每个GitHub标签发布中。
• 可选：通过设置存储库机密发布到与PyPI兼容的辅助索引：

- SECONDARY_PYPI_REPOSITORY_URL - SECONDARY_PYPI_USERNAME - SECONDARY_PYPI_PASSWORD

README同步策略

README命令文档在CI中强制执行：

• tests/test_docs_consistency.py 验证命令命名和品牌标记。
• CLI帮助奇偶校验测试可确保README命令行与真实的CLI界面保持一致。

如果命令更改，CI将失败，直到README更新。

社区

• 贡献指南： 贡献.md
• 安全策略： 安全.md
• 支持渠道： 支持.md
• 行为准则： 代码_OF_CONDUCT.md
• 发布流程： 发布.md

许可证

麻省理工学院-见 许可证.