CLI Reference

The Vorte CLI provides 30+ commands for project management, code generation, database operations, AI tasks, M-Pesa integration, and DevOps workflows. All commands are accessible through the vorte binary after installation.

Global Options

FlagDescription
--helpShow help for any command
--versionPrint the Vorte CLI version
--verboseEnable verbose output
--config <path>Specify a custom config file
--env <name>Set the environment (development, staging, production)

Project Commands

CommandDescription
vorte new <name>Create a new Vorte project
vorte serveStart the development server
vorte doctorCheck environment and dependencies
vorte infoDisplay project and framework information
vorte versionPrint the Vorte framework version
terminal
bash
Copied!
1# Create a new project
2vorte new my-app
3
4# Start dev server with options
5vorte serve --host 0.0.0.0 --port 8000 --reload --workers 1
6
7# Check your environment
8vorte doctor

Generator Commands

CommandDescription
vorte generate module <name>Scaffold a new module
vorte generate model <name>Generate a SQLAlchemy model
vorte generate router <name>Generate an API router with CRUD endpoints
vorte generate schema <name>Generate Pydantic schemas
vorte generate service <name>Generate a service class with DI
vorte generate middleware <name>Generate a middleware class
vorte generate test <name>Generate a test file
vorte generate scaffold <name>Generate model, schema, router, and service together
terminal
bash
Copied!
1# Generate a complete CRUD scaffold
2vorte generate scaffold product --fields "name:str,price:float,active:bool"
3
4# Generate individual components
5vorte generate model Order --fields "user_id:int,total:float,status:str"
6vorte generate router orders --model Order --versioned
7vorte generate schema OrderPayload --fields "user_id:int,total:float"
8vorte generate test orders

Database Commands

CommandDescription
vorte db initInitialize migration directory
vorte db migrate -m <msg>Generate a new migration
vorte db upgradeApply pending migrations
vorte db downgradeRollback the last migration
vorte db historyShow migration history
vorte db currentShow current migration version
vorte db seedRun seed scripts
vorte db resetDrop and recreate all tables
terminal
bash
Copied!
1# Initialize and run first migration
2vorte db init
3vorte db migrate -m "create users table"
4vorte db upgrade
5
6# Seed development data
7vorte db seed --env development
8
9# Rollback
10vorte db downgrade

AI Commands

CommandDescription
vorte ai providersList configured AI providers and status
vorte ai modelsList available models per provider
vorte ai test <provider>Test connectivity to a provider
vorte ai complete <prompt>Run a completion from the CLI
vorte ai embed <text>Generate embeddings for text
vorte ai agent run <name>Run a named agent interactively
vorte ai agent listList registered agents
example.py
python
Copied!
1# Check provider health
2vorte ai providers
3
4# Quick completion
5vorte ai complete "Explain Vorte in one sentence"
6
7# Run an agent interactively
8vorte ai agent run support_assistant

M-Pesa Commands

CommandDescription
vorte mpesa stk-pushInitiate an STK push request
vorte mpesa query <id>Query transaction status
vorte mpesa balanceCheck account balance
vorte mpesa reversalInitiate a transaction reversal

DevOps Commands

CommandDescription
vorte dockerfileGenerate a Dockerfile for the project
vorte docker-composeGenerate a docker-compose.yml
vorte k8sGenerate Kubernetes manifests
vorte deployDeploy to the configured platform
vorte healthCheck application health endpoints
terminal
bash
Copied!
1# Generate deployment files
2vorte dockerfile --workers 4 --port 8000
3vorte docker-compose --with-redis --with-postgres
4vorte k8s --namespace production --replicas 3
5
6# Deploy
7vorte deploy --platform vercel
8vorte deploy --platform aws --region us-east-1

Manifest Commands

CommandDescription
vorte manifest buildBuild the application manifest
vorte manifest validateValidate the manifest against the schema
vorte manifest diffShow diff between current and previous manifest
vorte manifest exportExport the manifest to JSON or YAML
Stay in the loop

Get Vorte release notes, module guides, and developer deep-dives. No spam — unsubscribe anytime.