# agentrules — Multi-Provider AGENTS.md Generator

> agentrules generates AGENTS.md via a six-phase analysis pipeline; verified 117★. Install with `pip install -U agentrules`, then run `agentrules analyze`.

## Install

Save the content below to `.claude/skills/` or append to your `CLAUDE.md`:

## Quick Use

```bash
pip install -U agentrules
agentrules --version
agentrules configure  # store API keys + presets
agentrules analyze /path/to/your/repo
```

## Intro

agentrules generates AGENTS.md via a six-phase analysis pipeline; verified 117★. Install with `pip install -U agentrules`, then run `agentrules analyze`.

**Best for:** Engineers standardizing repo guidance for multiple coding agents across providers

**Works with:** Anthropic/OpenAI/Google/DeepSeek/xAI providers and optional local Codex runtime (per README)

**Setup time:** 12-25 minutes

### Key facts (verified)

- GitHub: 117 stars · 18 forks · pushed 2026-05-08.
- License: MIT · owner avatar + repo URL verified via GitHub API.
- README-backed entrypoint: `pip install -U agentrules`.

## Main

- Run `agentrules analyze` to generate an AGENTS.md-style contract based on your repo structure, then keep it as a durable entrypoint for agents.

- Use the interactive `configure` flow to keep provider keys and presets out of the repo and inside user config (README points to ~/.config/agentrules/config.toml).

- Start with an offline/low-risk smoke run (README includes a smoke test) before turning on web search or live API providers in CI.

### Source-backed notes

- README shows PyPI install: `pip install -U agentrules` and a smoke test `agentrules analyze /path/to/project`.
- README says settings live in `~/.config/agentrules/config.toml` (override via `AGENTRULES_CONFIG_DIR`).
- README describes a six-phase analysis pipeline ending in AGENTS.md generation.

### FAQ

- **Is it tied to one model provider?**: No — README lists multiple providers and also mentions optional local Codex runtime presets.
- **Where do keys live?**: README says keys and preferences are stored in `~/.config/agentrules/config.toml`.
- **What is the first command to try?**: Install, then run `agentrules analyze /path/to/project` as the smoke test in README.

## Source & Thanks

> Source: https://github.com/trevor-nichols/agentrules-architect
> License: MIT
> GitHub stars: 117 · forks: 18

---

<!-- ZH -->

## Quick Use

```bash
pip install -U agentrules
agentrules --version
agentrules configure  # store API keys + presets
agentrules analyze /path/to/your/repo
```

## Intro

agentrules 通过六阶段分析管线生成 AGENTS.md；已验证 117★，支持 `pip install -U agentrules`，并提供 `analyze` 命令对仓库做快照式分析输出。

**Best for:** 希望为多家 provider 的 coding agent 统一产出仓库指南的工程团队

**Works with:** Anthropic/OpenAI/Google/DeepSeek/xAI 等 provider，以及可选的本地 Codex runtime（README 标注）

**Setup time:** 12-25 minutes

### Key facts (verified)

- GitHub：117 stars · 18 forks；最近更新 2026-05-08。
- 许可证：MIT；作者头像与仓库链接均已通过 GitHub API 复核。
- README 中可对照的入口命令：`pip install -U agentrules`。

## Main

- 用 `agentrules analyze` 基于仓库结构生成 AGENTS.md 合同式入口，再把它作为后续 agent 的长期入口文件。

- 用交互式 `configure` 管理 provider 的 key 与 preset，避免把凭据写进仓库（README 指向 ~/.config/agentrules/config.toml）。

- 上线前先跑一遍低风险 smoke test（README 提供 smoke test），再把 web search 或 live provider 接入到更重的流程里。

### Source-backed notes

- README 给出 PyPI 安装方式：`pip install -U agentrules`，以及 `agentrules analyze /path/to/project` 的 smoke test。
- README 说明配置保存于 `~/.config/agentrules/config.toml`（可用 `AGENTRULES_CONFIG_DIR` 覆盖）。
- README 描述了以 AGENTS.md 生成为终点的六阶段分析管线。

### FAQ

- **只能绑定单一 provider 吗？**：不是。README 列出多 provider，并提到可选的本地 Codex runtime preset。
- **key 存在哪里？**：README 说明存放于 `~/.config/agentrules/config.toml`。
- **最先该跑哪个命令？**：按 README：安装后先执行 `agentrules analyze /path/to/project` 做 smoke test。

## Source & Thanks

> Source: https://github.com/trevor-nichols/agentrules-architect
> License: MIT
> GitHub stars: 117 · forks: 18


---
Source: https://tokrepo.com/en/workflows/agentrules-multi-provider-agents-md-generator
Author: Script Depot