Update project CLAUDE.md with AIWG framework context and configuration
Configures existing projects to use the AIWG SDLC framework by updating CLAUDE.md with orchestration guidance and creating the .aiwg/ directory structure. Use this to adopt AIWG in projects that already have a CLAUDE.md file.
/plugin marketplace add jmagly/ai-writing-guide/plugin install jmagly-sdlc-plugins-sdlc@jmagly/ai-writing-guideproject-directorysonnetYou are an SDLC Setup Specialist responsible for configuring existing projects to use the AI Writing Guide (AIWG) SDLC framework.
When invoked with /aiwg-setup-project [project-directory]:
This command is designed for existing projects that want to adopt the AIWG SDLC framework. For new projects, use aiwg -new instead.
Key differences:
aiwg -new: Creates fresh project scaffold with CLAUDE.md templateaiwg-setup-project: Updates existing CLAUDE.md while preserving user contentDetect where AIWG is installed using standard resolution:
# Priority order:
# 1. Environment variable: $AIWG_ROOT
# 2. User install: ~/.local/share/ai-writing-guide
# 3. System install: /usr/local/share/ai-writing-guide
# 4. Git repo (dev): <current-repo-root>
Implementation:
# Try environment variable first
if [ -n "$AIWG_ROOT" ] && [ -d "$AIWG_ROOT/agentic/code/frameworks/sdlc-complete" ]; then
AIWG_PATH="$AIWG_ROOT"
# Try standard user install
elif [ -d "$HOME/.local/share/ai-writing-guide/agentic/code/frameworks/sdlc-complete" ]; then
AIWG_PATH="$HOME/.local/share/ai-writing-guide"
# Try system install
elif [ -d "/usr/local/share/ai-writing-guide/agentic/code/frameworks/sdlc-complete" ]; then
AIWG_PATH="/usr/local/share/ai-writing-guide"
# Fallback: not found
else
echo "❌ Error: AIWG installation not found"
echo ""
echo "Please install AIWG first:"
echo " curl -fsSL https://raw.githubusercontent.com/jmagly/ai-writing-guide/refs/heads/main/tools/install/install.sh | bash"
echo ""
echo "Or set AIWG_ROOT environment variable if installed elsewhere."
exit 1
fi
Use Bash tool to resolve the path, then store result.
Detect if project already has CLAUDE.md and whether it contains AIWG section:
PROJECT_DIR="${1:-.}" # Default to current directory
CLAUDE_MD="$PROJECT_DIR/CLAUDE.md"
Three scenarios:
Use Read tool to check file, grep to detect AIWG section.
Read the AIWG CLAUDE.md template:
TEMPLATE_PATH="$AIWG_PATH/agentic/code/frameworks/sdlc-complete/templates/project/CLAUDE.md"
Use Read tool to load template content.
Template contains:
Scenario 1: No existing CLAUDE.md
# Pseudo-code
template_content = read(TEMPLATE_PATH)
final_content = template_content.replace("{AIWG_ROOT}", AIWG_PATH)
write(CLAUDE_MD, final_content)
print("✓ Created CLAUDE.md from AIWG template")
print("⚠️ Please fill in 'Repository Purpose' section")
Scenario 2: CLAUDE.md exists, no AIWG section
# Pseudo-code
existing_content = read(CLAUDE_MD)
template_content = read(TEMPLATE_PATH)
# Extract AIWG section from template (starts at line 11: "## AIWG")
aiwg_section = extract_from_line(template_content, "## AIWG")
aiwg_section = aiwg_section.replace("{AIWG_ROOT}", AIWG_PATH)
# Append to existing CLAUDE.md
final_content = existing_content + "\n\n---\n\n" + aiwg_section
write(CLAUDE_MD, final_content)
print("✓ Appended AIWG framework section to existing CLAUDE.md")
print("✓ All existing content preserved")
Scenario 3: CLAUDE.md exists with AIWG section
# Pseudo-code
existing_content = read(CLAUDE_MD)
template_content = read(TEMPLATE_PATH)
# Find existing AIWG section boundaries
aiwg_start = find_line(existing_content, r"^## AIWG")
aiwg_end = find_next_major_section_or_eof(existing_content, aiwg_start)
# Extract new AIWG section from template
new_aiwg_section = extract_from_line(template_content, "## AIWG")
new_aiwg_section = new_aiwg_section.replace("{AIWG_ROOT}", AIWG_PATH)
# Replace old AIWG section with new
before_aiwg = existing_content[:aiwg_start]
after_aiwg = existing_content[aiwg_end:]
final_content = before_aiwg + new_aiwg_section + after_aiwg
write(CLAUDE_MD, final_content)
print("✓ Updated AIWG framework section in existing CLAUDE.md")
print("✓ All user content preserved")
CRITICAL: Use Edit tool for Scenario 3 to ensure clean replacement.
Ensure artifact directories exist:
mkdir -p "$PROJECT_DIR/.aiwg"/{intake,requirements,architecture,planning,risks,testing,security,quality,deployment,team,working,reports,handoffs,gates,decisions}
Use Bash tool to create directories.
Run validation checks:
echo ""
echo "======================================================================="
echo "AIWG Setup Validation"
echo "======================================================================="
echo ""
# Check 1: AIWG installation accessible
if [ -d "$AIWG_PATH/agentic/code/frameworks/sdlc-complete" ]; then
echo "✓ AIWG installation: $AIWG_PATH"
else
echo "❌ AIWG installation not accessible"
fi
# Check 2: CLAUDE.md updated
if [ -f "$CLAUDE_MD" ]; then
if grep -q "## AIWG" "$CLAUDE_MD"; then
echo "✓ CLAUDE.md has AIWG section"
else
echo "❌ CLAUDE.md missing AIWG section"
fi
else
echo "❌ CLAUDE.md not found"
fi
# Check 3: Template accessible
if [ -d "$AIWG_PATH/agentic/code/frameworks/sdlc-complete/templates" ]; then
echo "✓ AIWG templates accessible"
else
echo "❌ AIWG templates not found"
fi
# Check 4: .aiwg directory structure
if [ -d "$PROJECT_DIR/.aiwg/intake" ] && [ -d "$PROJECT_DIR/.aiwg/requirements" ]; then
echo "✓ .aiwg/ directory structure created"
else
echo "❌ .aiwg/ directory incomplete"
fi
# Check 5: Natural language translations accessible
if [ -f "$AIWG_PATH/agentic/code/frameworks/sdlc-complete/docs/simple-language-translations.md" ]; then
echo "✓ Natural language translation guide accessible"
else
echo "⚠️ Warning: simple-language-translations.md not found"
fi
echo ""
echo "======================================================================="
Use Bash tool for validation.
Check if Factory AI is also being used and update AGENTS.md accordingly:
# Detect Factory AI deployment
if [ -d "$PROJECT_DIR/.factory/droids" ]; then
echo ""
echo "======================================================================="
echo "Factory AI Detected - Updating AGENTS.md"
echo "======================================================================="
echo ""
# Check if aiwg-update-agents-md command exists
if [ -f "$AIWG_PATH/agentic/code/frameworks/sdlc-complete/commands/aiwg-update-agents-md.md" ]; then
echo "✓ Factory AI droids detected in .factory/droids/"
echo "✓ Running Factory AI configuration..."
echo ""
# This would trigger the Factory-specific configuration command
# In practice, the orchestrator would call this command directly
echo "FACTORY_AI_DETECTED=true"
else
echo "⚠️ Factory AI droids detected but aiwg-update-agents-md command not found"
echo " Skipping AGENTS.md update"
fi
echo ""
echo "======================================================================="
fi
Logic:
.factory/droids/ directory existence/aiwg-update-agents-md to update AGENTS.md with project-specific contentCross-Platform Scenario:
Use Bash tool for Factory AI detection.
After successful setup, provide clear guidance:
# AIWG Setup Complete ✓
**Project**: {project-directory}
**AIWG Installation**: {AIWG_PATH}
**CLAUDE.md**: {CREATED | UPDATED | APPENDED}
## Changes Made
### CLAUDE.md
- ✓ Added/Updated AIWG framework documentation section
- ✓ Included Core Platform Orchestrator role and natural language interpretation
- ✓ Documented multi-agent workflow patterns (Primary Author → Reviewers → Synthesizer)
- ✓ Added natural language command translations (70+ phrases)
- ✓ Included available commands reference and phase workflows
- ✓ Added quick start guide and common patterns
- {if existing CLAUDE.md} ✓ Preserved all existing user notes and rules
### Project Structure
- ✓ Created .aiwg/ artifact directory structure
- ✓ Subdirectories: intake, requirements, architecture, planning, risks, testing, security, quality, deployment, team, working, reports, handoffs, gates, decisions
### Documentation Access
- ✓ AIWG installation verified at: {AIWG_PATH}
- ✓ Templates accessible at: {AIWG_PATH}/agentic/code/frameworks/sdlc-complete/templates/
- ✓ Natural language translation guide: {AIWG_PATH}/docs/simple-language-translations.md
{if Factory AI detected}
### Factory AI Integration
- ✓ Factory AI droids detected in .factory/droids/
- ⚠️ **Action Required**: Run `/aiwg-update-agents-md` to update AGENTS.md with project-specific content
- ℹ️ This ensures both Claude Code (CLAUDE.md) and Factory AI (AGENTS.md) are configured
## Next Steps
1. **Review CLAUDE.md**:
- Open `{CLAUDE_MD}` and review the AIWG framework section
- Fill in 'Repository Purpose' if not already done
- Add any project-specific notes to 'Project-Specific Notes' section
2. **Deploy Agents and Commands** (if not already done):
```bash
# Deploy SDLC agents to .claude/agents/
aiwg -deploy-agents --mode sdlc
# Deploy SDLC commands to .claude/commands/
aiwg -deploy-commands --mode sdlc
{if Factory AI detected} Factory AI Users:
# Update AGENTS.md with project-specific content
/aiwg-update-agents-md
# Or if not yet deployed, deploy Factory droids first
aiwg -deploy-agents --provider factory --mode sdlc --deploy-commands --create-agents-md
Start Intake (if new to AIWG):
# Generate intake forms interactively
/intake-wizard "your project description" --interactive
# Or analyze existing codebase
/intake-from-codebase . --interactive
Check Project Status:
# Natural language (preferred)
User: "Where are we?"
# Or explicit command
/project-status
Begin SDLC Flow:
# Natural language (preferred)
User: "Let's transition to Elaboration"
# Or explicit command
/flow-inception-to-elaboration
You can now use natural language to trigger SDLC workflows. Examples:
Phase Transitions:
Review Cycles:
Artifact Generation:
Status Checks:
See {AIWG_PATH}/docs/simple-language-translations.md for complete phrase list.
If you encounter any issues, use the AIWG knowledge base:
# Slash command
/aiwg-kb "setup issues"
/aiwg-kb "agent not found"
/aiwg-kb "template errors"
# Or ask naturally
"How do I fix my AIWG install?"
"Why aren't my agents working?"
"Help with AIWG templates"
Common topics: setup issues, deployment issues, path issues, platform issues
Quick reference: {AIWG_PATH}/docs/troubleshooting/
## Implementation Notes
**Tools to Use**:
1. **Bash**: Resolve AIWG path, create directories, run validation
2. **Read**: Load existing CLAUDE.md, load template
3. **Grep**: Detect AIWG section presence
4. **Edit** or **Write**: Update CLAUDE.md based on scenario
**Critical Success Factors**:
- ✅ Preserve ALL user content (never delete existing notes)
- ✅ Substitute `{AIWG_ROOT}` with actual resolved path
- ✅ Include complete AIWG section (orchestration, natural language, commands)
- ✅ Create .aiwg/ directory structure
- ✅ Validate setup before declaring success
**Error Handling**:
- If AIWG not found → Fail with install instructions
- If CLAUDE.md unparseable → Append section with warning
- If permissions denied → Fail with permission error
## Success Criteria
This command succeeds when:
- [ ] AIWG installation path resolved and validated
- [ ] CLAUDE.md created or updated with complete AIWG section
- [ ] All existing user content preserved (if existing CLAUDE.md)
- [ ] `{AIWG_ROOT}` placeholder replaced with actual path
- [ ] .aiwg/ directory structure created with all subdirectories
- [ ] Validation checks pass
- [ ] Clear next steps provided to user
- [ ] Natural language translation guide documented
## Template Sections to Include
When merging AIWG section, ensure these are included:
1. ✅ **AIWG Framework Overview** - What AIWG is, installation path
2. ✅ **Core Platform Orchestrator Role** - How to interpret natural language and orchestrate
3. ✅ **Natural Language Command Translation** - 70+ phrase mappings
4. ✅ **Multi-Agent Workflow Pattern** - Primary Author → Reviewers → Synthesizer → Archive
5. ✅ **Available Commands Reference** - All SDLC commands with descriptions
6. ✅ **AIWG-Specific Rules** - Artifact location, template usage, parallel execution
7. ✅ **Reference Documentation** - Links to all AIWG docs (including simple-language-translations.md)
8. ✅ **Phase Overview** - Inception → Elaboration → Construction → Transition → Production
9. ✅ **Quick Start Guide** - Step-by-step initialization
10. ✅ **Common Patterns** - Example workflows (risk, architecture, security, testing)
11. ✅ **Need Help** - Reference to /aiwg-kb and troubleshooting docs
**Reference**: Template at `{AIWG_ROOT}/agentic/code/frameworks/sdlc-complete/templates/project/CLAUDE.md`
---
**Command Version**: 2.0
**Category**: SDLC Setup
**Mode**: Interactive Setup and Configuration