All commands and options¶
Every tycoon command on one scrollable page, with every flag. For worked examples and rationale, follow the per-command page link in each section header.
Conventions
[OPTIONS]brackets mark optional flags<NAME>(angle brackets) mark required values- Every command supports
-h/--help
Project¶
tycoon init¶
tycoon init [OPTIONS]
Options:
-t, --template TEXT Template to scaffold from (csv-import,
nyc-transit)
-n, --name TEXT Project name (default: current directory name)
--list-templates List available templates and exit
-p, --param TEXT Template parameter in 'name=value' form (repeatable)
--upgrade Migrate tycoon.yml to the current schema version
and exit
tycoon register dbt¶
tycoon register dbt [OPTIONS] SOURCE
Arguments:
SOURCE Local path or GitHub URL of the dbt project
Options:
--profiles-dir PATH Directory containing profiles.yml
(default: <SOURCE>/profiles.yml, then ~/.dbt/profiles.yml)
--profile NAME Profile name within profiles.yml
(default: dbt_project.yml's `profile:` field)
--target NAME Target within the profile (default: profile's `target:`, then 'dev')
--no-attach-metadata Skip wiring `.tycoon/metadata.duckdb` as `tycoon_meta`
into the registered profile
tycoon register rill¶
tycoon register rill [OPTIONS] SOURCE
Arguments:
SOURCE Local path or GitHub URL of the Rill project
tycoon register warehouse¶
tycoon register warehouse [OPTIONS]
Options:
--type TEXT duckdb / motherduck (or local / cloud / md aliases)
--path TEXT For --type duckdb: local file path
(default: data/warehouse.duckdb)
--catalog TEXT For --type motherduck: catalog name (becomes md:<NAME>)
--no-prompt Fail rather than prompt — for CI
--force Overwrite an existing warehouse without prompting
tycoon doctor¶
No flags. Runs every check and prints one panel per check.
tycoon docs serve¶
tycoon docs serve [OPTIONS]
Options:
-p, --port INTEGER Port (default: 8000)
--host TEXT Bind interface (default: 127.0.0.1)
--no-open Don't try to open a browser
tycoon docs build¶
Data pipeline¶
tycoon data sources catalog¶
No flags. Prints the catalog of available source types.
tycoon data sources add¶
tycoon data sources add [SOURCE_TYPE]
Arguments:
[SOURCE_TYPE] Source type — run 'tycoon data sources catalog'
to see all options. Prompts if not passed.
tycoon data sources list¶
tycoon data sources show¶
tycoon data sources explore¶
tycoon data sources explore [OPTIONS] [source_name]
Options:
-n, --sample <int range> Number of sample rows to show. [default: 10;
x>=1]
List all sources with metadata, or inspect one source's schema, sample rows, and run history.
tycoon data layers¶
The layered architecture with the vendor of every object, and each dbt model's latest status and last successful build.
tycoon data sources run¶
tycoon data sources run [SOURCE_NAME] [OPTIONS]
Arguments:
[SOURCE_NAME] Source to run (default: all)
Options:
--max-records INTEGER Cap rows per resource (cheap test runs)
tycoon data sources migrate¶
tycoon data sources remove¶
tycoon data transform run¶
tycoon data transform run [OPTIONS]
Options:
-t, --target TEXT dbt target (default: tycoon.yml's dbt_target, then 'dev')
-s, --select TEXT dbt model selection (e.g. 'staging+', 'tag:nightly')
--full-refresh Drop and recreate incremental models
tycoon data transform test¶
tycoon data transform build¶
tycoon data transform docs¶
tycoon data transform docs [OPTIONS]
Options:
-t, --target TEXT
--port INTEGER Port for dbt docs serve (default: 8081)
tycoon data sync¶
tycoon data sync [OPTIONS]
Options:
--from TEXT Source URL (repeatable). md:<catalog> or local .duckdb
--to PATH Destination DuckDB file (default: tycoon.yml's sync.to)
--schema TEXT Filter to one schema (applied to every --from source)
--tables TEXT Glob filter for table names (e.g. 'mart.*,dim_*')
--mode TEXT replace (default) | append | skip-existing
tycoon data query¶
tycoon data query SQL [OPTIONS]
Arguments:
SQL SQL query (read-only by default)
Options:
--db PATH Override which DuckDB to query (default: warehouse)
--source NAME Query a source's raw schema
-f, --format FORMAT table (default), csv, json or markdown
--allow-writes On MotherDuck, run statements other than read-only queries
tycoon data schema¶
tycoon data schema [OPTIONS]
Options:
--schema TEXT Only show schemas matching this name or glob
--raw Only show the raw database
--warehouse Only show the warehouse
--include-dlt Also show dlt's _dlt_* bookkeeping tables
--exact Count rows exactly on MotherDuck instead of estimating
tycoon data clean¶
tycoon data clean [OPTIONS]
Options:
--all Also remove rill/tmp, dbt target/, dbt_packages/, logs/
--metadata Remove .tycoon/metadata.duckdb
(preserved by default, even with --all)
tycoon data history¶
tycoon data history [OPTIONS]
Options:
--tool TEXT Filter to dlt or dbt (default: both)
--limit INTEGER Number of recent runs (default: 10)
tycoon data history show¶
tycoon data status¶
No flags. Per-source freshness, row counts, and capture history.
tycoon data analyze¶
tycoon data analyze SOURCE [OPTIONS]
Arguments:
SOURCE Name of a registered source
Options:
--no-dbt Don't generate dbt staging models
--rill Also generate Rill source / metrics_view / dashboard YAMLs
tycoon data run-all¶
tycoon data run-all [OPTIONS]
Options:
--max-records INTEGER Cap rows per source
--skip-dbt Don't run dbt build after ingest
--skip-on-error Continue past failed sources
tycoon data observability scaffold¶
tycoon data observability scaffold [OPTIONS]
Options:
--no-attach Skip the profiles.yml ATTACH wiring
--no-models Skip the staging-model generation
Generates dbt_project/models/_tycoon/ (nine stg_tycoon__* views + dim_runs mart) and ATTACHes .tycoon/metadata.duckdb as tycoon_meta in the dbt profile. Idempotent.
Services¶
tycoon start¶
tycoon start [OPTIONS]
Options:
--skip TEXT Server(s) to skip. Repeatable: --skip rill
--only TEXT Only start these server(s): rill, quack. Repeatable.
Starts the Rill dashboards (port 9009) and the Quack warehouse server (port 9494).
tycoon stop¶
tycoon stop [SERVICES]...
Arguments:
[SERVICES]... Specific server(s) to stop. Defaults to all
(rill, quack).
tycoon city¶
tycoon city [OPTIONS]
Options:
--path TEXT Project directory, DuckDB file, or md: catalog to
render (default: this project).
--port INTEGER Port to serve on. [default: 8000]
--host TEXT Interface to bind. [default: 127.0.0.1]
--theme TEXT Visual theme to render with. [default: default]
--dist PATH Built web bundle directory (defaults to the one
shipped with tycoon).
--pricing PATH TOML file declaring the compute rate the budget
block is billed at.
The renderer ships with tycoon; there is nothing extra to install.
Fire & Response¶
tycoon fire¶
tycoon fire [OPTIONS]
Options:
-r, --run <str> Show failing tests in one run. Takes a run id (or prefix)
from tycoon data history or from this command.
Failing tests, each counted by its newest result across captured runs: the
buildings on fire in the 3D city. Models that failed to build are not fires;
when there are any, the output says how many and points at tycoon data
history.
tycoon firehouse¶
Fire trucks on duty, one per failing test, counted the same way as
tycoon fire.
Tools¶
tycoon run¶
tycoon run TOOL [TOOL_ARGS...]
Tools:
dlt The dlt CLI
dbt The dbt CLI
rill The Rill CLI
duckdb The DuckDB CLI (when installed externally)
All arguments after TOOL are forwarded verbatim. tycoon does not interpret them.
Top-level¶
tycoon --version¶
Print version and exit.
tycoon -h / --help¶
Show help. Works at every level: