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 8 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.1.1:

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)

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 8 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.1.1.tar.gz (51.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.1.1-py3-none-any.whl (66.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: agent_style-0.1.1.tar.gz
  • Upload date:
  • Size: 51.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.1.1.tar.gz
Algorithm Hash digest
SHA256 c808da1025b63f6b17db25860756d4b5bdf525ff26a2168d1805b30d42f2cc12
MD5 6efc55261873ed33f5b84c8cb66af45d
BLAKE2b-256 9880e20473d7e3276d400ec6527cf9882ff326c520e36c8e77b972ea92e3af77

See more details on using hashes here.

File details

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

File metadata

  • Download URL: agent_style-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 66.8 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.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 27a2fb51b7fe2362816902000d37e0e48eaa9ba3e80cfaffdb3a47d50ea76b27
MD5 61649ad1c4da147eff7bfb3a80ae0b49
BLAKE2b-256 c95915504afcaaa4c8d8ad71ea6ca96a53ae4e27f61310f28572ccea2595865c

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