Static utility · No backend · No AI calls

Create AI-Ready Repo Documentation

Pick a preset, fill the structured fields, fix the inline lint warnings, and copy or download a clean AGENTS.md — without scanning your repository or sending data anywhere.

Start building Read the guide

Next.js Static Vite React Chrome Extension Node CLI Python CLI

Preset picker

Choose a strong starting point, then edit only what is specific to your repository.

Structured builder form

Required fields first, then stack rules, workflow rules, and optional notes.

Project name

One-line purpose

Primary language or runtime

Package manager

Install command

Dev command

Lint command

Typecheck command

Build command

Test command

Directory or architecture notes

Code style rules

Short, imperative rules for how the code should be written.

Testing instructions

What agents must verify before they finish.

Safety rules

Rules about sensitive changes, storage, and risky behavior.

Forbidden actions

Non-negotiable things the agent must never add or do.

Commit rules

How and when the agent should commit.

Branch rules

When the agent should branch and how to scope work.

Pull request rules

What should appear in review-ready summaries.

Optional project notes

Extra reminders that should only appear when they add signal.

Export actions

Last saved: Loading draft...

Lint panel

1 items

TipA section is getting long

Shorten long notes so the generated AGENTS.md stays fast to scan.

Live AGENTS.md preview

Plain text only

AGENTS.md

# Project Purpose
- Project name: Next.js Static Export
- Purpose: Generate and maintain a focused Next.js Static codebase with explicit agent rules.
- Preset: nextjs-static
- Primary runtime: TypeScript + Next.js App Router
- Package manager: npm

# Hard Constraints
- Do not add API routes, server actions, or middleware.
- Do not add remote AI calls or repository scanning.
- Do not weaken static export to support convenience features.

# Setup and Verification Commands
- Install: `npm install`
- Dev: `npm run dev`
- Lint: `npm run lint`
- Typecheck: `npm run typecheck`
- Build: `npm run build`
- Test: `npm run test`

## Testing Instructions
- Cover markdown section order and omission behavior with Vitest.
- Cover lint heuristics for missing rules, duplicate commands, and placeholder text.

# Code Conventions
- Use TypeScript strict mode and explicit exported types.
- Keep generation and lint logic deterministic and side-effect free.
- Prefer small components and plain CSS over framework-heavy abstractions.

# Safety Rules
- Keep all draft data in browser memory and localStorage only.
- Do not add runtime remote fetches, cookies, auth, or analytics SDKs.

# Git Workflow Rules
## Commit Rules
- Use Conventional Commits.
- Commit only after lint, typecheck, test, and build pass.

## Branch Rules
- Create a feature or fix branch for non-trivial work off the default branch.
- Keep each branch scoped to one logical unit.

## Pull Request Rules
- Summarize the changed preset or route behavior and list validation commands.
- Call out SEO, localStorage, or static-export impacts explicitly.

# Directory or Architecture Notes
- Keep routes in /app, reusable UI in /components, static preset and template copy in /content, and pure generation or linting helpers in /lib. Preserve static export compatibility across every route.

# Optional Project-Specific Notes
- Prefer query-param preset entry points such as `/?preset=nextjs-static` for landing-page CTAs.

Why this builder exists

Most AGENTS files fail because they are vague, missing commands, or overloaded with unrelated policy. This builder narrows the output to the sections agents actually need to act safely.

What the lint panel checks

It flags missing verification commands, missing forbidden actions, vague phrases, duplicate commands, stack-mismatched commands, and long sections that should be shorter.

Builder FAQ

Does AGENTS.md Builder use AI to generate the file?

No. The file is assembled from local preset data, form input, and deterministic string-building logic in your browser.

Does it scan my repository?

No. You enter project details manually and the builder never reads your repository automatically.

Will my draft survive a refresh?

Yes. The current draft is saved to localStorage and restored in the same browser unless you clear it.

Can I download the result directly as AGENTS.md?

Yes. The download action always saves the file as `AGENTS.md`.