LogoRevali
mrgnhnt96/revali ★9999⑂99

Revali Configuration

Configure constructs and other settings for Revali

Revali uses a revali.yaml configuration file to manage constructs, settings, and project-specific options. This file allows you to enable, disable, and configure constructs, as well as customize Revali's behavior for your project.

What is revali.yaml?#

The revali.yaml file is Revali's main configuration file that:

  • Manages Constructs: Enable, disable, and configure code generation constructs

File Location#

Create the revali.yaml file in the root of your project:

your_project/
├── lib/
├── routes/
├── pubspec.yaml
├── revali.yaml          # Revali configuration file
└── README.md

Basic Configuration#

A minimal revali.yaml file looks like this:

revali.yaml 
# Constructs configuration
constructs:
  - name: revali_docker
    enabled: true

Hot Reload Configuration#

Customize which paths trigger hot reload during development:

revali.yaml 
hot_reload:
  exclude:
    - lib/generated    # exclude directory (relative to revali.yaml)
    - docs             # exclude docs folder
    - /tmp/cache       # absolute paths also supported

Paths in exclude can be:

  • Relative - resolved from the revali.yaml file location (typically project root)
  • Absolute - used as-is

Excluding a directory ignores all file changes within it. Excluding a file ignores only that file.

Constructs Configuration#

Enable Constructs#

By default, all constructs are enabled. To explicitly enable a construct, add it to the constructs list:

revali.yaml 
constructs:
  - name: revali_docker
    enabled: true
  - name: revali_client
    enabled: true

Disable Constructs#

To disable a construct, set the enabled field to false:

revali.yaml 
constructs:
  - name: revali_docker
    enabled: false # Disable Docker construct
  - name: revali_client
    enabled: true

Construct Name Conflicts#

If you have constructs with conflicting names, use the package field to specify the package:

revali.yaml 
constructs:
  - name: docs
    package: revali_swagger # Specify package to avoid conflicts
    enabled: true
  - name: docs
    package: my_custom_package
    enabled: true

Configure Constructs#

Some constructs offer additional configuration options. Use the options field to configure them:

revali.yaml 
constructs:
  - name: revali_swagger
    enabled: true
    options:
      title: My API
      version: 2.1.0
  - name: revali_client
    enabled: true
    options:
      package_name: my_api_client
      scheme: https

Build Configuration#

Adding a build: section tells revali build to compile your server into a native executable, rather than leaving compilation to a build construct:

revali.yaml 
build:
  target_os: linux
  target_arch: [x64, arm64]

See revali build for the full field reference.

Next Steps#