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

SettingDescriptionValid Values
default.databaseDefault database driver for new projectspostgres, mysql, sqlite
default.cacheDefault cache driverredis, memory
default.queueDefault queue driverredis, database, sync
default.authInclude authentication by defaulttrue, false
default.apiCreate API-only projects by defaulttrue, 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 true

Now when you create a new project, these defaults are used:

# Uses postgres + redis + auth without specifying flags
velocity new myapp

Viewing Configuration

List all current settings:

velocity config list

Get a specific value:

velocity config get default.database

Resetting Configuration

Clear all settings and return to defaults:

velocity config reset

Priority Order

When creating a project, values are resolved in this order:

  1. Command-line flags (highest priority)
  2. Configuration file (~/.vel/config.yaml)
  3. Built-in defaults (lowest priority)

Example:

# Config has default.database = postgres
# But this command uses mysql (flag overrides config)
velocity new myapp --database mysql

Example Configuration File

# ~/.vel/config.yaml
defaults:
  database: postgres
  cache: redis
  queue: redis
  auth: true
  api: false