Skip to main content

Quickstart

Ten minutes from install to a savings report. You need a Snowflake account locator and a user that can run queries — auth passes through, so your existing credentials work unchanged.

1. Configure​

# chukei.yaml — minimal pilot config
listen:
  bind: "127.0.0.1:8443"
upstream:
  snowflake:
    account: "abc12345.eu-west-2.aws"   # your locator incl. region
savings:
  enabled: true
  db_path: "./savings.db"
plugins:
  cache: { enabled: true }
  rewrite: { enabled: true }
  suspend: { enabled: true, mode: suggest-only }
  attribute: { enabled: true }
observability:
  prometheus: { enabled: true, port: 9090 }

For production-shaped deployments (TLS, conservative profile) start from config/customer-pilot.yaml and see Deployment.

2. Pre-flight and run​

chukei doctor --config chukei.yaml   # ✓ config ✓ upstream ✓ listen ✓ savings
chukei up --config chukei.yaml

3. Point a client at it​

import snowflake.connector
conn = snowflake.connector.connect(
    user=..., password=..., account="abc12345.eu-west-2.aws",
    host="127.0.0.1", port=8443, protocol="http",   # ← the only change
)

4. See it work​

# run any deterministic SELECT twice — the second is a cache hit
curl -s localhost:9090/metrics | grep chukei_queries_total
chukei savings --config chukei.yaml --since 24h

The savings report prices every avoided execution conservatively (canonical wall-clock × warehouse credit rate × 0.7 under-claim factor) and says so in its methodology line. For an audit-grade artifact:

chukei evidence keygen --out signing.key
chukei savings --config chukei.yaml --since 24h --evidence savings.evidence.json
chukei evidence verify --file savings.evidence.json