Environment variables¶
Every environment variable tycoon reads or recommends. Set them in your shell, in a .env file, or via your CI's secret-injection.
Used by tycoon¶
MOTHERDUCK_TOKEN¶
MotherDuck access token. Read by tycoon doctor and passed through to dlt / dbt / DuckDB when they ATTACH md: URLs.
Get one at app.motherduck.com/token.
OAuth is also recognized — run motherduck connect once to cache a session token under ~/.duckdb/. tycoon doctor accepts either.
DLT_*¶
Tycoon does not consume DLT's environment variables directly, but they're respected by dlt itself when tycoon data sources run invokes it. The most common:
DLT_HOME_DIR— override~/.dltDLT_DATA_DIR: where dlt keeps pipeline working directories, as$DLT_DATA_DIR/pipelines/<pipeline>. Tycoon sets it to<project>/.tycoon/dltfor the length of atycoon data sources run, so each project keeps its own incremental state (see where dlt keeps pipeline state). If you set it yourself, tycoon uses your value instead, and every project that shares it shares state for same-named sources.
If you set these, they should be in scope for both interactive shells and any cron / CI environment that runs tycoon data sources run.
FORCE_COLOR / NO_COLOR¶
Standard environment variables for forcing or disabling Rich's color output. Tycoon respects both.
Used by source configs (interpolated into tycoon.yml)¶
tycoon.yml supports ${VAR} interpolation in any string. Common patterns:
GITHUB_TOKEN¶
Used by the github source type:
Set in your shell:
tycoon data sources run github warns loudly if the token is unset:
WARN Config key 'access_token' contains an unexpanded env var: ${GITHUB_TOKEN}
Set it with: export GITHUB_TOKEN=<your-value>
STRIPE_API_KEY, SLACK_BOT_TOKEN, etc.¶
Catalog source types each declare their own env-var conventions. The names follow each tool's own:
| Source | Recommended env var |
|---|---|
stripe |
STRIPE_API_KEY |
slack |
SLACK_BOT_TOKEN |
notion |
NOTION_API_KEY |
hubspot |
HUBSPOT_ACCESS_TOKEN |
tycoon data sources add <type> prompts for the env-var name interactively when you register the source.
Custom REST APIs¶
For rest_api sources, set whatever name fits:
sources:
my_api:
type: rest_api
config:
base_url: https://api.example.com/v1
auth_header: "Bearer ${MY_API_TOKEN}"
Used by CI¶
For GitHub Actions, store any of the above as repo secrets and inject:
Tycoon's own CI workflows (.github/workflows/ci.yml, .github/workflows/e2e.yml) demonstrate the pattern.
Used by tests¶
The e2e pytest marker requires network access. Tests live under
tests/test_templates_e2e.py; tests that need credentials
pytest.skip() when the relevant env var is absent.
Not consulted by tycoon¶
For clarity, these aren't read or set by tycoon:
DBT_PROFILES_DIR— dbt's own. tycoon passes--profiles-direxplicitly when needed (seetycoon register dbt).DUCKDB_*— none.
Related¶
- Reference: tycoon.yml — where
${VAR}interpolation happens tycoon doctor— the source of truth for "did this env var get picked up?"