agentleFS
Sign inStart free
KewtonKewton/CommandMate/AGENTS.md

CommandMate

AGENTS.md44 starsChanged 14 days agoMITView on GitHub

This document provides repository-level guidance for coding agents (including Codex) working in CommandMate. Before finishing, run relevant checks for changed scope: For small fixes, run targeted tests first, then expand only if needed.

  • Deletes or force-pushes

The file

Show its rules and text

We split this AGENTS.md into the rules it gives an agent

16 rules. About 0 are common, 14 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈14

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Keep changes issue-focused and minimal.

    line 24
  2. Distinctive:

    Prefer small, reviewable commits over large refactors.

    line 26
  3. Distinctive:

    Do not introduce unrelated cleanups in the same change.

    line 27
  4. Distinctive:

    If behavior changes, add or update tests in the same PR.

    line 28
  5. Very specific:

    Use strict TypeScript types.

    line 32
  6. Distinctive:

    Keep API validation explicit and defensive.

    line 34
  7. Very specific:

    Follow existing React/Next.js patterns in the touched module.

    line 35
  8. Distinctive:

    Keep comments short and meaningful.

    line 36
  9. Distinctive:

    Do not perform destructive operations (git reset --hard, broad file deletion) unless explicitly requested.

    line 40
  10. Distinctive:

    Do not overwrite user-authored files unexpectedly.

    line 41
  11. Distinctive:

    Treat auth/security-related paths with extra care:

    line 42
  12. Distinctive:

    Before finishing, run relevant checks for changed scope:

    line 50
  13. Distinctive:

    Keep AGENTS.md concise and execution-oriented.

    line 67
  14. Distinctive:

    Avoid duplicating large sections from CLAUDE.md.

    line 68
  15. Distinctive:

    If guidance conflicts are found:

    line 69
  16. Distinctive:

    Update this file and related docs together in the same PR.

    line 71

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

AGENTS.md

This document provides repository-level guidance for coding agents (including Codex) working in CommandMate.

Scope

  • Applies to the entire repository.
  • This file is the primary entry point for agent behavior in this repo.
  • For detailed background and implementation history, refer to README.md, docs/, and CLAUDE.md.

Project Context

  • Project: CommandMate
  • Stack: Next.js 15, React 19, TypeScript, Tailwind CSS 4, SQLite (better-sqlite3)
  • Runtime: Node.js 22+
  • Main areas:
    • src/app: App Router pages and API routes
    • src/lib: core business logic and utilities
    • src/components: UI components
    • tests/unit, tests/integration, tests/e2e: test suites

Working Principles

  1. Keep changes issue-focused and minimal.
  2. Preserve existing architecture and naming patterns.
  3. Prefer small, reviewable commits over large refactors.
  4. Do not introduce unrelated cleanups in the same change.
  5. If behavior changes, add or update tests in the same PR.

Coding Rules

  • Use strict TypeScript types; avoid any unless unavoidable.
  • Reuse existing utilities in src/lib before adding new helpers.
  • Keep API validation explicit and defensive.
  • Follow existing React/Next.js patterns in the touched module.
  • Keep comments short and meaningful; avoid obvious comments.

Safety And Boundaries

  • Do not perform destructive operations (git reset --hard, broad file deletion) unless explicitly requested.
  • Do not overwrite user-authored files unexpectedly.
  • Treat auth/security-related paths with extra care:
    • src/lib/auth.ts
    • src/middleware.ts
    • src/lib/env-sanitizer.ts
    • src/lib/ip-restriction.ts

Validation Checklist

Before finishing, run relevant checks for changed scope:

# unit tests
npm run test:unit

# integration tests when API/DB behavior changes
npm run test:integration

# lint when editing TS/React broadly
npm run lint

For small fixes, run targeted tests first, then expand only if needed.

Change Policy For Agent Docs

  • Keep AGENTS.md concise and execution-oriented.
  • Avoid duplicating large sections from CLAUDE.md; link or reference instead.
  • If guidance conflicts are found:
    1. Prioritize explicit repository files and current code behavior.
    2. Update this file and related docs together in the same PR.

PR Expectations

  • Title format: feat: ..., fix: ..., docs: ..., etc.
  • Include:
    • What changed
    • Why it changed
    • How it was validated
    • Any known risks or follow-up tasks

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free