getaiready/aiready-cli

# @aiready/cli [](https://www.npmjs.com/package/@aiready/cli) [](https://marketplace.visualstudio.com/items?itemName=pengcao.aiready) [](https://opensource.org/licenses/MIT) [](https://github.com/getaiready/aiready-cli/actions) ## 🚀 快速开始 ``` # 全局安装 npm install -g @aiready/cli # 扫描您的代码库 aiready scan . # 获取详细分析 aiready scan . --output report.json ``` ## 🤖 为什么选择 AIReady？ 随着 AI 深度集成到软件开发中，代码库变得越来越难以被 AI 模型理解，原因包括： - AI 模型的**知识截止限制** - 破坏 AI 理解的**上下文碎片化** - AI 无法识别的**重复模式** - 整个代码库中**命名不一致** AIReady 帮助团队**评估、可视化和准备**代码库，以更好地采用 AI。 ## 🌟 AIReady 生态系统 | 集成 | 包 | 描述 | | --------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------- | | **CLI** | [`@aiready/cli`](https://www.npmjs.com/package/@aiready/cli) | 统一命令行界面 | | **MCP Server** | [`@aiready/mcp-server`](https://www.npmjs.com/package/@aiready/mcp-server) | **Cursor-Ready**：将 AI 代理连接到平台 Swarm 的桥梁 | | **Remediation Swarm** | [Platform](https://platform.getaiready.dev) | **AI-to-AI 修复**：通过专业代理自动重构 | | **GitHub Action** | [`aiready-action`](https://github.com/marketplace/actions/aiready-action) | **无回归**：AI 辅助的 CI/CD 门禁 | | **VS Code** | [`aiready`](https://marketplace.visualstudio.com/items?itemName=pengcao.aiready) | VS Code 中实时 AI 就绪分析 | ## ✨ 功能 - **AI 就绪评分** - 获取 0-100 分的分数，表明您的代码库的 AI 准备程度。 - **🛠️ AI 回归防护** - 阻止降低 AI 辅助的 PR（GitHub Action）。 - **🤖 修复 Swarm** - 使用平台的专业代理自动修复 AI 就绪问题。 - **🔌 Cursor-Ready MCP Server** - 让您的 AI 助手（Cursor、Windsurf、Claude）在 IDE 中直接发现并_修复_代码问题。 - **语义重复检测** - 查找浪费 AI 上下文窗口令牌的重复模式。 - **上下文分析** - 分析上下文窗口成本、导入深度和依赖碎片化。 - **一致性检查** - 确保命名约定和模式一致性。 - **代理基础** - 评估代码对 AI 代理和自主工作流的帮助程度。 ## 📋 命令 ### 统一扫描 一次性运行所有分析工具： ``` aiready scan . aiready scan . --output report.json aiready scan . --threshold 70 ``` ### 修复 查看检测到的问题的建议修复： ``` aiready remediate # Show remediation options for latest report aiready remediate --tool patterns # Focus on pattern consolidation fixes ``` ### 单独工具 | 命令 | 描述 | | --------------------- | ------------------------------------------ | | `aiready patterns` | 检测语义重复和模式 | | `aiready context` | 分析上下文窗口成本和依赖 | | `aiready consistency` | 检查命名约定 | | `aiready testability` | 评估代码可测试性 | | `aiready contract` | 分析结构类型安全和契约 | | `aiready visualize` | 生成交互式可视化 | | `aiready upload` | 将结果上传到 AIReady 平台 | ## 📦 安装 ### npm / pnpm / yarn ``` # npm npm install -g @aiready/cli # pnpm pnpm add -g @aiready/cli # yarn yarn global add @aiready/cli ``` ### Docker ``` # 从 Docker Hub 拉取 docker pull aiready/cli # 运行 docker run aiready/cli scan . # 或直接使用镜像 docker run -v $(pwd):/app aiready/cli scan /app ``` ### Homebrew ``` brew install getaiready/aiready/aiready ``` ### VS Code 扩展 从 [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=pengcao.aiready) 安装或在 VS Code 扩展中搜索"AIReady"。 ### GitHub Action ``` - name: AIReady Code Analysis uses: getaiready/aiready-action@v1 with: threshold: 70 ``` ### MCP Server ``` npm install -g @aiready/mcp-server aiready-mcp ``` ## 🔧 配置 创建 `aiready.json` 配置文件： ``` { "scan": { "exclude": ["**/dist/**", "**/node_modules/**"] }, "tools": { "pattern-detect": { "minSimilarity": 0.5 }, "context-analyzer": { "maxContextBudget": 15000 } }, "output": { "format": "json", "directory": ".aiready" } } ``` ## 🌐 语言支持 **目前支持（95% 市场覆盖率）：** - ✅ TypeScript / JavaScript - ✅ Python - ✅ Java - ✅ Go - ✅ C# ## 🏗️ 架构 ``` 🎯 USER │ ▼ 🎛️ @aiready/cli (orchestrator) │ │ │ │ │ │ │ │ │ │ ▼ ▼ ▼ ▼ ▼ ▼ ▼ ▼ ▼ ▼ [PAT] [CTX] [CON] [AMP] [DEP] [DOC] [SIG] [AGT] [TST] [CTR] │ │ │ │ │ │ │ │ │ │ └─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘ │ ▼ 🏢 @aiready/core ``` ## 📄 许可证 MIT 许可证 - 详见 [LICENSE](./LICENSE)。 ## 🔗 相关链接 - 🌐 [网站](https://getaiready.dev) - 📖 [文档](https://getaiready.dev/docs) - 📦 [npm](https://www.npmjs.com/package/@aiready/cli) - 💖 [赞助](https://github.com/sponsors/caopengau) - 📊 [GitHub Actions](https://github.com/marketplace/actions/aiready-action) - 🔌 [VS Code 扩展](https://marketplace.visualstudio.com/items?itemName=pengcao.aiready)

标签：AI就绪性评估, AI开发工具, AI编程辅助, DevTools, GNU通用公共许可证, JS文件枚举, MITM代理, Node.js, npm包, VS Code扩展, 代码优化, 代码分析, 代码可读性, 代码库评估, 凭证管理, 威胁情报, 开发者工具, 数据可视化, 数据管道, 日志审计, 自动化攻击, 请求拦截, 软件工程, 逆向工具