Skip to main content

🤖 Repoize

一条命令让任何项目对 AI Agent 友好

PyPI version Python Versions License: MIT Downloads

English | 中文


🚀 一键生成 AI Agent 配置文件

自动生成 AGENTS.mdCLAUDE.md.cursorrules、MCP Server 配置、Skill 文件,让 Claude Code、Cursor、Copilot 等 AI 编程助手立即理解你的项目。

✨ 特性

  • 🔍 智能分析 — 自动检测语言、框架、依赖、构建命令
  • 📊 代码质量 — 分析代码质量,检测质量工具和配置
  • 🔄 增量更新 — 保留手写内容,只更新生成区间
  • 🛡️ 隐私安全 — 纯本地分析,自动过滤敏感环境变量
  • 🌐 多语言支持 — Python、JavaScript、TypeScript、Go、Rust、Java、Ruby、PHP

📦 安装

pip install repoize

🎯 快速开始

# 一键扫描 + 生成所有配置文件
repoize init

# 查看项目分析报告(含代码质量分析)
repoize analyze

# 选择性生成配置文件
repoize generate --type agents --type claude --type cursorrules

# 检查项目 Agent 就绪度
repoize check

# 增量更新配置
repoize update

📋 支持的配置文件

配置文件 用途
AGENTS.md 通用 Agent 指令
CLAUDE.md Claude Code 专属指令
.cursorrules Cursor AI 规则
.github/copilot-instructions.md GitHub Copilot 指令
.claude/mcp.json MCP Server 配置
.claude/skills/*/SKILL.md 项目专属 Skill 文件

📊 代码质量分析

Repoize 不仅生成配置文件,还能分析项目的代码质量:

代码质量: 优秀 (100/100)

代码统计:
  文件数: 39
  总行数: 3,668
  代码行: 2,929
  质量工具: pytest, ruff
  质量配置: pyproject.toml

🔧 高级用法

# 输出 JSON 格式的分析结果
repoize analyze --format json --output analysis.json

# 校验 JSON 输出是否符合 Schema
repoize validate analysis.json

# 跳过环境变量扫描
repoize analyze --no-env

# 强制覆盖已有文件
repoize init --force

📁 示例输出

运行 repoize analyze 后的输出示例:

┌───────────────────────────── 📊 项目健康度报告 ─────────────────────────────┐
│ my-project                                                                  │
└─────────────────────────────────────────────────────────────────────────────┘

语言: Python (主)
语言画像: Python
框架: fastapi, sqlalchemy

Agent 就绪度: 完备 (100/100)
代码质量: 优秀 (85/100)

┌─────────────────────────────────────┬───────────┬──────────────────────┐
│ 配置文件                            │   状态    │ 说明                 │
├─────────────────────────────────────┼───────────┼──────────────────────┤
│ AGENTS.md                           │ ✅ 已配置 │ 通用 Agent 指令      │
│ CLAUDE.md                           │ ❌ 未配置 │ Claude Code 专属指令 │
│ .cursorrules                        │ ❌ 未配置 │ Cursor AI 规则       │
└─────────────────────────────────────┴───────────┴──────────────────────┘

🛠️ 开发

# 克隆仓库
git clone https://github.com/LQDC3417/repoize.git
cd repoize

# 安装开发依赖
pip install -e ".[dev]"

# 运行测试
pytest

# 代码检查
ruff check src/ tests/
ruff format --check src/ tests/

📄 License

MIT License - 详见 LICENSE 文件


🚀 Make Any Project AI Agent Friendly

Auto-generate AGENTS.md, CLAUDE.md, .cursorrules, MCP Server config, and Skill files to help Claude Code, Cursor, Copilot and other AI coding assistants understand your project instantly.

✨ Features

  • 🔍 Smart Analysis — Auto-detect languages, frameworks, dependencies, and build commands
  • 📊 Code Quality — Analyze code quality, detect quality tools and configurations
  • 🔄 Incremental Updates — Preserve handwritten content, only update generated sections
  • 🛡️ Privacy Safe — Pure local analysis, auto-filter sensitive environment variables
  • 🌐 Multi-language — Python, JavaScript, TypeScript, Go, Rust, Java, Ruby, PHP

📦 Installation

pip install repoize

🎯 Quick Start

# Scan + generate all config files
repoize init

# View project analysis report (with code quality)
repoize analyze

# Generate specific config files
repoize generate --type agents --type claude --type cursorrules

# Check project agent readiness
repoize check

# Incremental update
repoize update

📋 Supported Config Files

Config File Purpose
AGENTS.md General Agent instructions
CLAUDE.md Claude Code specific instructions
.cursorrules Cursor AI rules
.github/copilot-instructions.md GitHub Copilot instructions
.claude/mcp.json MCP Server config
.claude/skills/*/SKILL.md Project-specific Skill files

📄 License

MIT License - see LICENSE for details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

repoize-0.1.0.tar.gz (54.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

repoize-0.1.0-py3-none-any.whl (41.2 kB view details)

Uploaded Python 3

File details

Details for the file repoize-0.1.0.tar.gz.

File metadata

  • Download URL: repoize-0.1.0.tar.gz
  • Upload date:
  • Size: 54.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.5

File hashes

Hashes for repoize-0.1.0.tar.gz
Algorithm Hash digest
SHA256 b7ea4cea830ae3c6acc29c854dea1892596cc330767b14f14f2dbcff607748a2
MD5 c5c81de7170194a23f2919e9c53f9f5f
BLAKE2b-256 b6ec3fd53cf7429022a4e8eea1d63e9dac23682248b3e552159a6560c8c4518c

See more details on using hashes here.

File details

Details for the file repoize-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: repoize-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 41.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.5

File hashes

Hashes for repoize-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7067bba4b5fa4ba7abf3919a2597a1db3e5e10d843d05cd8104a8c1c6a198551
MD5 c22b1bd43d3535e0876b68471da3880c
BLAKE2b-256 f7205bbf15f366cad5628ddecd271c879f2d80225feee586a8a127784d940c54

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page