Skip to content

Add agent-prompt command and restructure documentation#24

Merged
CodesMcCabe merged 5 commits intomainfrom
cm/readme-agent-adj
Mar 13, 2026
Merged

Add agent-prompt command and restructure documentation#24
CodesMcCabe merged 5 commits intomainfrom
cm/readme-agent-adj

Conversation

@CodesMcCabe
Copy link
Collaborator

Summary

  • Add agent-prompt command that emits complete automation/agent usage instructions in both JSON and human-readable formats
  • Restructure README with user-focused getting started flow and authentication quick start
  • Move maintainer/developer docs to dedicated MAINTAINERS.md file
  • Update AGENTS.md styling guidance

Changes

New command:

  • alchemy agent-prompt - Outputs execution policy, auth methods, error codes with recovery guidance, command schema, and usage examples for agents/automation tools

Documentation improvements:

  • Reorganized README with "Getting Started" section first, covering auth setup and usage by workflow (humans vs agents/scripts)
  • Extracted development, release, and local testing docs to MAINTAINERS.md for better audience separation
  • Enhanced authentication reference with clearer explanations of each auth method's purpose

Test plan

  • Unit tests for agent-prompt command
  • E2E test verifies agent-prompt is registered
  • Existing tests pass
  • Manual verification of JSON and human-readable output formats

Made with Cursor

Refocus README on end-user onboarding and command usage while moving maintainer-focused development and release operations into MAINTAINERS.md.

Made-with: Cursor
Align AGENTS.md with current shared formatting modules by including src/lib/error-format.ts in the preferred helper paths.

Made-with: Cursor
Adds `alchemy agent-prompt` which emits a complete, machine-readable
contract (JSON or plain-text) containing execution policy, preflight,
auth matrix, full command tree, error codes with recovery actions,
examples, and docs URL -- so agents can learn how to use the CLI
entirely from the CLI itself.

Made-with: Cursor
Show agents how to run `alchemy --json agent-prompt` as their first
step to get the full CLI contract without external docs.

Made-with: Cursor
@CodesMcCabe CodesMcCabe merged commit 8bcbb45 into main Mar 13, 2026
7 checks passed
@CodesMcCabe CodesMcCabe deleted the cm/readme-agent-adj branch March 13, 2026 00:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant