Quickstart

Get from zero to reliability-checked metrics in 5 minutes.

1. Install

pip install onlymetrix

Requires Python 3.9+.

2. Get an API Key

Sign up at app.onlymetrix.com (free, no card required).

Set your API key:

export OMX_API_KEY=omx_sk_...

3. Connect Your Warehouse

omx setup connect-warehouse \
  --type postgres \
  --host localhost \
  --database analytics \
  --user readonly \
  --password yourpassword

Supported: PostgreSQL, Snowflake, ClickHouse.

4. Sync Your Metrics

From dbt:

dbt compile
omx dbt sync

From Omni:

omx omni sync --project-dir ~/omni-models

From raw SQL:

omx sql convert "SELECT SUM(amount) FROM orders WHERE status = 'paid'" --import

5. Check Reliability

omx reliability check

METRIC RELIABILITY STATUS

  7 healthy    4 degraded    0 unreliable    11 total

  Validation: 11 passing  3 failing  0 warning  22 tests

6. Run Validation Tests

omx validation run

VALIDATION RESULTS — 22 tests

  11 passing    3 failing    0 warning

  FAIL  total_revenue · Non-negative values
  |-- Rows affected:  7,901 (17.6% of 44,876)
  `-- Inspect:        SELECT * FROM invoices WHERE total_amount < 0 LIMIT 10

7. Investigate with the Agent

omx agent "why is total_revenue degraded?" --explain

The agent runs reliability checks, queries metrics, and narrates the root cause — all from governed data.

Next Steps

• Core Concepts — IR, reliability, validation
• CLI Reference — full command list
• Python SDK — programmatic access
• dbt Integration — sync from dbt
• Omni Integration — sync from Omni