Docs / Getting Started

Getting Started

Two roles, two starting points

Your invitation determines what you need to do on day one. Pick the path that matches your role.

BA Owner / Account Operator

Explore and govern

Accept invitation → sign in → set billing context → pull ecommerce-showcase → explore published dashboards in UI.

No BigQuery setup or model authoring required. Your workspace is ready to explore once pulled and validated.

Developer / Analytics Engineer

Build and publish

Accept invitation → sign in → set billing context → set up BigQuery service account → create workspace → author sources, models, visualizations, dashboards → push.

BigQuery setup is required before you can write models that run queries.

Prerequisites before running commands

  • You have an invitation to the target account in https://my.looky.studio.
  • The Looky CLI is installed and available as looky in your shell.
  • You have a local folder that will act as the linked root (example: <local_root>).
  • You know the billing account id you should operate in (example: <billing_account_id>).

Day-zero sequence

  1. Accept invitation and verify your role and scope (Owner Invitation).
  2. Sign in to the UI, then link CLI to the same instance and root (Sign In and Connect the CLI).
  3. Developers only: Create a GCP service account and wire credentials into the workspace runtime config (BigQuery Dataset Access).
  4. Set billing context, then pull or create your first workspace (Create Your First Workspace).
  5. Invite additional builders only after the first workspace validates (Invite Developers and Collaborators).

Baseline command flow

looky login https://my.looky.studio <local_root>
looky whoami

cd <local_root>
looky billing list
looky billing use <billing_account_id>

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

cd ecommerce-showcase
looky status
looky validate

Success criteria before moving to Build Workflow

  • looky whoami returns your authenticated user for the linked root.
  • looky billing use <billing_account_id> succeeds from <local_root>.
  • looky status resolves a workspace id in <billing_account_id>/<workspace_slug> shape.
  • looky validate returns no blocking errors.

If any one of these fails, stop and fix it before authoring dashboards. Most downstream failures are setup failures in disguise.