Skip to content

CONFIGURATION.md

Latest commit

 

History

History
70 lines (44 loc) · 1.87 KB

CONFIGURATION.md

File metadata and controls

70 lines (44 loc) · 1.87 KB
Raw

Configuration & Customisation

Generated files are yours

All files generated by the wizard are plain markdown — edit them freely. The wizard only creates/updates them; it does not lock or reformat on re-run (unless you pass --overwrite).

CLAUDE.md

CLAUDE.md is loaded automatically by Claude Code on every conversation. It provides project-level context so you don't have to repeat yourself.

After generation, review and customise:

  • Add project-specific folder structure notes
  • Add team conventions not covered by the defaults
  • Remove sections that don't apply
  • Adjust command names to match your Makefile / composer.json scripts

Slash commands

Files in .claude/commands/ become slash commands in Claude Code.

File name = command name: .claude/commands/rector-dry.md → /rector-dry

You can:

  • Edit the markdown to change what Claude does when you invoke the command
  • Add new files for custom commands
  • Delete files for commands you don't use

Adding a custom command

Create .claude/commands/my-command.md:

Do the following when this command is invoked:

1. ...
2. ...

Then use /my-command in Claude Code.

Sub-agents

Files in .claude/agents/ define sub-agents that Claude Code can delegate work to.

Each agent file must have a YAML frontmatter block:

---
name: my-agent
description: Use this agent when... (be specific — Claude uses this to decide when to delegate)
---

You are an expert in...

## Your responsibilities
...

The description field is crucial — Claude uses it to decide when to automatically invoke the agent vs. handling the task itself.

Keeping files in sync

If you install a new tool (e.g., add PHPStan to a project that didn't have it), re-run the wizard to generate the missing commands:

vendor/bin/claude-php-setup

Existing files are skipped, so only new ones are created.