TheDocumentation Index
Fetch the complete documentation index at: https://docs.veloiq.dev/llms.txt
Use this file to discover all available pages before exploring further.
veloiq CLI is the primary tool for working with VeloIQ projects. You install it as part of the veloiq-framework Python package and use it to scaffold new applications, add feature modules, regenerate API and TypeScript code after model changes, start the development server, manage Alembic database migrations, and configure the global search bar.
Installation
Install the framework (which includes the CLI) from PyPI:Command reference
| Command | Description |
|---|---|
veloiq new <app> | Scaffold a new full-stack project |
veloiq add-module <name> | Add a module to an existing project |
veloiq generate | Generate api.py and TypeScript schemas from models |
veloiq run | Start the development server |
veloiq db <subcommand> | Manage Alembic database migrations |
veloiq search <subcommand> | Configure global search |
Command pages
veloiq new
Scaffold a complete full-stack project from a single command.
veloiq generate
Generate CRUD endpoints and TypeScript schemas from your SQLModel definitions.
veloiq db
Create revisions, apply migrations, and inspect history with Alembic.
veloiq search
Register models and fields for the global search bar.