User-facing documentation drifted behind several waves of feature work
(plugin manifest, hooks, sync command, --weekly, audit skills, Karpathy
skill, CLAUDE.local.md tier, layered hook config). Refresh + fix one
real install bug. Surgical edits only — no rewrites.
README.md:
- "What's New" block now reflects the plugin manifest, --weekly,
InstructionsLoaded hook, AGENTS.md interop, CLAUDE.local.md tier,
layered hook config, and the fail-closed guardian.
- "What's Included" expanded from 5 numbered bullets to a structured
list grouping the 5 skills (incl. three forked audit skills),
2 slash commands, 1 agent, and 3 hook scripts.
- Components Deep Dive: /sync-claude-md and the guardian's fail-closed
contract now documented.
- Project Status: 1.0.0 -> 2.1.0; Quick Stats updated to reflect
actual component counts.
- Acknowledgments: attribution to MIT-licensed forrestchang and
shanraisshan source repos for adapted patterns.
docs/ARCHITECTURE.md, docs/QUICK_START.md, docs/TROUBLESHOOTING.md,
docs/INSTALLATION.md, examples/modular-setup.md, examples/integration-
examples.md:
- Every "20-300 lines" / ">300 lines" / "exceeds 300 lines" reference
rewritten to the actual 150-line hard cap.
- Every ls/Remove-Item path that pointed at the legacy
~/.claude/commands/enhance-claude-md/ bundle now points at the
top-level enhance-claude-md.md + sync-claude-md.md files.
- integration-examples.md line-bounds shell guard now uses 20..150.
docs/CLAUDE.md:
- Install-verify ls list extended with the three new audit-skill
directories so docs match what install.sh actually creates.
install.sh + install.ps1 (REAL FIX, not just docs):
- The three forked audit skills (claude-md-drift-audit, link-check,
dependency-rescan) were registered in plugin.json but never copied
by the direct-install path. Both installers now iterate over them
after the karpathy-guidelines block, mirroring the same backup +
nested-duplicate-cleanup pattern. Banner section and uninstall
instructions list all 5 skills.
Verified:
- All 5 CLAUDE.md files in this repo still <= 150 lines after edits.
- install.sh passes bash -n syntax check.
- Plugin manifest still resolves all 8 referenced paths on disk.
- README invariants present: 2.1.0, --weekly, hooks/hooks.json,
both source-repo attributions, three audit skill names.
- Stale-claim sweep: zero "20-300" / ">300" / "exceeds 300" refs
remain in docs/ or examples/.
11 KiB
Troubleshooting Guide
Common issues and solutions for ClaudeForge.
Installation Issues
Issue: Command not recognized after installation
Symptoms:
/enhance-claude-mdshows "command not found"- Slash command doesn't autocomplete
Causes:
- Claude Code hasn't reloaded components
- Incorrect installation path
- Insufficient permissions
Solutions:
-
Restart Claude Code completely:
# Quit Claude Code entirely (not just close window) # Reopen Claude Code # Wait 5-10 seconds for components to load -
Verify installation paths:
# macOS/Linux ls -la ~/.claude/commands/enhance-claude-md.md ~/.claude/commands/sync-claude-md.md ls -la ~/.claude/skills/claudeforge-skill/ ls -la ~/.claude/agents/claude-md-guardian.md # Windows dir %USERPROFILE%\.claude\commands\enhance-claude-md\ dir %USERPROFILE%\.claude\skills\claudeforge-skill\ dir %USERPROFILE%\.claude\agents\claude-md-guardian.md -
Reinstall with correct permissions:
chmod +x install.sh # macOS/Linux ./install.sh
Issue: "Skill not found" error
Symptoms:
- Error message: "claude-md-enhancer skill not found"
- Slash command runs but fails
Cause: Skill directory name mismatch or missing skill files
Solutions:
-
Check skill directory name (must be exact):
ls ~/.claude/skills/ # Must show: claudeforge-skill -
Verify skill files exist:
ls ~/.claude/skills/claudeforge-skill/ # Must contain: SKILL.md, analyzer.py, generator.py, etc. -
Reinstall skill only:
rm -rf ~/.claude/skills/claudeforge-skill cp -r skill ~/.claude/skills/claudeforge-skill
Issue: Windows PowerShell execution policy error
Symptoms:
- Error: "execution of scripts is disabled on this system"
Cause: PowerShell security settings
Solution:
# Run PowerShell as Administrator
Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
.\install.ps1
Usage Issues
Issue: Quality score unexpectedly low
Symptoms:
- Quality score < 50
- Many "missing section" warnings
Causes:
- Basic CLAUDE.md without native format sections
- File too short (< 20 lines) or too long (> 400 lines)
- Missing required sections
Solutions:
-
Let ClaudeForge add missing sections:
/enhance-claude-md # Claude will identify missing sections # Confirm enhancement # Quality score will improve -
Check file length:
wc -l CLAUDE.md # Hard cap: 150 lines. Sweet spot: 50-120. # If > 300: Consider modular architecture -
Manually add required sections:
- Core Principles
- Tech Stack
- Workflow Instructions
- Project Structure (ASCII diagram)
- Setup & Installation
Issue: Generated content too generic
Symptoms:
- CLAUDE.md doesn't mention specific tech stack
- No project-specific guidelines
- Feels like template without customization
Causes:
- Project detection failed (no package.json, requirements.txt, etc.)
- Insufficient project context
Solutions:
-
Provide explicit context:
/enhance-claude-md # When Claude asks, specify: "This is a Python FastAPI microservice with PostgreSQL, Redis, and Docker. Team of 8 developers, MVP phase." -
Add project files before running:
# Ensure detection files exist: touch package.json # Node.js touch requirements.txt # Python touch go.mod # Go touch Cargo.toml # Rust -
Manual customization after generation:
- Edit generated CLAUDE.md
- Add project-specific conventions
- Include team standards
Issue: Modular architecture not recommended
Symptoms:
- Single CLAUDE.md generated for large project
- File exceeds the 150-line cap (validator hook will surface this)
Causes:
- Project type not detected as
fullstack - Team size estimated as
small
Solutions:
-
Explicitly request modular:
/enhance-claude-md # Tell Claude: "Use modular architecture with separate files for backend, frontend, and database" -
Create backend/ and frontend/ directories:
mkdir -p backend frontend # Then run /enhance-claude-md -
Manual split if needed:
# Create context files manually: touch backend/CLAUDE.md touch frontend/CLAUDE.md # Then run enhancement on each: cd backend && /enhance-claude-md cd frontend && /enhance-claude-md
Issue: Guardian agent not updating automatically
Symptoms:
- Made significant changes
- Started new session
- CLAUDE.md not updated
Causes:
- Agent not installed
- Changes below significance threshold
- Git repository not initialized
Solutions:
-
Verify agent installation:
ls ~/.claude/agents/claude-md-guardian.md -
Check git repository:
git status # Agent requires git for change detection -
Manually invoke agent:
# In Claude Code: Claude, invoke claude-md-guardian to update CLAUDE.md -
Lower significance threshold (if needed): Edit
agent/claude-md-guardian.md:# Change from 5 to 3 files minimum - Less than 5 files modified # Change to 3
Output Issues
Issue: CLAUDE.md missing Project Structure diagram
Symptoms:
- No ASCII tree diagram in output
- Native format incomplete
Cause: Template generation skipped structure section
Solution:
-
Regenerate with explicit request:
/enhance-claude-md # Tell Claude: "Add Project Structure section with ASCII tree diagram" -
Manual addition:
## Project Structureproject/ ├── src/ │ ├── components/ │ └── services/ └── tests/
Issue: Setup & Installation section generic
Symptoms:
- Says "npm install" for Python project
- Incorrect commands
Cause: Tech stack detection mismatch
Solution:
-
Verify tech stack detection:
# Check project files: ls package.json requirements.txt go.mod -
Regenerate with correct context:
/enhance-claude-md "This is a Python project, not Node.js" -
Manual fix: Edit CLAUDE.md and correct commands
Performance Issues
Issue: Guardian agent too slow
Symptoms:
- Agent takes > 30 seconds
- Multiple updates in single session
Causes:
- Model set to sonnet instead of haiku
- Full regeneration instead of targeted update
Solutions:
-
Verify agent model:
grep "model:" ~/.claude/agents/claude-md-guardian.md # Should be: model: haiku -
Check agent workflow:
- Should use targeted section updates
- Not full file regeneration
Issue: Slash command timeout
Symptoms:
- Command starts but never completes
- "Timeout" error
Causes:
- Large repository exploration
- Network issues (if fetching remote content)
Solutions:
-
Run in smaller scope:
cd specific-directory /enhance-claude-md -
Skip exploration, provide context directly:
/enhance-claude-md "Skip exploration. Create CLAUDE.md for TypeScript React app with PostgreSQL."
Integration Issues
Issue: Git commands fail in agent
Symptoms:
- Agent error: "git: command not found"
- Agent can't detect changes
Cause: Git not installed or not in PATH
Solutions:
-
Install git:
# macOS brew install git # Ubuntu/Debian sudo apt-get install git # Windows # Download from git-scm.com -
Verify git installation:
git --version # Should show: git version 2.x
Issue: Quality hooks not working
Symptoms:
- Pre-commit hook doesn't run
- No validation before commit
Causes:
- Hook not executable
- Git not configured to use hooks
- Wrong hooks directory
Solutions:
-
Make hook executable:
chmod +x .claude/hooks/pre-commit.sh -
Configure git:
git config core.hooksPath .claude/hooks -
Test hook manually:
./.claude/hooks/pre-commit.sh # Should validate CLAUDE.md
Validation Errors
Issue: "File length exceeds recommended maximum"
Symptoms:
- Validation warning: File > 300 lines
- Quality score penalty
Cause: Single file too large
Solution:
-
Split into modular architecture:
/enhance-claude-md "Convert to modular architecture with separate backend and frontend files" -
Remove unnecessary content:
- Delete redundant sections
- Move detailed examples to separate docs
- Link to external documentation
Issue: "Missing required sections"
Symptoms:
- Validation fails
- Lists missing: Core Principles, Tech Stack, etc.
Solution:
-
Let ClaudeForge add them:
/enhance-claude-md # Claude will identify and add missing sections -
Manual addition: Add required sections following native format
Common Error Messages
"CLAUDE.md not found"
Meaning: File doesn't exist (expected for new projects)
Action: Continue with initialization workflow
"Quality score: 0/100"
Meaning: Empty or invalid file
Action: Regenerate completely
"Invalid project structure"
Meaning: Cannot detect project type
Action: Add project files (package.json, etc.) or provide context manually
"Template selection failed"
Meaning: No matching template for project
Action: Provide more specific project context
Getting Help
If your issue isn't covered here:
-
Check GitHub Issues: https://github.com/alirezarezvani/ClaudeForge/issues
-
Search Discussions: https://github.com/alirezarezvani/ClaudeForge/discussions
-
Open New Issue:
- Describe the problem
- Include steps to reproduce
- Attach relevant logs or errors
- Mention your OS and Claude Code version
-
Review Documentation:
Debug Mode
To get more detailed output:
# Run installer with verbose output:
bash -x install.sh
# Check Claude Code logs:
# macOS: ~/Library/Logs/Claude Code/
# Linux: ~/.config/claude-code/logs/
# Windows: %APPDATA%\Claude Code\logs\
Still having issues? We're here to help!
Open an issue: https://github.com/alirezarezvani/ClaudeForge/issues/new