OMGKIT - Omega-Level Development Kit

AI Team System for Claude Code
"Think Omega. Build Omega. Be Omega."
What is OMGKIT?
OMGKIT (Omega-Level Development Kit) transforms Claude Code into an autonomous AI development team. It provides a complete ecosystem of specialized AI agents, slash commands, skills, and workflows that work together to deliver 10x-1000x productivity improvements.
The Vision
Traditional AI assistants respond to prompts. OMGKIT creates an AI Team that:
- Plans like a senior architect
- Researches like a staff engineer
- Codes like a full-stack developer
- Reviews like a security expert
- Tests like a QA specialist
- Documents like a technical writer
- Ships like a DevOps engineer
All coordinated through Omega-level thinking - a framework for finding breakthrough solutions rather than incremental improvements.
Key Numbers
| Agents | 41 | Specialized AI team members with distinct roles |
| Commands | 174 | Slash commands for every development task |
| Workflows | 69 | Complete development processes from idea to deploy |
| Skills | 162 | Domain expertise modules across 24 categories |
| Modes | 10 | Behavioral configurations for different contexts |
| Themes | 30 | Curated design system themes (V2 schema with color scales) |
| Archetypes | 14 | Project templates for autonomous development |
Core Concepts
1. Optimized Alignment Principle (OAP)
OMGKIT uses a 5-level component hierarchy ensuring consistency and maintainability:
Level 0: MCPs (Foundation)
↓
Level 1: Commands → use MCPs
↓
Level 2: Skills → use Commands, MCPs
↓
Level 3: Agents → use Skills, Commands, MCPs
↓
Level 4: Workflows → use Agents, Skills, Commands, MCPs
Each level builds on lower levels, creating a coherent system where components work together seamlessly.
2. Omega Philosophy
Seven principles guide OMGKIT's approach to problem-solving:
| Leverage Multiplication | Build systems, not features |
| Transcendent Abstraction | Solve classes of problems, not instances |
| Agentic Decomposition | Orchestrate specialists |
| Feedback Acceleration | Compress learning loops |
| Zero-Marginal-Cost Scaling | Build once, scale infinitely |
| Emergent Intelligence | System greater than sum of parts |
| Aesthetic Perfection | Excellence in everything |
3. Sprint Management
OMGKIT brings agile methodology to AI-assisted development:
- Vision: Define what you're building and why
- Backlog: Prioritized list of work items
- Sprints: Time-boxed development cycles
- AI Team: Autonomous execution with human oversight
4. Reference-Aware Planning (New)
Use PRDs, specs, and design documents to inform sprint planning:
/sprint:sprint-new "Auth Sprint" --ref=.omgkit/artifacts/prd-auth.md
/sprint:sprint-new "Payment" --ref=artifacts/prd.md,specs/api.yaml
/sprint:sprint-new "MVP" --propose --ref=.omgkit/artifacts/
Configure in .omgkit/workflow.yaml:
references:
enabled: true
auto_suggest: true
max_tokens: 10000
extract_sections:
- requirements
- user_stories
- acceptance_criteria
References automatically propagate to /sprint:team-run and /sprint:backlog-add.
5. Testing Automation
OMGKIT includes a comprehensive testing automation system:
Auto-Generate Test Tasks
When you create a feature, OMGKIT automatically generates corresponding test tasks:
testing:
auto_generate_tasks: true
required_test_types:
- unit
- integration
Feature tasks automatically spawn test tasks based on feature type (API → Contract tests, UI → Snapshot tests, etc.)
Enforce Tests Before Done
No task can be marked "done" without passing tests:
testing:
enforcement:
level: standard
blocking:
on_test_failure: true
on_coverage_below_minimum: true
Coverage Gates
Set minimum and target coverage thresholds:
testing:
coverage_gates:
unit:
minimum: 80
target: 90
integration:
minimum: 60
target: 75
overall:
minimum: 75
target: 85
6. Design System
OMGKIT includes a complete design system with 30 curated V2 themes for shadcn/ui integration. All themes use the V2 schema with 12-step color scales, effects, and animations.
omgkit init --theme neo-tokyo
omgkit init --with-design
V2 Theme Features
All 30 themes include:
| 12-step color scales | --primary-1 through --primary-12 |
| Alpha variants | --primary-a1 through --primary-a12 |
| Status colors | --success, --warning, --info, --destructive |
| Effects | glassMorphism, glow, gradients |
| Animations | shimmer, pulse-glow, fade-in, slide-up |
| Backward compatibility | Includes flat colors block for legacy support |
5 Theme Categories
| Tech & AI | neo-tokyo, electric-cyan, neural-dark, matrix-green, quantum-purple, hologram | Futuristic, cyberpunk-inspired |
| Minimal & Clean | minimal-slate, paper, mono, zen, nordic, swiss | Simple, elegant, distraction-free |
| Corporate | ocean-blue, corporate-indigo, finance, legal, healthcare, consulting | Professional, trustworthy |
| Creative & Bold | coral-sunset, candy, neon, gradient-dream, retro, studio | Vibrant, expressive |
| Nature & Organic | forest, ocean, desert, lavender, arctic, autumn | Earth tones, calming |
Design Commands
/design:themes | List all 30 curated themes |
/design:theme <id> | Apply a theme to your project |
/design:preview | Preview current theme colors |
/design:builder | Build custom theme interactively |
/design:from-screenshot | Extract theme from image |
/design:from-url | Extract theme from webpage |
/design:add <comp> | Add shadcn/ui components |
/design:reset | Reset to original theme |
/design:rebuild <id> | Rebuild entire project with new theme |
/design:scan | Scan for non-compliant colors |
/design:rollback | Rollback to previous theme |
/design:export <format> | Export to CSS, SCSS, Tailwind, Figma, Style Dictionary |
/design:validate | Validate theme structure |
Theme Export
Export your theme to various design tools and framework formats:
/design:export css
/design:export figma --output ./tokens/
/design:export --all
Supported formats: css, scss, tailwind, figma, style-dictionary
Theme Rebuild
Rebuild your entire project's UI with a single command:
omgkit design:rebuild neo-tokyo
omgkit design:rebuild neo-tokyo --full
omgkit design:rebuild neo-tokyo --dry
omgkit design:scan
omgkit design:rollback
The rebuild feature:
- Backs up current theme before changes
- Standard mode: Scans
app/, components/, src/, pages/ directories
- Full mode (
--full): Scans ALL directories including tests/, lib/, utils/, hooks/
- Replaces hardcoded colors (
bg-blue-500) with theme variables (bg-primary)
- Full mode: 200+ extended color mappings with AI-driven inference
- Full mode: Safely updates test files (skips assertion strings)
- Generates 12-step color scales and status colors
Generated CSS Variables
--rose-1 through --rose-12
--rose-a1 through --rose-a12
--success, --warning, --info
--glass-blur, --glow
@keyframes shimmer { ... }
--animation-shimmer
How It Works
OMGKIT provides CSS variables that shadcn/ui components consume:
.omgkit/design/theme.json → Theme configuration (V2)
.omgkit/design/theme.css → CSS variables (:root + .dark)
After applying a theme, use npx shadcn@latest add button to add components that automatically use your theme colors.
Installation
Prerequisites
- Node.js 18+
- Claude Code CLI installed and authenticated
Install OMGKIT
npm install -g omgkit
omgkit install
cd your-project
omgkit init
Verify Installation
omgkit doctor
Quick Start
After installation, use these commands in Claude Code:
/vision:set
/sprint:new --propose
/team:run
/feature "add user authentication"
/fix "login not working"
/10x "improve performance"
Agents (41)
Agents are specialized AI team members, each with distinct expertise and responsibilities.
Core Development
planner | Task decomposition, implementation planning | Writing plans, task breakdown |
researcher | Technology research, best practices | Documentation analysis, comparisons |
debugger | Error analysis, root cause finding | RAPID methodology, log analysis |
tester | Test generation, coverage analysis | Framework-specific testing |
code-reviewer | Code review with security focus | OWASP checks, severity rating |
scout | Codebase exploration, file search | Pattern discovery, architecture mapping |
fullstack-developer | Full implementation | All development skills |
Operations
git-manager | Conventional commits, PR automation, branch management |
docs-manager | API docs, architecture guides, automated doc generation |
project-manager | Progress tracking, coordination, status reports |
database-admin | Schema design, query optimization, migrations |
ui-ux-designer | UI components, responsive design, accessibility |
observability-engineer | Monitoring, logging, tracing, alerting, SLOs |
Architecture & Platform
architect | System design, leverage multiplication, ADRs |
domain-decomposer | DDD, bounded contexts, service boundaries |
platform-engineer | Internal developer platforms, golden paths |
performance-engineer | Profiling, load testing, optimization |
Security
security-auditor | Security reviews, vulnerability assessment |
vulnerability-scanner | Security scanning, dependency audit |
devsecops | Security automation, SAST/DAST integration |
Data & ML
data-engineer | Data pipelines, ETL, schema design |
ml-engineer | ML pipelines, model training, MLOps |
ML Systems (New)
ml-engineer-agent | Full-stack ML engineering from data to deployment |
data-scientist-agent | Statistical modeling, experimentation, analysis |
research-scientist-agent | Novel algorithms, paper implementation, experiments |
model-optimizer-agent | Quantization, pruning, distillation |
production-engineer-agent | Model serving, reliability, scaling |
mlops-engineer-agent | ML infrastructure, pipelines, monitoring |
ai-architect-agent | ML system architecture, requirements analysis |
experiment-analyst-agent | Experiment tracking, analysis, reporting |
Specialized Domains
game-systems-designer | Game mechanics, balancing, multiplayer |
embedded-systems | Firmware, RTOS, IoT connectivity |
scientific-computing | Numerical methods, simulations |
Omega Exclusive
oracle | Deep analysis with 7 Omega thinking modes |
sprint-master | Sprint management, team orchestration |
Commands (174)
Commands are slash-prefixed actions organized by namespace.
Development (/dev:*)
/dev:feature <desc>
/dev:fix <error>
/dev:fix-fast <error>
/dev:fix-hard <error>
/dev:test <scope>
/dev:tdd <feature>
/dev:review [file]
Testing Options (available on most dev commands):
/dev:feature "login" --no-test
/dev:fix "bug" --test-level strict
/dev:feature-tested "auth" --coverage 90
/dev:fix-fast "typo" --with-test
Planning (/planning:*)
/planning:plan <task>
/planning:plan-detailed
/planning:brainstorm <topic>
/planning:research <topic>
/planning:doc <target>
Git (/git:*)
/git:commit [message]
/git:ship [message]
/git:pr [title]
/git:deploy [env]
Quality (/quality:*)
/quality:security-scan
/quality:refactor <file>
/quality:optimize <file>
/quality:lint
/quality:verify-done
/quality:coverage-check
/quality:test-plan
Omega (/omega:*)
/omega:10x <topic>
/omega:100x <topic>
/omega:1000x <topic>
/omega:principles
/omega:dimensions
Sprint Management (/sprint:*)
/sprint:vision-set
/sprint:vision-show
/sprint:sprint-new
/sprint:sprint-start
/sprint:sprint-current
/sprint:sprint-end
/sprint:ship
/sprint:backlog-add
/sprint:backlog-show
/sprint:team-run
/sprint:team-status
Reference-Aware Planning (available on sprint commands):
/sprint:sprint-new "Auth" --ref=artifacts/prd.md
/sprint:team-run --ref=specs/api.yaml
/sprint:backlog-add "Login" --ref=artifacts/prd.md
Sprint Ship (complete sprint + deploy):
/sprint:ship "Sprint 1 - MVP"
/sprint:ship --skip-tests
/sprint:ship --no-pr
/sprint:ship --force
Autonomous Development (/auto:*)
/auto:init <idea>
/auto:start
/auto:status
/auto:approve
/auto:reject
/auto:resume
Alignment (/alignment:*)
/alignment:health
/alignment:deps <type:name>
ML Systems (New - 31 commands)
/omgml:* - Project Management
/omgml:init
/omgml:status
/omgdata:* - Data Engineering
/omgdata:collect
/omgdata:validate
/omgdata:clean
/omgdata:split
/omgdata:version
/omgfeature:* - Feature Engineering
/omgfeature:extract
/omgfeature:select
/omgfeature:store
/omgtrain:* - Model Training
/omgtrain:baseline
/omgtrain:train
/omgtrain:tune
/omgtrain:evaluate
/omgtrain:compare
/omgoptim:* - Model Optimization
/omgoptim:quantize
/omgoptim:prune
/omgoptim:distill
/omgoptim:profile
/omgdeploy:* - Deployment
/omgdeploy:package
/omgdeploy:serve
/omgdeploy:edge
/omgdeploy:cloud
/omgdeploy:ab
/omgops:* - ML Operations
/omgops:pipeline
/omgops:monitor
/omgops:drift
/omgops:retrain
/omgops:registry
Workflows (69)
Workflows are orchestrated sequences of agents, commands, and skills.
Development
development/feature | Complete feature from planning to PR |
development/bug-fix | Systematic debugging and resolution |
development/refactor | Code improvement and restructuring |
development/code-review | Comprehensive code review |
Testing Automation (New)
testing/automated-testing | End-to-end testing automation with task generation, enforcement, and coverage gates |
AI Engineering
ai-engineering/rag-development | Build complete RAG systems |
ai-engineering/model-evaluation | AI model evaluation pipeline |
ai-engineering/prompt-engineering | Systematic prompt optimization |
ai-engineering/agent-development | Build AI agents |
ai-engineering/fine-tuning | Model fine-tuning workflow |
AI-ML Operations
ai-ml/data-pipeline | Build ML data pipelines |
ai-ml/experiment-cycle | ML experiment tracking |
ai-ml/model-deployment | Model serving and deployment |
ai-ml/monitoring-setup | ML model monitoring |
Microservices
microservices/domain-decomposition | DDD bounded context analysis |
microservices/service-scaffolding | Service template generation |
microservices/contract-first | API contract development |
microservices/distributed-tracing | Tracing implementation |
Event-Driven
event-driven/event-storming | Domain event modeling |
event-driven/saga-implementation | Distributed transaction patterns |
event-driven/schema-evolution | Event schema management |
Game Development
game/prototype-to-production | Game development lifecycle |
game/content-pipeline | Asset management |
game/playtesting | Testing and balancing |
Omega
omega/10x-improvement | Tactical enhancements |
omega/100x-architecture | System redesign |
omega/1000x-innovation | Industry transformation |
ML Systems (New - 12 workflows)
ml-systems/full-ml-lifecycle-workflow | Complete ML lifecycle orchestration |
ml-systems/data-pipeline-workflow | Data collection to feature store |
ml-systems/model-development-workflow | Baseline to optimized models |
ml-systems/model-optimization-workflow | Quantization, pruning, distillation |
ml-systems/production-deployment-workflow | Model packaging to serving |
ml-systems/mlops-pipeline-workflow | CI/CD for ML systems |
ml-systems/model-monitoring-workflow | Drift detection and alerting |
ml-systems/experiment-tracking-workflow | Systematic experimentation |
ml-systems/feature-engineering-workflow | Feature extraction and selection |
ml-systems/model-retraining-workflow | Automated retraining triggers |
ml-systems/edge-deployment-workflow | Edge/mobile model deployment |
ml-systems/ab-testing-workflow | A/B testing for models |
Skills (162)
Skills are domain expertise modules organized in 24 categories.
AI Engineering (12 skills)
Based on production AI application patterns:
ai-engineering/foundation-models | Model architecture, sampling, structured outputs |
ai-engineering/evaluation-methodology | AI-as-judge, semantic similarity, ELO ranking |
ai-engineering/prompt-engineering | Few-shot, chain-of-thought, injection defense |
ai-engineering/rag-systems | Chunking, embedding, hybrid retrieval, reranking |
ai-engineering/ai-agents | Tool use, ReAct, Plan-and-Execute, memory |
ai-engineering/finetuning | LoRA, QLoRA, PEFT, model merging |
ai-engineering/inference-optimization | Quantization, batching, caching, vLLM |
ai-engineering/guardrails-safety | Input/output guards, PII protection |
ML Systems (18 skills - New)
Based on Chip Huyen's "Designing ML Systems" and Stanford CS 329S:
ml-systems/ml-systems-fundamentals | Core ML concepts, design principles |
ml-systems/deep-learning-primer | Neural network foundations |
ml-systems/dnn-architectures | CNNs, RNNs, Transformers, hybrid models |
ml-systems/data-eng | ML data pipelines, storage, processing |
ml-systems/training-data | Sampling, labeling, augmentation |
ml-systems/feature-engineering | Feature extraction, selection, stores |
ml-systems/ml-workflow | Experiment design, model selection |
ml-systems/model-dev | Training, evaluation, debugging |
ml-systems/ml-frameworks | PyTorch, TensorFlow, scikit-learn |
ml-systems/efficient-ai | Model compression, efficient architectures |
ml-systems/model-optimization | Quantization, pruning, distillation |
ml-systems/ai-accelerators | GPU/TPU optimization, hardware selection |
ml-systems/model-deployment | Serving, containerization, scaling |
ml-systems/ml-serving-optimization | Batching, caching, latency reduction |
ml-systems/edge-deployment | TFLite, Core ML, TensorRT |
ml-systems/mlops | CI/CD for ML, model registry, pipelines |
ml-systems/robust-ai | Reliability, monitoring, drift detection |
ml-systems/deployment-paradigms | Batch vs real-time vs streaming |
Methodology (19 skills)
methodology/writing-plans | Implementation plan creation |
methodology/executing-plans | Plan execution best practices |
methodology/debugging | Systematic debugging approach |
methodology/code-review | Review standards and checklists |
methodology/tdd | Test-driven development |
methodology/test-task-generation | Auto-generate test tasks from features |
methodology/test-enforcement | Enforce tests before task completion |
Frameworks (10 skills)
frameworks/react | React hooks, TypeScript, state management |
frameworks/nextjs | App Router, Server Components, API routes |
frameworks/django | DRF, ORM optimization, Celery tasks |
frameworks/fastapi | Async/await, Pydantic v2, dependency injection |
frameworks/nestjs | TypeScript, dependency injection, microservices |
BigTech Workflow Alignment (4 skills - New)
Skills aligning OMGKIT with Google, Meta, Netflix, and Amazon engineering practices:
devops/feature-flags | Progressive delivery, canary releases, A/B testing | Netflix, LaunchDarkly |
testing/chaos-engineering | Fault injection, game days, resilience testing | Netflix Chaos Monkey |
devops/dora-metrics | Deployment frequency, lead time, MTTR tracking | Google DORA Research |
methodology/stacked-diffs | Stacked PRs for parallel code review | Meta Engineering |
Other Categories
| AI-ML Operations | 6 | MLOps, feature stores, model serving |
| ML Systems | 18 | Production ML from data to deployment |
| Microservices | 6 | Service mesh, API gateway, tracing |
| Event-Driven | 6 | Kafka, event sourcing, CQRS |
| Game Development | 5 | Unity, Godot, networking |
| Databases | 9 | PostgreSQL, MongoDB, Redis |
| Frontend | 7 | Tailwind, shadcn/ui, accessibility |
| DevOps | 9 | Docker, Kubernetes, GitHub Actions, DORA, Feature Flags |
| Testing | 10 | Comprehensive, chaos, mutation, security |
| Security | 4 | OWASP, OAuth, hardening |
Modes (10)
Modes configure Claude's behavior for different contexts.
default | Balanced standard behavior |
tutor | Teaching mode with Feynman technique & Socratic questions |
brainstorm | Creative exploration, divergent thinking |
token-efficient | Compressed output (30-70% savings) |
deep-research | Thorough analysis with citations |
implementation | Code-focused, minimal prose |
review | Critical analysis mode |
orchestration | Multi-task coordination |
omega | 10x-1000x thinking mode |
autonomous | AI team self-management |
Switch modes:
/context:mode <name>
Autonomous Development (14 Archetypes)
Build complete applications from idea to deployment.
| SaaS MVP | Multi-tenant SaaS with auth, payments |
| API Service | Backend APIs for web/mobile apps |
| CLI Tool | Command-line utilities |
| Library/SDK | Reusable npm packages |
| Full-Stack App | Complete web applications |
| Mobile App | iOS/Android with React Native |
| AI-Powered App | LLM apps with RAG, function calling |
| AI Model Building | ML model training pipelines |
| Desktop App | Electron cross-platform apps |
| IoT App | Device management, real-time data |
| Game | Unity/Godot game development |
| Simulation | Scientific/engineering simulations |
| Microservices | Distributed services with K8s |
| Event-Driven | Async systems with Kafka, CQRS |
How It Works
- Discovery: AI asks questions to understand your vision
- Planning: Generates architecture, tasks, and timeline
- Execution: Autonomous development with checkpoints
- Review: Human approval at critical milestones
- Iteration: Feedback loop for refinements
Artifacts System
Provide project context with reference documents:
.omgkit/artifacts/
├── README.md # How to use artifacts
├── data/ # Sample data, schemas, data dictionaries
├── docs/ # Requirements, user stories, PRDs
├── knowledge/ # Glossary, business rules, domain knowledge
├── research/ # Competitor analysis, market research
├── assets/ # Reference images, templates, mockups
└── examples/ # Code samples, reference implementations
Note: Artifacts are reference materials only, NOT execution instructions. They help AI understand your project context.
Project Structure
After omgkit init:
your-project/
├── .omgkit/
│ ├── config.yaml # Project settings
│ ├── settings.json # Permissions
│ ├── sprints/
│ │ ├── vision.yaml # Product vision
│ │ └── backlog.yaml # Task backlog
│ ├── plans/ # Generated plans
│ ├── docs/ # Generated docs
│ ├── logs/ # Activity logs
│ ├── devlogs/ # Development logs (git-ignored)
│ │ └── README.md
│ ├── stdrules/ # Project standards
│ │ ├── README.md
│ │ ├── BEFORE_COMMIT.md
│ │ ├── SKILL_STANDARDS.md
│ │ └── TESTING_STANDARDS.md
│ └── artifacts/ # Project context (reference only)
│ └── README.md
├── OMEGA.md # Project context file
└── CLAUDE.md # Claude Code instructions
MCP Integrations
OMGKIT supports these MCP servers:
context7 | Up-to-date library documentation |
sequential-thinking | Multi-step reasoning |
memory | Persistent knowledge graph |
filesystem | Secure file operations |
playwright | Browser automation |
Standards & Rules
OMGKIT provides two types of standards:
For OMGKIT Contributors
Located in plugin/stdrules/:
ALIGNMENT_PRINCIPLE.md | Component hierarchy rules |
OMGKIT_BEFORE_COMMIT_RULES.md | Validation requirements |
SKILL_STANDARDS.md | Skill documentation standards |
For Project Developers
Generated in .omgkit/stdrules/ when you run omgkit init:
BEFORE_COMMIT.md | Pre-commit checklist |
SKILL_STANDARDS.md | Custom skill guidelines |
CLI Commands
Global Commands
omgkit install
omgkit init
omgkit doctor
omgkit list
omgkit update
omgkit uninstall
omgkit help
Project Upgrade Commands (New)
Keep your project up-to-date with the latest OMGKIT features:
omgkit project:upgrade
omgkit project:upgrade --dry
omgkit project:rollback
omgkit project:backups
omgkit project:version
Safe Upgrade System
OMGKIT's upgrade system is designed with safety first:
| Version Tracking | Each project tracks its OMGKIT version in settings.json |
| Smart Merge | workflow.yaml uses add-only merge (never overwrites your values) |
| Protected Files | config.yaml, sprints/, artifacts/, devlogs/* are NEVER modified |
| Auto-Backup | Creates timestamped backup before any changes |
| Dry Run | Preview all changes with --dry flag before applying |
| Rollback | One command to restore previous state if needed |
What Gets Upgraded
| stdrules/ | New standards are added, modified ones offer 3-way merge |
| workflow.yaml | Smart merge adds new sections, preserves your customizations |
| CLAUDE.md | Updated with new instructions |
| settings.json | Version updated, structure preserved |
| Your files | NEVER touched (config.yaml, sprints, artifacts, devlogs) |
Config Commands (New)
Configure workflow settings via CLI:
omgkit config get testing.enforcement.level
omgkit config get testing.coverage_gates.unit
omgkit config set testing.enforcement.level strict
omgkit config set testing.auto_generate_tasks true
omgkit config set testing.coverage_gates.unit.minimum 90
omgkit config list
omgkit config list testing
omgkit config reset testing.enforcement.level
Supported Value Types
| String | omgkit config set git.main_branch develop |
| Boolean | omgkit config set testing.auto_generate_tasks true |
| Number | omgkit config set testing.coverage_gates.unit.minimum 90 |
Note: For arrays, edit .omgkit/workflow.yaml directly.
Documentation Sync Automation
OMGKIT uses a self-healing documentation system that ensures docs are always synchronized with code:
How It Works
- Code is Single Source of Truth: All component metadata lives in plugin files
- Auto-Discovery: Categories and counts are discovered dynamically, not hardcoded
- Auto-Generation: mint.json navigation is generated from docs structure
- Validation Tests: 23 tests verify docs-plugin sync before every release
Documentation Commands
npm run docs:generate
npm run docs:mint
npm run docs:validate
npm run docs:sync
Pre-Release Protection
The preversion hook automatically runs docs:sync before version bumps:
npm version patch
If any sync issue is detected (missing pages, wrong counts, broken links), the version bump fails.
Validation & Testing
OMGKIT has 8200+ automated tests ensuring system integrity.
Run Tests
npm test
npm test -- tests/validation/
npm test -- tests/unit/
npm run test:docs
Test Categories
| Registry Sync | ~200 | Verify registry matches files |
| Alignment | ~400 | Component hierarchy validation |
| Documentation | ~500 | Quality and format checks |
| Docs Sync | 23 | Plugin-to-docs mapping validation |
| Format | ~300 | Naming convention compliance |
| Dependency Graph | ~600 | Reference integrity |
Contributing
See CONTRIBUTING.md for guidelines.
Quick Start
- Fork and clone the repository
- Install dependencies:
npm install
- Run tests:
npm test
- Make changes following
plugin/stdrules/
- Submit PR with conventional commit messages
Documentation
Full documentation available at: omgkit.mintlify.app
License
MIT - See LICENSE for details.
Think Omega. Build Omega. Be Omega.