Overlays

Overlays are Cube definition files that describe dimensions, measures, joins, and other metadata for your data models. The CLI syncs these definitions between your local filesystem and the RevOS API.

File Format

Overlay files are JSON. The filename (without .json) becomes the overlay name. A description field in the file is synced with the overlay's description on push.

Example my-overlay.json:

{
  "description": "My custom overlay",
  "sql_table": "my_table",
  "dimensions": {
    "id": {
      "sql": "id",
      "type": "number",
      "primary_key": true
    }
  }
}

Directory Convention

By default, overlay commands look for files in ./overlays. Use -d to specify a different directory:

revos overlays status -d ./custom-path

Workflow

A typical overlay workflow:

1. Pull remote overlays: revos overlays pull
2. Edit files locally
3. Check status: revos overlays status
4. Review changes: revos overlays diff
5. Push to remote: revos overlays push