kimo
Docs

Quickstart

Go from an empty workspace to a live, shareable dashboard in about ten minutes: connect a source, let Kimo build a model, and ask your first question.

Updated Oct 6, 20266 min readEdit on GitHub

Kimo is a data officer for your team. It connects to the tools you already use, turns raw tables into a governed data model, and lets anyone explore it with charts, dashboards or plain-English questions. This guide walks through the shortest path to value. You will need a Kimo workspace (the live demo works too) and read access to at least one data source.

Before you begin

  • A workspace with the Admin or Editor role. Viewers can explore but cannot add sources.
  • Credentials for one source: an OAuth login (Stripe, HubSpot, Search Console…) or a read-only database user.
  • If your database sits behind a firewall, allowlist the Kimo egress IPs listed in Settings → Network.

Five steps to a live dashboard

  1. 1
    Create a workspace

    Sign in and choose a workspace name and region (EU or US). The region decides where your warehouse cache and query logs live, and cannot be changed later without a migration.

  2. 2
    Connect your first source

    Open Connectors → Add source, pick a connector and authenticate. Kimo samples the schema and starts the first sync in the background. Most sources finish in under three minutes.

  3. 3
    Accept the suggested model

    Once the sample lands, Kimo proposes a model: primary keys, joins, and a starter set of measures such as mrr, active_customers or sessions. Review it, rename what you like and click Publish.

  4. 4
    Ask your first question

    Press ⌘K anywhere and type a question like "MRR by plan over the last 6 months". Kimo answers with a chart, the exact query it ran and the measures it used.

  5. 5
    Pin it to a dashboard

    Click Pin on the answer, choose or create a dashboard, and share the link. Dashboards refresh automatically on the source sync schedule.

Prefer the command line?

Everything above is also available through the kimo CLI and the REST API. The CLI is handy for scripting environments or checking models into Git.

brew install kimo/tap/kimokimo loginkimo sources add postgres --name "Production DB"kimo models suggest --source "Production DB" --publish

What happens next

Kimo keeps syncing your source on its default cadence (hourly for most SaaS tools, every 15 minutes for databases). The model you published becomes the shared vocabulary for your team: every chart, alert and answer is built from the same certified measures, so two people asking the same question get the same number.

Where to goWhy
Core conceptsUnderstand sources, models, measures and spaces.
Your first dashboardLayout, filters and sharing in depth.
Sync schedulesTune freshness per source and per table.
AlertsGet pinged when a metric moves, not when you remember to look.