Regenerate WARP.md
Regenerate the WARP.md file for Warp Terminal integration, analyzing current project state while preserving team directives and organizational requirements.
Hook file approach (default): Generates AIWG-warp.md and adds a section or @AIWG-warp.md directive to WARP.md. Note: Warp's @-link support is unverified — defaults to section-style toggle until confirmed (see #444).
Full inject (--full-inject): Embeds AIWG content inline in WARP.md with AIWG markers.
Parameters
| Flag | Description |
|---|---|
--no-backup |
Skip creating backup file |
--dry-run |
Preview changes without writing |
--show-preserved |
List all detected preserved content and exit |
--full |
Full regeneration, preserve nothing (destructive) |
Warp Terminal Conventions
WARP.md follows Warp Terminal formatting conventions:
###headings for agents and commands (not##)- Inline tool lists with agents
- Terminal-friendly command formatting (easy copy-paste)
- Concise descriptions optimized for terminal display
Execution Steps
Step 1: Create Backup
Unless --no-backup specified:
- Check if
WARP.mdexists - If exists, copy to
WARP.md.backup-{YYYYMMDD-HHMMSS} - Report backup location
Step 2: Extract Preserved Content
Same preservation patterns as CLAUDE.md:
- Explicit Preserve Blocks:
<!-- PRESERVE -->...<!-- /PRESERVE --> - Preserved Section Headings: Team *, Org *, Definition of Done, etc.
- Inline Directives: Lines with directive keywords
Step 3: Analyze Project
Same project analysis as CLAUDE.md:
- Languages and package managers
- Development commands
- Test framework
- CI/CD configuration
- Directory structure
Step 4: Detect AIWG State
Check installed frameworks and deployed assets:
- Scan for WARP-specific formatting in existing files
- Count agents and commands
- Identify active frameworks
Step 5: Generate WARP.md
Document Structure (Warp Format):
# WARP.md
Project guidance for Warp Terminal AI assistance.
## Project Overview
{Brief project description from README.md}
**Tech Stack**: {languages} | **Package Manager**: {npm/pip/etc} | **Test Framework**: {framework}
## Quick Commands
Copy-paste ready commands for common tasks:
```bash
# Install dependencies
{install command}
# Run development server
{dev command}
# Run tests
{test command}
# Build for production
{build command}
# Lint code
{lint command}
Project Structure
{directory tree with descriptions}
Team Directives
{ALL PRESERVED CONTENT}
Project Artifacts
{If .aiwg/ exists, list available project docs:}
| Category | Location |
|---|---|
| Requirements | @.aiwg/requirements/ |
| Architecture | @.aiwg/architecture/ |
| Planning | @.aiwg/planning/ |
{Only include rows for directories that exist}
AIWG Integration
Agents
{List deployed agents with brief descriptions}
Commands
{List deployed commands organized by category}
Natural Language
| You Say | Executes |
|---|---|
| "transition to elaboration" | flow-inception-to-elaboration |
| "run security review" | flow-security-review-cycle |
| "check status" | project-status |
Core References
| Topic | Reference |
|---|---|
| Orchestration | @~/.local/share/ai-writing-guide/agentic/code/addons/aiwg-utils/prompts/core/orchestrator.md |
| Agent Design | @~/.local/share/ai-writing-guide/agentic/code/addons/aiwg-utils/prompts/agents/design-rules.md |
| Error Recovery | @~/.local/share/ai-writing-guide/agentic/code/addons/aiwg-utils/prompts/reliability/resilience.md |
{If SDLC framework installed:}
SDLC References
| Topic | Reference |
|---|---|
| Natural Language | @~/.local/share/ai-writing-guide/agentic/code/frameworks/sdlc-complete/docs/simple-language-translations.md |
| Orchestration | @~/.local/share/ai-writing-guide/agentic/code/frameworks/sdlc-complete/docs/orchestrator-architecture.md |
### Step 6: Write Output
**If `--dry-run`:** Display content, do not write.
**Otherwise:**
1. Write to `WARP.md`
2. Report summary
WARP.md Regenerated
Backup: WARP.md.backup-20251206-153045
Preserved: 3 sections, 34 lines Regenerated: Project info, commands, AIWG integration
Output: WARP.md (312 lines)
## Warp-Specific Formatting Notes
### Agent Format
```markdown
### Agent Name
Brief description of what the agent does.
**Tools**: Tool1, Tool2, Tool3
Command Format
- `/command-name` - Brief description
Quick Commands
Formatted for easy terminal copy-paste:
# Description of command
actual_command --with-flags
Examples
# Regenerate WARP.md
/aiwg-regenerate-warp
# Preview changes
/aiwg-regenerate-warp --dry-run
# Check preserved content
/aiwg-regenerate-warp --show-preserved
# Full regeneration
/aiwg-regenerate-warp --full
Notes
- This command is Warp Terminal specific
- For Claude Code, use
/aiwg-regenerate-claude - For Factory AI, use
/aiwg-regenerate-factory - For auto-detection, use
/aiwg-regenerate
References
- @$AIWG_ROOT/agentic/code/addons/aiwg-utils/README.md — aiwg-utils addon overview
- @$AIWG_ROOT/agentic/code/addons/aiwg-utils/rules/native-ux-tools.md — Platform capability matrix including Warp Terminal
- @$AIWG_ROOT/docs/cli-reference.md — CLI reference for aiwg sync and regenerate commands
- @$AIWG_ROOT/agentic/code/frameworks/sdlc-complete/README.md — SDLC framework context referenced in generated WARP.md