RE-cue VS Code Extension
VS Code extension for in-editor reverse engineering analysis using RE-cue.
⚠️ Important: Dependencies
The VS Code extension requires the RE-cue Python package to be installed. The extension provides IDE integration features (hover, CodeLens, tree views, navigation) but relies on the Python CLI for code analysis.
Installation Requirements
- Python 3.6+ must be installed and accessible
- RE-cue Python Package must be installed:
cd reverse-engineer-python
pip install -e .
- Verify installation:
python3 -c "import reverse_engineer; print('RE-cue installed')"
Without the Python package, the extension cannot perform analysis. See Installation section below for complete setup instructions.
Features
- Analyze File: Right-click any supported file to analyze it
- Analyze Folder: Right-click any folder to analyze its contents
- Works from Explorer view and Editor title bar
📊 Side Panel Results
View analysis results in a dedicated sidebar with organized views:
- Analysis Results: Overview of discovered components
- Use Cases: Extracted use cases with actors and scenarios
- Actors: Discovered system actors (human, system, external)
- System Boundaries: Detected architectural boundaries
- API Endpoints: Discovered REST endpoints with methods
🔗 Navigate to Definitions
- Click items in tree views to navigate to source
- Document links for cross-references
- Navigate from use case to related code
📝 Inline Documentation Preview
- Hover Information: Hover over endpoints, models, services to see details
- CodeLens: See use case references directly in code
- Tooltips: Rich markdown tooltips with full context
🔄 Auto-Update on Save
- Enable auto-analysis when files are saved
- Configurable in settings
- Keeps documentation in sync with code changes
Installation
Prerequisites
- Python 3.6+ installed
- RE-cue Python package installed:
pip install -e reverse-engineer-python/
From Source
- Clone the repository
- Navigate to
vscode-extension/
- Run
npm install
- Run
npm run compile
- Press F5 to launch Extension Development Host
From VSIX
- Download the
.vsix file
- Run:
code --install-extension re-cue-x.x.x.vsix
Usage
Analyze a File
- Open a supported file (Java, Python, TypeScript, JavaScript, Ruby, C#)
- Right-click in the editor or file explorer
- Select "RE-cue: Analyze File"
Analyze a Folder
- Right-click on a folder in the Explorer
- Select "RE-cue: Analyze Folder"
Analyze Workspace
- Open Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
- Type "RE-cue: Analyze Workspace"
- Press Enter
Generate Documentation
Use the Command Palette to generate specific documentation:
RE-cue: Generate SpecificationRE-cue: Generate Implementation PlanRE-cue: Generate Use CasesRE-cue: Generate Data ModelRE-cue: Generate API ContractRE-cue: Generate DiagramsRE-cue: Generate All Documentation
Quick Actions
- Click the RE-cue status bar item
- Or use
RE-cue: Quick Actions command
- Select from available actions
Configuration
Access settings via File > Preferences > Settings > Extensions > RE-cue or use the RE-cue: Open Settings command.
| Setting |
Default |
Description |
recue.pythonPath |
python3 |
Path to Python executable |
recue.autoAnalyzeOnSave |
false |
Auto-analyze on file save |
recue.outputDirectory |
"" |
Custom output directory |
recue.defaultFramework |
auto |
Default framework for analysis |
recue.enableDiagnostics |
true |
Show analysis issues as diagnostics |
recue.enableHover |
true |
Show inline documentation on hover |
recue.enableCodeLens |
true |
Show use case references as CodeLens |
recue.verboseOutput |
false |
Enable verbose output |
recue.enableCache |
true |
Enable analysis caching |
recue.enableParallelProcessing |
true |
Enable parallel processing |
Supported Languages
- Java (Spring Boot)
- Python (Django, Flask, FastAPI)
- TypeScript/JavaScript (Express, NestJS)
- Ruby (Rails)
- C# (ASP.NET Core)
Commands
| Command |
Description |
recue.analyzeFile |
Analyze current file |
recue.analyzeFolder |
Analyze selected folder |
recue.analyzeWorkspace |
Analyze entire workspace |
recue.generateSpec |
Generate specification |
recue.generatePlan |
Generate implementation plan |
recue.generateUseCases |
Generate use cases |
recue.generateDataModel |
Generate data model |
recue.generateApiContract |
Generate API contract |
recue.generateDiagrams |
Generate diagrams |
recue.generateAll |
Generate all documentation |
recue.refreshResults |
Refresh analysis results |
recue.clearResults |
Clear all results |
recue.openSettings |
Open extension settings |
recue.showQuickPick |
Show quick actions |
Output
Generated documentation is saved to re-<project-name>/ directory in your project:
your-project/
└── re-your-project/
├── spec.md # Feature specification
├── plan.md # Implementation plan
├── data-model.md # Data model documentation
├── diagrams.md # Visual diagrams (Mermaid)
├── phase1-structure.md # Project structure analysis
├── phase2-actors.md # Actor discovery
├── phase3-boundaries.md # System boundaries
├── phase4-use-cases.md # Use case analysis
└── contracts/
└── api-spec.json # OpenAPI specification
Troubleshooting
Python not found
Set the correct Python path in settings:
{
"recue.pythonPath": "/usr/local/bin/python3"
}
RE-cue module not found
Install the RE-cue Python package:
pip install -e /path/to/re-cue/reverse-engineer-python/
No results showing
- Ensure the project is supported (has recognizable framework)
- Check Output panel (View > Output > RE-cue) for errors
- Try analyzing with verbose output enabled
Analysis is slow
- Enable caching in settings
- Enable parallel processing
- For large codebases, use incremental analysis
Development
Build
cd vscode-extension
npm install
npm run compile
Watch Mode
npm run watch
Package
npm run package
Test
npm run test
Contributing
Contributions are welcome! Please see the main CONTRIBUTING.md for guidelines.
License
MIT License - see LICENSE for details.
