Omen - AI Context Index Generator
Automatically generate comprehensive project documentation for AI assistants like Cursor, GitHub Copilot, and Claude.
Features
- 🔍 Smart Code Parsing - Extract functions, classes, and documentation
- 🌐 API Endpoint Detection - Auto-discover REST routes with auth markers
- 🗄️ Database Schema Export - Generate table structures with relationships
- 🔄 Auto-Refresh - Update index on file changes (configurable debounce)
- 🎯 25+ Frameworks - TypeScript, Python, React, Flask, Django, NestJS & more
Quick Start
- Install the extension
- Press
Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (Mac)
- Type:
Omen: Generate Context Index
- Find your index at
.omen-context/omen-index.md
Supported Technologies
Languages (2)
- TypeScript/JavaScript -
.ts, .tsx, .js, .jsx
- Python -
.py with docstrings and SQLAlchemy
Backend (8)
Flask • Django • FastAPI • Express • NestJS • Next.js API • Koa • tRPC
Frontend (6)
React • Next.js • Vue • Angular • Svelte • Solid.js
Database/ORM (7)
SQLAlchemy • Django ORM • TypeORM • Prisma • Mongoose • Sequelize • Drizzle
Additional (4)
GraphQL • JWT Auth • Redis • Bcrypt
Output Example
## 🛠️ Tech Stack
**Backend**: Flask, FastAPI
**Frontend**: React, Next.js
**Database/ORM**: SQLAlchemy, Prisma
## 🌐 API Endpoints
| Method | Path | Handler | Auth | File |
| `GET` | `/api/users` | `list_users()` | 🔒 | routes.py:15 |
| `POST` | `/api/users` | `create_user()` | 🔒 | routes.py:35 |
## 🗄️ Database Schema
### `User` Table
| Column | Type | Constraints |
| `id` | Integer | PRIMARY KEY |
| `email` | String | NOT NULL |
Configuration
{
"omen.outputPath": ".omen-code-index",
"omen.outputFormat": "markdown",
"omen.autoRefresh": true,
"omen.debounceDelay": 3000
}
Commands
Omen: Generate Context Index - Create new index
Omen: Refresh Context Index - Update existing index
Omen: Open Context Index - Open generated file
Why Omen?
AI assistants work better with context. Omen gives them a structured understanding of your:
- Project architecture - Files, functions, classes
- API structure - All endpoints with authentication
- Database design - Tables, columns, relationships
- Tech stack - Frameworks and libraries used
Perfect for teams using Cursor, GitHub Copilot, Claude, or any AI coding assistant.
Support
License
Apache-2.0 License - See LICENSE
Made by Vivek Ingle