agentic-workspace

AI-powered code review, pattern aggregation, rule evolution and metrics toolkit.

Install

pnpm add agentic-workspace

CLI Commands

aw-review

对最新 git commit 执行 AI 代码审查。分析 commit diff，调用 AI 模型检测安全、架构、性能、代码规范等维度的潜在问题，生成结构化的 JSON + Markdown 审查报告。

aw-patterns

从所有历史审查记录中聚合问题模式。按 fingerprint 维度统计问题出现频次，区分 recurring（3+ 次） 和 emerging（1-2 次） 两类 pattern，输出分析报告。

aw-evolve

基于 pattern 分析结果 + 现有 Cursor Rules，让 AI 自动生成规则新增/修改建议。输出 proposal Markdown 文件供人工审核后合并到规则库。

aw-metrics

按 ISO 周聚合所有审查记录，计算 Severity Score、New Fingerprints、Recurring Issues 三项趋势指标，生成 Snowball Metrics 报告。

aw-ask

基于当前项目上下文（含 Cursor Rules）执行一次轻量 AI 问答，适合快速咨询项目规范、实现建议或代码改进方向。

npx aw-ask --prompt="How can I improve the current review workflow?"

aw-snipets

基于当前 commit 的业务代码 diff，让 AI 抽象并沉淀可复用函数到 agents-workspace/snipets。函数会按 components/utils 分类输出为独立 .md 文件，并自动刷新 agents-workspace/snipets/index.md 作为入口文档。

Configuration

在项目根目录创建 workspace.config.js 或 workspace.config.ts：

// workspace.config.js
module.exports = {
  modelName: "Pro/zai-org/GLM-5",
  apiBaseUrl: "https://api.siliconflow.cn/v1/chat/completions",
  codeReviewDir: "agents-workspace/code-review",
};

Config Reference

| Name | Type | Default | Required | Description | | --------------------------- | ----------------------- | -------------------------------------------------- | -------- | --------------------------------------------------- | | llmProtocol | "siliconflow" \| "openai-compatible" | "siliconflow" | No | LLM 协议类型，openai-compatible 可对接 OpenAI 协议接口 | | modelName | string | "Pro/zai-org/GLM-5" | No | AI 模型名称 | | apiBaseUrl | string | "https://api.siliconflow.cn/v1/chat/completions" | No | AI API 请求地址 | | apiKey | string | undefined | No | API Key，优先使用环境变量 LLM_API_KEY / OPENAI_API_KEY | | codeReviewDir | string | "agents-workspace/code-review" | No | 审查报告输出目录（相对于 cwd） | | patternsDir | string | "agents-workspace/patterns" | No | Pattern 聚合报告输出目录（相对于 cwd） | | metricsDir | string | "agents-workspace/metrics" | No | Metrics 报告输出目录（相对于 cwd） | | rulesDir | string | ".cursor/rules" | No | Cursor Rules 规则文件目录（相对于 cwd） | | proposalsDir | string | ".cursor/rule-proposals" | No | Rule 演化建议输出目录（相对于 cwd） | | reviewPromptExtra | string | undefined | No | 追加到默认审查 prompt 的额外内容 | | businessCodeFilePatterns | ReadonlyArray<RegExp> | [/\.(?:ts\|tsx\|js\|jsx\|json)$/i] | No | 业务代码文件匹配正则 | | projectConfigFilePatterns | ReadonlyArray<RegExp> | (见源码) | No | 项目配置文件匹配正则 |

Environment Variables

| Name | Description | Required | | ------------- | ------------------------------------------------------------- | ---------------------------------- | | LLM_API_KEY | 通用 API 密钥（推荐），优先级高于配置文件中的 apiKey | Yes（若配置文件中未设置 apiKey） | | OPENAI_API_KEY | OpenAI 协议接口密钥（次优先级，低于 LLM_API_KEY） | No |

License

MIT