akili scaffold

Generate a starter set of YAML manifest files for a new data product. This command creates a directory with all 6 required manifests pre-populated with sensible defaults and TODO markers.

Usage

akili scaffold <product_name>

Arguments:

Argument	Type	Required	Description
product_name	string	yes	Name for the new product (also used as the directory name)

The command will fail if a directory with the given name already exists.

Examples

# Scaffold a new product
akili scaffold daily-orders

# Output:
# Scaffolded 'daily-orders' with 6 manifest files
#   daily-orders/product.yaml
#   daily-orders/inputs.yaml
#   daily-orders/output.yaml
#   daily-orders/quality.yaml
#   daily-orders/serving.yaml
#   daily-orders/compute.yaml

Generated Files

The scaffold command creates the following files:

product.yaml

name: "daily-orders"
namespace: default
archetype: batch
description: "TODO: describe your data product"
owner: team-data
domain: default

schedule:
  cron: "0 6 * * *"
  timezone: UTC

inputs.yaml

sources:
  - name: primary
    connection: TODO
    resource: TODO
    strategy: full

output.yaml

format: parquet
partitioning:
  - column: date
    type: day

quality.yaml

checks:
  - name: not_null_id
    type: not_null
    column: id
    severity: critical

  - name: row_count_positive
    type: custom_sql
    query: "SELECT COUNT(*) > 0 AS passed FROM {table}"
    severity: warning

serving.yaml

targets: []
  # - type: lookup
  #   table: product_lookup
  # - type: analytics

compute.yaml

engine: duckdb
resources:
  memory: 2Gi
  cpu: "1"

Typical Workflow

1. Scaffold the product: akili scaffold my-product
2. Edit the manifest files with your product configuration
3. Validate the manifests: akili validate ./my-product/
4. Create the product: akili product create --name my-product --namespace default
5. Deploy: akili product deploy my-product