Docs / Getting Started

Create Your First Workspace

Path A: learn fast by pulling a real workspace

If you are new, start with ecommerce-showcase. It already includes sources, models, visualizations, and dashboards wired correctly.

cd <local_root>/<billing_account_id>
looky pull ecommerce-showcase
cd ecommerce-showcase
looky status
looky validate

Use this path to understand the operating model before creating brand-new content.

Path B: create a new workspace from zero

  1. Create workspace skeleton from billing directory:
    cd <local_root>/<billing_account_id>
    looky create <workspace_slug> --name "My Workspace" --description "First build workspace"
  2. Enter the workspace and validate initial skeleton:
    cd <workspace_slug>
    looky validate
  3. Configure runtime/sources.runtime.yml with your source alias.
  4. Add your first model, visualization, and dashboard files.
  5. Run looky validate, looky diff, and looky push.

Minimal files for first dashboard (from scratch)

content/models/sales.malloy

source: sales is ecommerce.table('bigquery-public-data.thelook_ecommerce.order_items') extend {
  dimension: product is product_name
  measure: sales_amount is sum(sale_price)
}

query: total_sales is sales -> {
  aggregate: sales_amount
}

query: sales_by_product is sales -> {
  group_by: product
  aggregate: sales_amount
  order_by: sales_amount desc
  limit: 10
}

content/visualizations/sales_total_kpi.yml

id: sales_total_kpi
title: Total Sales
query: "models/sales.malloy::total_sales"
type: kpi
mapping:
  value: sales_amount
published: true

content/visualizations/sales_by_product_bar.yml

id: sales_by_product_bar
title: Sales by Product
query: "models/sales.malloy::sales_by_product"
type: bar
mapping:
  x: product
  y: sales_amount
published: true

content/dashboards/sales_overview.yml

id: sales_overview
title: Sales Overview
layout_mode: fluid_grid
items:
  - visualization: sales_total_kpi
  - visualization: sales_by_product_bar
published: true

Publish and verify first dashboard

looky validate
looky diff
looky push
looky list visualizations
looky list dashboards

Then open https://my.looky.studio and confirm dashboard sales_overview is visible and renders both items.

Expected directory shape

<local_root>/
  <billing_account_id>/
    <workspace_slug>/
      workspace.yml
      content/
        models/
        visualizations/
        dashboards/
        exports/
      runtime/
        sources.runtime.yml
      secrets/

All CLI workspace commands assume you run from <workspace_slug> root.