CLI Reference

Date: 2026-08-29 Total entries: 79 Packages: 26

Auto-generated by running the actual CLI and scanning pyproject.toml entry points.

Command Tree

oridecon
├── version          Show framework and package versions.
├── completion       Generate shell completion script.
├── list             List all available commands.
├── test             Run project tests.
├── lint             Run project linting.
├── init             Initialize Oridecon in existing project
├── new              Create a new Oridecon project
│   └── project        Create a new Oridecon project, fully aligned with the framework.
│   └── module         Create a bounded context inside a modular project.
│   └── package        Scaffold a new oridecon-* extension package.
│
├── add              Add a provider to the project
├── dev              Development server and tools
│   └── start          Start production server.
│
├── run              Smart runner — auto-detects factory, sets profile
├── db               Database management commands
│   └── init           Initialize database migrations.
│   └── migrate        Generate a new migration file.
│   └── create         Create a new empty migration file.
│   └── upgrade        Apply pending migrations.
│   └── downgrade      Revert migrations.
│   └── status         Show migration status.
│   └── history        Show migration history.
│   └── validate       Validate migrations.
│   └── seed           Run database seeders.
│   └── reset          Drop and recreate the database.
│   └── shell          Open database shell (auto-detects database type).
│   └── inspect        Show database schema.
│   └── backup         Backup the database.
│   └── restore        Restore the database from backup.
│   └── setup          Run schema setup for all installed packages that need database tables.
│
├── gen              Code generation commands
│   └── list           List all available generators.
│   └── notification_template Generate a notification template
│   └── tenant_resolver Generate a custom tenant resolver strategy
│   └── auth_guard     Generate an authentication/authorization guard
│   └── auth_policy    Generate an authorization policy
│   └── guard          Generate an authorization guard
│   └── feature_flag   Generate a feature flag definition
│   └── mcp-controller Generate an MCPController class with tool, resource, and prompt examples
│   └── mcp-server     Generate a standalone MCP server script with module-level decorators
│   └── audited        Generate an audited async handler
│   └── task           Generate a background task with queue registration
│   └── vector_collection Generate a vector collection definition with backend registration
│   └── event_handler  Generate an event handler with bus registration
│   └── saga           Generate a saga orchestrator with compensating actions
│   └── event          Generate a domain event class
│   └── command        Generate a CQRS command handler
│   └── query          Generate a CQRS query handler
│   └── projection     Generate an event projection for read models
│   └── admin_action   Generate a custom admin action
│   └── admin_resource Generate an admin resource for the admin panel
│   └── workflow_def   Generate a workflow definition with steps and transitions
│   └── pipeline       Generate a pipeline with sequential processing stages
│   └── saga_step      Generate a saga step with compensating transaction
│   └── repository     Generate a database repository with query methods
│   └── filter         Generate a query filter for database models
│   └── seeder         Generate a database seeder for test/dev data
│   └── health         Generate a database health check
│   └── model          Generate a Pydantic entity model with Create/Update DTOs
│   └── migration      Generate a chained alembic migration for an entity
│   └── service        Generate a service with unit of work
│   └── dataloader     Generate a GraphQL DataLoaderProtocol to solve N+1 problems
│   └── document_repo  Generate a NoSQL document repository
│   └── cache_repo     Generate a cache-backed repository with TTL support
│   └── api_client     Generate an external API client
│   └── metric         Generate a custom metric definition with backend registration
│   └── message_consumer Generate a message consumer with queue routing
│   └── provider       Generate provider
│   └── test           Generate test
│   └── search_index   Generate a search index with backend registration
│   └── controller     Generate a web controller with route handlers
│   └── resource       Generate a resource controller slice
│   └── middleware     Generate a web middleware component
│   └── graphql        Generate a GraphQL schema and resolvers
│   └── webhook        Generate a webhook handler
│   └── websocket      Generate a WebSocket handler
│   └── exception_filter Generate a web exception filter
│   └── interceptor    Generate a web request/response interceptor
│   └── error          Generate a custom HTTP error
│   └── storage_driver Generate a file storage backend driver
│
├── config           Configuration management
│   └── show           Show current configuration.
│   └── init           Initialize a new Oridecon configuration file with default settings.
│   └── validate       Validate configuration file.
│   └── schema         Export configuration JSON schema.
│   └── doctor         Diagnose configuration issues.
│   └── env            Show environment variables used in configuration.
│   └── diff           Show the difference between two configuration files.
│   └── env-example    Generate a .env.example file from the current configuration.
│
├── inspect          Inspect runtime state
│   └── providers      List all registered providers.
│   └── routes         List all HTTP routes.
│   └── middleware     List middleware stack in order.
│   └── container      Show DI container registrations.
│   └── events         List registered event handlers.
│   └── tasks          List registered task handlers.
│   └── dependencies   Show provider dependency graph.
│   └── config         Alias for config show.
│   └── modules        List all registered Oridecon modules in the application.
│   └── health         Show provider health status from the running application.
│   └── main           Inspect runtime state (alias for subcommands).
│
├── shell            Interactive Python REPL
│   └── main           Start an interactive Python REPL.
│
├── contrib          Discover and inspect installed contributors
│   └── list           List installed CLI contributors and their contribution surface.
│   └── inspect        Show full contribution details for a specific contributor.
│   └── check          Verify all installed contributors load without errors.
│
├── project          Project management (test, lint, routes)
│   └── test           Run project tests.
│   └── lint           Run project linting.
│   └── typecheck      Run type checking.
│   └── routes         List all registered web and GraphQL routes.
│   └── run-all        Run all project checks (test, lint, typecheck).
│   └── deps           Show and audit project dependencies.
│
├── system           System information and management
│   └── info           Display information about the Oridecon environment.
│   └── health         Check the health of the current Oridecon project.
│   └── shell          Open an interactive Oridecon shell.
│   └── providers      List all registered providers in the current project.
│   └── doctor         Diagnose system environment and configuration issues.
│
├── notify           Notification channel management commands
│   └── channels       Channel management commands
│   └── test           Test notification delivery
│   └── inbox          Inbox management commands
│
│
│   [Contributed via entry points]
├── events           Event schema management commands
├── tenancy          Multi-tenant management commands
├── auth             Authentication and authorization management commands
├── features         Feature flag management commands
├── mcp              MCP server management — serve, inspect, list tools
├── audit            Audit log query and management commands
├── tasks            Background task management commands
├── vector           Vector store management commands
├── workflow         Workflow and pipeline management commands
├── cache            Cache inspection and management commands
├── monitor          Observability and monitoring commands
├── ai               AI subsystem management commands

