Metadata-Version: 2.4
Name: agent-style
Version: 0.3.5
Summary: The Elements of Agent Style: a literature-backed English technical-prose writing ruleset for AI agents, with CLI install/enable/disable for 9 primary agent surfaces.
Author-email: Yue Zhao <fortis@usc.edu>
License: MIT AND CC-BY-4.0
Project-URL: Homepage, https://github.com/yzhao062/agent-style
Project-URL: Repository, https://github.com/yzhao062/agent-style
Project-URL: Issues, https://github.com/yzhao062/agent-style/issues
Project-URL: Changelog, https://github.com/yzhao062/agent-style/blob/main/CHANGELOG.md
Keywords: writing,style,agent,llm,ai,instructions,prompt
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Text Processing :: Markup
Requires-Python: >=3.8
Description-Content-Type: text/markdown

<!-- SPDX-License-Identifier: MIT -->

# agent-style (PyPI)

CLI for *The Elements of Agent Style*: a literature-backed English technical-prose writing ruleset for AI agents.

Install:

```bash
pip install agent-style
```

Basic use:

```bash
agent-style list-tools                               # show supported tools
agent-style enable claude-code                       # wire up Claude Code
agent-style enable claude-code --dry-run --json      # preview in canonical JSON
agent-style disable claude-code                      # reverse
agent-style rules                                    # print bundled RULES.md
```

The CLI writes to `.agent-style/` in your project and safely adds a marker-wrapped reference to your existing instruction file (CLAUDE.md, AGENTS.md, .github/copilot-instructions.md, etc.). Existing content is preserved; writes are idempotent; `--dry-run` previews without changing any file.

Supported tools and install modes in v0.3.5:

| Tool | Install mode |
| --- | --- |
| claude-code | import-marker (writes `@.agent-style/claude-code.md` to your CLAUDE.md) |
| agents-md | append-block (writes a marker block to your AGENTS.md) |
| copilot | append-block (writes a marker block to `.github/copilot-instructions.md`) |
| copilot-path | owned-file (writes `.github/instructions/agent-style.instructions.md`) |
| cursor | owned-file (writes `.cursor/rules/agent-style.mdc`) |
| anthropic-skill | owned-file (writes `.claude/skills/agent-style/SKILL.md`) |
| codex | print-only (writes `.agent-style/codex-system-prompt.md`; stdout = prompt) |
| aider | multi-file-required (writes `.agent-style/aider-conventions.md`; stderr = `.aider.conf.yml` snippet) |
| kiro | owned-file (writes `.kiro/steering/agent-style.md`) |

The full rule set lives in the canonical repository at https://github.com/yzhao062/agent-style. This PyPI package bundles `RULES.md`, `NOTICE.md`, the 9 primary adapters, and the `tools.json` registry; running `agent-style rules` prints the bundled `RULES.md` for quick review.

## License

- Code: MIT (`LICENSES/MIT.txt`).
- Bundled prose (`RULES.md`, `NOTICE.md`, adapters): CC BY 4.0 (`LICENSES/CC-BY-4.0.txt`).

Roadmap (v0.3.5+): `agent-style update` (pull refreshed adapters), `agent-style override <RULE> disable` (per-rule opt-out), `agent-style clean` (single-command uninstall), `.agent-style/config.toml` (project-level config).
