Quick Start

Choose the path that matches your situation.

New project

1. Scaffold the canonical directory

   agentsmesh init

   This creates:

   • agentsmesh.yaml — project configuration
   • agentsmesh.local.yaml — local overrides (gitignored)
   • .agentsmesh/rules/_root.md — starter root rule
   • Updates .gitignore to exclude agentsmesh.local.yaml

2. Edit your root rule

   # Open the root rule in your editor
   vi .agentsmesh/rules/_root.md

   Example root rule:

   ---
   root: true
   ---
   
   # Project Guidelines
   
   - Write tests before implementation.
   - Max 200 lines per file.
   - Use TypeScript strict mode.
   - Prefer pure functions over classes.

3. Configure your targets

   Open agentsmesh.yaml and set the tools your team uses:

   version: 1
   targets:
     - claude-code
     - cursor
   features:
     - rules
     - commands
     - mcp

4. Generate

   agentsmesh generate

   Output files are written to each tool’s native directory (.claude/, .cursor/, etc.).

Existing project with tool configs

1. Initialize

   agentsmesh init

   AgentsMesh scans for existing configs in .claude/, .cursor/, .cline/, .junie/, .continue/, .gemini/, .codex/, .windsurf/, and .github/copilot-instructions.md. It prompts you to import each one found.

   To auto-import everything without prompts:

   agentsmesh init --yes

2. Review the canonical files

   ls .agentsmesh/rules/
   ls .agentsmesh/commands/
   cat .agentsmesh/permissions.yaml

3. Generate for all targets

   agentsmesh generate

4. Verify nothing unexpected changed

   agentsmesh diff

   If the diff looks clean, commit both .agentsmesh/ and the generated files.

Tip

After init, .agentsmesh/ is the only thing you should edit. Generated files in .claude/, .cursor/, etc. are artifacts — regenerate them, don’t edit them directly.

What’s next

• Add rules, commands, agents, and skills
• Set up CI drift detection
• Share config across repositories with extends
• Browse the full CLI reference