Skip to content

Commit ac48628

Browse files
semsem
authored andcommitted
docs: Update README for v3.1.3 - document analyze command
1 parent 49b8ec2 commit ac48628

File tree

2 files changed

+61
-1
lines changed

2 files changed

+61
-1
lines changed

README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ Need help understanding how each IDE uses its configuration? Check out our detai
9494
- 📁 **Structured Output** - Organized documentation following each IDE's conventions
9595
-**Fast Setup** - Go from zero to AI-ready project in minutes
9696
- 🔄 **Format Conversion** - Convert between different IDE formats (coming soon)
97+
- 🔧 **Retrofit Existing Projects** - NEW: Analyze and upgrade existing codebases with AI documentation
9798

9899
### Advanced Features
99100

@@ -168,6 +169,9 @@ context-forge init --config ./context-forge.json
168169

169170
# Run validation on existing project
170171
context-forge validate
172+
173+
# NEW: Retrofit existing projects with AI-optimized documentation
174+
context-forge analyze
171175
```
172176

173177
## 💡 Usage Examples
@@ -346,6 +350,62 @@ npx context-forge init --preset hackathon
346350
# CLAUDE.md has simplified rules for rapid development
347351
```
348352

353+
## 🔧 Retrofitting Existing Projects
354+
355+
**NEW in v3.1.3**: The `analyze` command allows you to retrofit existing codebases with AI-optimized documentation. This is perfect for:
356+
357+
- Adding AI assistance to legacy projects
358+
- Upgrading existing projects with modern context engineering
359+
- Planning new features for established codebases
360+
- Generating PRPs for upcoming development work
361+
362+
### How it Works
363+
364+
1. **Smart Analysis**: Automatically detects your tech stack, project structure, and existing documentation
365+
2. **Interactive Setup**: Asks about your future development plans
366+
3. **Non-Destructive**: Never overwrites existing files (appends to CLAUDE.md with clear markers)
367+
4. **Feature PRPs**: Generates individual PRP files for each planned feature
368+
5. **Comprehensive Summary**: Creates a detailed retrofit summary with file tree visualization
369+
370+
### Usage
371+
372+
```bash
373+
# Run in your existing project directory
374+
cd /path/to/your/project
375+
context-forge analyze
376+
377+
# Specify output directory
378+
context-forge analyze --output ./ai-docs
379+
380+
# Target specific IDEs
381+
context-forge analyze --ide claude,cursor
382+
383+
# Skip AI analysis for faster setup
384+
context-forge analyze --no-ai
385+
```
386+
387+
### Example Output
388+
389+
```
390+
📁 Generated Files:
391+
├── CLAUDE.md (UPDATED - appended retrofit section)
392+
├── Docs/
393+
│ ├── Implementation.md
394+
│ ├── project_structure.md
395+
│ ├── UI_UX_doc.md
396+
│ └── Bug_tracking.md
397+
└── PRPs/
398+
├── user-authentication-prp.md
399+
├── payment-integration-prp.md
400+
└── api-v2-prp.md
401+
```
402+
403+
The analyze command is intelligent enough to:
404+
- Detect if you're using TypeScript, Python, or other languages
405+
- Identify frameworks like React, Next.js, Express, FastAPI
406+
- Find existing documentation to use as context
407+
- Ask about your future plans to generate relevant PRPs
408+
349409
## 📚 Documentation
350410

351411
### Generated Files Structure

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "context-forge",
3-
"version": "3.1.2",
3+
"version": "3.1.3",
44
"description": "Universal AI IDE configuration generator - Optimized setups for Claude Code, Cursor, Windsurf, Cline, Copilot, Gemini, and more",
55
"main": "dist/index.js",
66
"bin": {

0 commit comments

Comments
 (0)