Metadata-Version: 2.4
Name: ai-rules-sync
Version: 1.0.0
Summary: 跨平台同步 AI 编程 Agent 的中文代码注释规范
Author: AI Rules Sync contributors
License-Expression: MIT
Keywords: ai,agent,rules,codex,claude,qoder
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# AI Rules Sync

AI Rules Sync 是一个只依赖 Python 标准库的跨平台命令行工具，用一份中文代码注释规范同步多个 AI 编程 Agent 的全局规则。

## 使用方式

无需克隆仓库或安装 Python 包，直接使用 `uvx`：

```sh
# 查看当前电脑检测到的 Agent
uvx ai-rules-sync --list

# 同步规则
uvx ai-rules-sync

# 预览变更，不写入文件
uvx ai-rules-sync --dry-run

# 检查是否需要同步；需要同步时返回退出码 1
uvx ai-rules-sync --check

# 只同步指定 Agent
uvx ai-rules-sync --agents codex,claude
```

也可以指定配置目录：

```sh
uvx ai-rules-sync --config-dir /path/to/config
```

## 支持的 Agent

内置支持 Codex、Claude Code、Hermes 和 Qoder。工具会自动检测已安装的 Agent；未检测到的 Agent 会跳过，不会创建配置目录。使用 `--agents` 可以显式初始化指定 Agent。

同步过程只替换受管标记内的规则内容，会保留 Agent 原有配置，并在写入前创建备份。

## 本机配置

共享规则随 PyPI wheel 一起发布。安装后的本机覆盖配置和备份默认保存在：

- macOS/Linux：`~/.config/ai-rules-sync/`
- Windows：`%APPDATA%\\ai-rules-sync\\`

也可以通过 `AI_RULES_HOME` 或 `--config-dir` 指定配置目录。完整的配置格式、安全策略和开发说明请参阅项目中的 [使用说明书](docs/USAGE.md)。
