update-instructions
Update CLAUDE.md and AGENTS.md instruction files with smart merge. Preserves user customizations while updating SpecWeave sections. Use after plugin refresh, version upgrade, or when instruction files need sync. Activates for: update instructions, refresh claude.md, merge agents.md, sync instruction files, upgrade specweave config.
Installation
Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.
View source ↗GuidesSkill instructions
Update Instructions Skill
Smart merge for CLAUDE.md and AGENTS.md instruction files.
What It Does
- Reads existing instruction files (if present)
-
Parses SW-managed sections (marked with
<!-- SW:SECTION:X -->) - Preserves user content (anything between or after SW sections)
- Updates SW sections with latest template content
- Writes merged result back to file
When to Use
- After running
specweave refresh-marketplace - After upgrading SpecWeave version (
npm update -g specweave) - When CLAUDE.md or AGENTS.md seem outdated
- To sync instruction files with latest framework features
Usage
/sw:update-instructions
Or via CLI:
npx specweave update-instructions
How Merge Works
Fresh Install (no existing file)
Creates new file with all SW sections + meta header
Legacy File (no SW markers)
Prepends new SW content, preserves original below separator
Marked File (has SW markers)
Updates SW sections in-place, preserves user content between sections
Section Format
Template sections (in .template files):
<!-- SECTION:rules required -->
## Rules
Content here...
<!-- /SECTION -->
Generated sections (in output files):
<!-- SW:META template="claude" version="1.0.0" sections="header,rules,..." -->
<!-- SW:SECTION:header version="1.0.0" -->
Content...
<!-- SW:END:header -->
User Customization
Add custom content between SW sections or after the last section:
<!-- SW:END:docs -->
## My Custom Section
This will be preserved during updates!
Files Affected
-
CLAUDE.md- Claude Code instruction file -
AGENTS.md- Generic AI tool instruction file
Examples
Read the usage examples in the source repository.
View source ↗Source history
- Indexed on
- 2026-01-20
- Index updated
- 2026-01-28
- Branch
- main
Index and sync dates describe this directory. View the source repository for code history.
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!