Generator Inventory

Total: 48 generators

Generator	Description
`oridecon gen notification_template`	Generate a notification template
`oridecon gen tenant_resolver`	Generate a custom tenant resolver strategy
`oridecon gen auth_guard`	Generate an authentication/authorization guard
`oridecon gen auth_policy`	Generate an authorization policy
`oridecon gen guard`	Generate an authorization guard
`oridecon gen feature_flag`	Generate a feature flag definition
`oridecon gen mcp-controller`	Generate an MCPController class with tool, resource, and prompt examples
`oridecon gen mcp-server`	Generate a standalone MCP server script with module-level decorators
`oridecon gen audited`	Generate an audited async handler
`oridecon gen task`	Generate a background task with queue registration
`oridecon gen vector_collection`	Generate a vector collection definition with backend registration
`oridecon gen event_handler`	Generate an event handler with bus registration
`oridecon gen saga`	Generate a saga orchestrator with compensating actions
`oridecon gen event`	Generate a domain event class
`oridecon gen command`	Generate a CQRS command handler
`oridecon gen query`	Generate a CQRS query handler
`oridecon gen projection`	Generate an event projection for read models
`oridecon gen admin_action`	Generate a custom admin action
`oridecon gen admin_resource`	Generate an admin resource for the admin panel
`oridecon gen workflow_def`	Generate a workflow definition with steps and transitions
`oridecon gen pipeline`	Generate a pipeline with sequential processing stages
`oridecon gen saga_step`	Generate a saga step with compensating transaction
`oridecon gen repository`	Generate a database repository with query methods
`oridecon gen filter`	Generate a query filter for database models
`oridecon gen seeder`	Generate a database seeder for test/dev data
`oridecon gen health`	Generate a database health check
`oridecon gen model`	Generate a Pydantic entity model with Create/Update DTOs
`oridecon gen migration`	Generate a chained alembic migration for an entity
`oridecon gen service`	Generate a service with unit of work
`oridecon gen dataloader`	Generate a GraphQL DataLoaderProtocol to solve N+1 problems
`oridecon gen document_repo`	Generate a NoSQL document repository
`oridecon gen cache_repo`	Generate a cache-backed repository with TTL support
`oridecon gen api_client`	Generate an external API client
`oridecon gen metric`	Generate a custom metric definition with backend registration
`oridecon gen message_consumer`	Generate a message consumer with queue routing
`oridecon gen provider`	Generate provider
`oridecon gen test`	Generate test
`oridecon gen search_index`	Generate a search index with backend registration
`oridecon gen controller`	Generate a web controller with route handlers
`oridecon gen resource`	Generate a resource controller slice
`oridecon gen middleware`	Generate a web middleware component
`oridecon gen graphql`	Generate a GraphQL schema and resolvers
`oridecon gen webhook`	Generate a webhook handler
`oridecon gen websocket`	Generate a WebSocket handler
`oridecon gen exception_filter`	Generate a web exception filter
`oridecon gen interceptor`	Generate a web request/response interceptor
`oridecon gen error`	Generate a custom HTTP error
`oridecon gen storage_driver`	Generate a file storage backend driver

