Main
Run
agentrules analyzeto generate an AGENTS.md-style contract based on your repo structure, then keep it as a durable entrypoint for agents.Use the interactive
configureflow 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 agentrulesand a smoke testagentrules analyze /path/to/project. - README says settings live in
~/.config/agentrules/config.toml(override viaAGENTRULES_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/projectas the smoke test in README.