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

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.2.0+): 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.0.tar.gz (83.1 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.0-py3-none-any.whl (108.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: agent_style-0.3.0.tar.gz
  • Upload date:
  • Size: 83.1 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.0.tar.gz
Algorithm Hash digest
SHA256 184d7f22e95605c8de5557e5884ee0f3ba5e4e2e0a79aaeb3feb31c048c7d1ab
MD5 bf3b351cc55e0957cdec3b93eb306d71
BLAKE2b-256 031c8011ad730c25757645c4626a9eb6da180f58e1907b8016d07ca7a32fea86

See more details on using hashes here.

File details

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

File metadata

  • Download URL: agent_style-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 108.2 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6ee57065b3f442fd15cd4db8399abd00bb1807a943a2d103e4e3a4b0426eadb9
MD5 98b4b7ee7806d68963c2f4330d6109db
BLAKE2b-256 da64b662723e77e91cf239d5b880c0154ece01da43939d71cebf89f66ca1980c

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