pi-agentsmd

pi-agentsmd

Teach Pi and other coding agents how your repository works with one command.

pi-agentsmd analyzes your project and creates a tailored AGENTS.md with the commands, conventions, and contribution guidance agents need to make better changes from their first turn.

Features

• One-command repository onboarding — run /init to generate guidance at the repository root.
• Project-aware instructions — the active model studies your structure, tooling, tests, and conventions instead of producing a generic template.
• Safe regeneration — existing guidance stays untouched unless you explicitly pass --force.
• Proven foundation — generation prompt is adapted from OpenAI Codex (Apache 2.0).

Installation

Install from npm:

pi install npm:pi-agentsmd

Install project-locally:

pi install -l npm:pi-agentsmd

During local development from this monorepo:

pi install /path/to/pi-mono/packages/pi-agentsmd

Usage

Generate AGENTS.md

Run the /init command inside a repository:

/init

Pi will inspect executable configuration and repository documentation, then include only verified guidance that is useful for the project. This can cover:

• Non-obvious structure and package boundaries
• Exact build, test, lint, and type-check commands
• Focused verification steps and prerequisites
• Generated or protected files
• Conventions not enforced by tooling
• Repository-specific security and completion criteria

The generated file refers to authoritative project documents instead of duplicating them. The model is instructed not to run project commands or install dependencies during generation.

Update existing AGENTS.md

If AGENTS.md already exists, use --force to reconcile it:

/init --force

Force mode preserves accurate project guidance while correcting stale or duplicate information.

How it works

The /init command sends a structured prompt to the active AI model. The model uses its file tools to inspect the repository and generate an AGENTS.md file tailored to the project. The package itself does not write the file — it delegates entirely to the model.

Development

Requirements:

• Node.js >= 20.6.0
• npm

npm install
npm run check
npm run pack:dry-run

Contributing

Contributions are welcome. See CONTRIBUTING.md for development workflow and pull request guidelines.

License

MIT. See LICENSE.

Includes a prompt derived from OpenAI Codex, licensed under the Apache License 2.0. See THIRD-PARTY-NOTICES.