Skip to content

feat: new CLI options for AGENTS.md documentation - #245

Open
hvrp3r wants to merge 1 commit into
mainfrom
feat/agents-md-on-new
Open

hvrp3r wants to merge 1 commit into
mainfrom
feat/agents-md-on-new

Conversation

@hvrp3r

@hvrp3r hvrp3r commented Oct 23, 2026

Copy link
Copy Markdown
Member

What does this PR do?

Closes #235.

nf new now generates AGENTS.md files so that AI coding agents (Codex, Cursor, GitHub Copilot, Gemini CLI, Claude Code, ...) understand a NanoForge project out of the box. AGENTS.md is the cross-tool standard read by most code-generation agents, so a single file covers all of them instead of one file per tool (CLAUDE.md, .cursorrules, ...).

How do you test this PR?

  • New unit test for the agents input (agents.input.spec.ts).
  • New e2e tests in libs/schematics:
    • project: AGENTS.md generated by default with the project specifics (package name, part, entry point, editor command), standalone server project without workspace references, JavaScript variant, not generated with agents: false, no leftover template tags.
    • workspace: generated at the root with the right package manager commands, JavaScript variant, not generated with agents: false.
  • Manual check with the built CLI:
    • nf new --no-server → AGENTS.md at the project root.
    • nf new --server → AGENTS.md at the root, in apps/client and in apps/server.
    • nf new --no-agents → no AGENTS.md.

@hvrp3r hvrp3r self-assigned this Oct 23, 2026
@hvrp3r
hvrp3r requested a review from Exeloo as a code owner October 23, 2026 15:17
@github-actions github-actions Bot added documentation Improvements or additions to documentation command:new Related to new command lib:schematics Related to the @nanoforge-dev/schematics library labels Oct 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

command:new Related to new command documentation Improvements or additions to documentation lib:schematics Related to the @nanoforge-dev/schematics library

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add AI documentation for new nf project

1 participant