Configuration
Configure Velocity CLI defaults for database, cache, and queue drivers. Set project scaffolding preferences for faster development.
The Velocity CLI stores global configuration preferences that apply when creating new projects.
Configuration File
Configuration is stored in ~/.vel/config.yaml. This file is created automatically when you first set a configuration value.
Available Settings
| Setting | Description | Valid Values |
|---|---|---|
default.database | Default database driver for new projects | postgres, mysql, sqlite |
default.cache | Default cache driver | redis, memory |
default.queue | Default queue driver | redis, database, sync |
default.auth | Include authentication by default | true, false |
default.api | Create API-only projects by default | true, false |
Setting Defaults
Configure your preferred defaults so you don’t have to specify them every time:
# Set PostgreSQL as default database
velocity config set default.database postgres
# Set Redis as default cache
velocity config set default.cache redis
# Always include authentication
velocity config set default.auth trueNow when you create a new project, these defaults are used:
# Uses postgres + redis + auth without specifying flags
velocity new myappViewing Configuration
List all current settings:
velocity config listGet a specific value:
velocity config get default.databaseResetting Configuration
Clear all settings and return to defaults:
velocity config resetPriority Order
When creating a project, values are resolved in this order:
- Command-line flags (highest priority)
- Configuration file (
~/.vel/config.yaml) - Built-in defaults (lowest priority)
Example:
# Config has default.database = postgres
# But this command uses mysql (flag overrides config)
velocity new myapp --database mysqlExample Configuration File
# ~/.vel/config.yaml
defaults:
database: postgres
cache: redis
queue: redis
auth: true
api: false