Contributed Command Groups

These command groups are registered via the oridecon.cli.contributors entry-point and loaded at runtime by the CLI’s contributor discovery system.

26 groups across 26 packages

Group	Package	Target
`oridecon admin`	oridecon-admin	`oridecon.admin.cli.contributor:AdminCliContributor`
`oridecon ai`	oridecon-ai	`oridecon.ai.cli.contributor:AICliContributor`
`oridecon audit`	oridecon-audit	`oridecon.audit.cli.contributor:AuditCliContributor`
`oridecon auth`	oridecon-auth	`oridecon.auth.cli.contributor:AuthCliContributor`
`oridecon cache`	oridecon-cache	`oridecon.cache.cli.contributor:CacheCliContributor`
`oridecon core`	oridecon-cli	`oridecon.cli.contributors.core:CoreCliContributor`
`oridecon events`	oridecon-events	`oridecon.events.cli.contributor:EventsCliContributor`
`oridecon features`	oridecon-features	`oridecon.features.cli.contributor:FeaturesCliContributor`
`oridecon graphql`	oridecon-graphql	`oridecon.graphql.cli.contributor:GraphQLCliContributor`
`oridecon http`	oridecon-http	`oridecon.http.cli.contributor:HttpCliContributor`
`oridecon mcp`	oridecon-ai-mcp	`oridecon.ai.mcp.cli.contributor:McpCliContributor`
`oridecon monitor`	oridecon-monitor	`oridecon.monitor.cli.contributor:MonitorCliContributor`
`oridecon nosql`	oridecon-nosql	`oridecon.nosql.cli.contributor:NoSqlCliContributor`
`oridecon notification`	oridecon-notification	`oridecon.notification.cli.contributor:NotificationCliContributor`
`oridecon queue`	oridecon-queue	`oridecon.queue.cli.contributor:QueueCliContributor`
`oridecon resilience`	oridecon-resilience	`oridecon.resilience.cli.contributor:ResilienceCliContributor`
`oridecon search`	oridecon-search	`oridecon.search.cli.contributor:SearchCliContributor`
`oridecon session`	oridecon-ai-session	`oridecon.ai.session.cli.contributor:AiSessionCliContributor`
`oridecon sql`	oridecon-sql	`oridecon.sql.cli.contributor:SqlCliContributor`
`oridecon storage`	oridecon-storage	`oridecon.storage.cli.contributor:StorageCliContributor`
`oridecon tasks`	oridecon-tasks	`oridecon.tasks.cli.contributor:TasksCliContributor`
`oridecon tenancy`	oridecon-tenancy	`oridecon.tenancy.cli.contributor:TenancyCliContributor`
`oridecon vector`	oridecon-vector	`oridecon.vector.cli.contributor:VectorCliContributor`
`oridecon web`	oridecon-web	`oridecon.web.cli.contributor:WebCliContributor`
`oridecon webhook`	oridecon-webhook	`oridecon.webhook.cli.contributor:WebhookCliContributor`
`oridecon workflow`	oridecon-workflow	`oridecon.workflow.cli.contributor:WorkflowCliContributor`

Source Files

Package	File	Commands