Skip to main content

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.

Project description

agent-style (PyPI)

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

Install:

pip install agent-style

Basic use:

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.6:

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.6+): 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).

Project details


Download files

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

Source Distribution

agent_style-0.3.6.tar.gz (93.0 kB view details)

Uploaded Source

Built Distribution

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

agent_style-0.3.6-py3-none-any.whl (118.0 kB view details)

Uploaded Python 3

File details

Details for the file agent_style-0.3.6.tar.gz.

File metadata

  • Download URL: agent_style-0.3.6.tar.gz
  • Upload date:
  • Size: 93.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for agent_style-0.3.6.tar.gz
Algorithm Hash digest
SHA256 79e5c0342262ed0df8a2f4ef1e4ffdd1e89d2392a2343223c44515b9fb9f8f0f
MD5 0a6832e3adcbbc4dde9b536ca4eb68b7
BLAKE2b-256 5a62b50cf6c1c1292e6c79c6b5819bce5ac53f4ea861aa9870b7cb2e8d3f6375

See more details on using hashes here.

File details

Details for the file agent_style-0.3.6-py3-none-any.whl.

File metadata

  • Download URL: agent_style-0.3.6-py3-none-any.whl
  • Upload date:
  • Size: 118.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for agent_style-0.3.6-py3-none-any.whl
Algorithm Hash digest
SHA256 b5fbe02a6c1fa9d079d0aa612da1aa7957e4078b6ff5947aa39fc68f3f4ffc01
MD5 bdb6b2d1855f13449c715a51e6e693d5
BLAKE2b-256 aa270582b7cb49dc8ce4e7ff87f110a3b3ef4ae69ed7db1ebb8957a03b517c9e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page