forge-setup-project（锻造设置项目）

Set Up or Update Project Context Infrastructure

Set up or update a project's context infrastructure for agentic engineering. Context is organized in three tiers:

Central principle: context must earn its token cost. Only include knowledge that agents cannot discover by exploring the codebase with Grep, Glob, and Read.

CLAUDE.md is a compatibility symlink to AGENTS.md, never a separate source of truth.

Input

Primary input: optional project root path.

Optional last parameter: -- <additional context>

Interpret $ARGUMENTS as one of:

• <path>
• <path> -- <additional context>
• -- <additional context>

If no path is provided, use the current working directory. Use any additional context as execution guidance, not as a replacement for codebase exploration.

Process

Step 1: Determine Mode

Scan the project root for AGENTS.md, CLAUDE.md, README.md, and docs/.

Step 2: Explore the Codebase

Skip for greenfield projects (no code exists).

Explore the project thoroughly: directory structure, language/runtime, package manager and scripts, entry points, CI/CD, lint/format/test configuration, local development/runtime setup, existing documentation.

As you explore, classify each finding:

• Discoverable — an agent can find this by exploring (file patterns, scripts, structure)
• Requires documentation — an agent cannot infer this from code (decisions, conventions, failure modes, invariants)

Only the second category belongs in context files.

After exploration, assess agent readiness:

• Feedback loops — tests exist and pass? Linter? Build? How fast is the cycle?
• Module structure — clear entry points? Logical boundaries? Explicit interfaces?
• App legibility — bootable locally? UI inspectable? Logs queryable?
• Known risks — what will trip an agent up?

Record findings for the summary.

Step 3: Audit Existing Guidance (Audit & Legacy Migration modes only)

Read all existing guidance files. Score each section:

Present an audit report. Group recommendations into quick wins, high-value additions, and structural changes. Get user confirmation via AskUserQuestion before applying.

Step 4: Gather Project Information

Use AskUserQuestion to collect what cannot be determined from code. Incorporate any optional additional context when deciding what to ask, audit, or prioritize.

Always ask:

1. Core principles — "What 3-5 rules should always guide development?" Offer examples from what you observed.
2. Failure modes — "What mistakes do agents or new developers repeat? What breaks?" Each entry must trace to an observed mistake.
3. Domain invariants — "What rules must never be violated? What causes silent bugs?"

Ask only if ambiguous from code:

1. Conventions with enforcement mechanisms
2. Confirm detected commands if multiple options exist
3. How to handle existing meta files (if found without AGENTS.md)

Never ask what's discoverable from code — language, framework, test runner, scripts, directory structure.

For Audit/Migration modes, ask about gaps found in Step 3.

Step 5: Generate or Update AGENTS.md

Create or update AGENTS.md. Target ~150-200 lines. Every line must pass the undiscoverability test.

See agents-md-template.md for the template structure.

For Legacy Migration: migrate accepted content into AGENTS.md, fold duplicates, replace legacy file with symlink in Step 7.

Step 6: Generate or Update Tier 2 — docs/

Only create docs with actual content. An empty doc wastes context.

Always created:

• docs/architecture.md — design decisions, data flow, module responsibilities. Not directory listings.
• docs/pr-workflow.md — branch naming, PR checklist, review process. Reference AGENTS.md for commit format.

Created only when warranted (offer via AskUserQuestion based on detection):

• docs/development.md — when setup has gotchas or multi-step requirements
• docs/coding-guidelines.md — when project has specific patterns worth codifying
• docs/testing.md — when test patterns are non-obvious
• Additional domain-specific docs as needed

All Tier 2 docs must pass the undiscoverability test. Use tables for structured data. Include actual file paths.

Step 7: Compatibility Symlink and.gitignore

rm -f CLAUDE.md
ln -sf AGENTS.md CLAUDE.md

If the platform doesn't support symlinks, stop and tell the user.

Create or update .gitignore with entries matching the detected stack. Never overwrite an existing .gitignore — append only missing entries.

Step 8: Human-Facing Files

Create if it doesn't exist (this is for humans, not agent context):

• README.md — project description, quick start, docs links. If one exists, ask: replace, merge, or keep?

Step 9: Commit

Stage and commit all new/modified files:

• Setup mode: docs: set up agentic context infrastructure
• Audit/Migration: docs: update context infrastructure

Do not commit if: dry run requested, unrelated staged changes exist, or generated files have unresolved questions.

Step 10: Summary

Report what was created/changed. See output-format.md for the structure. Include tier status with line counts, agent readiness assessment, and next steps.

Guidelines

The Undiscoverability Test: Before writing any content — "Would an agent find this by exploring?" If yes, don't write it. Write: decisions, unenforced conventions, failure modes, invariants, gotchas. Don't write: directory structure, generic descriptions, boilerplate.

Signal Over Volume: Tables beat paragraphs. Constraint hierarchies beat generic advice. Empty sections with <!-- TODO --> markers waste context — omit the section instead.

Tier Discipline: AGENTS.md targets 150-200 lines. If growing past 200, move detail to Tier 2. No duplication across tiers. Factor in other context consumers (auto-memory, MCP tools, skills).

Edge Cases: Monorepos — root-level files referencing sub-packages, suggest per-package AGENTS.md. No tests/CI — skip those docs, mention as next steps. Multiple languages — group commands by language.

Related Skills

Next step: Use forge-create-issue to plan your first piece of work — or forge-shape if the idea is still rough and needs convergent questioning first.

Example Usage

/forge-setup-project
/forge-setup-project /path/to/project
/forge-setup-project /path/to/project -- focus on the docs/ and AGENTS.md split for a monorepo
/forge-setup-project -- keep the setup lean and call out missing feedback loops