Skip to content

Commands

Every command tycoon ships, organized by section. Click into any command for full reference. For a flat command-by-command index with every flag listed, see Reference: All commands.

Project

Command What it does
tycoon init Scaffold a new project (wizard or --template <name>).
tycoon register dbt Attach an existing dbt project; --profiles-dir, --profile, --target persist into tycoon.yml.
tycoon register rill Attach an existing Rill project.
tycoon register warehouse Switch warehouse (DuckDB / MotherDuck); --type, --path, --catalog, --no-prompt, --force for scripted use.
tycoon doctor Cross-component health check (dbt, warehouse, observability).
tycoon docs serve Build + serve this docs site locally with hot reload.
tycoon docs build One-shot build into site/.

Data pipeline

Command What it does
tycoon data sources catalog Browse available source types.
tycoon data sources add Register a new source interactively.
tycoon data sources list / show List registered sources / inspect one.
tycoon data sources run [name] Ingest one source. Auto-scaffolds dbt staging models when no models reference the source yet (opt out with --no-scaffold or project-wide transform.auto_scaffold: false).
tycoon data sources run-all Ingest every registered source sequentially.
tycoon data sources migrate <type> Copy a catalog source from the shared ~/.tycoon/sources/ into the project's own sources dir.
tycoon data sources remove <name> Remove a registered source.
tycoon data transform run / test / build dbt run / test / build against the project's persisted profile + target.
tycoon data transform docs dbt docs generate then serve.
tycoon data sync Cloud → local DuckDB snapshots; replace / append / skip-existing modes.
tycoon data query Read-only SQL against the warehouse.
tycoon data schema Dump tables, row counts, file sizes.
tycoon data clean Remove warehouse files (preserves observability metadata by default).
tycoon data history Recent dlt + dbt run history captured in .tycoon/metadata.duckdb.
tycoon data history show <id> Drill into one run.
tycoon data status Source freshness, last sync time, row counts.
tycoon data analyze [source] Auto-scaffold dbt staging models from a source's dlt schema. Sentinel-protected (@generated by tycoon analyze); --force to clobber hand-edits, --all to iterate every registered source. Auto-triggers after data sources run by default.
tycoon data observability scaffold Retrofit the _tycoon staging views + metadata-DB ATTACH onto an existing dbt project. Idempotent.
tycoon data run-all Ingest all sources, then dbt build. The full-pipeline shortcut.
tycoon data layers The layered architecture layer by layer, with the vendor of every object (dlt / Fivetran / dbt) and each model's latest status and last successful build.
tycoon data sources explore Inspect a source's schema, sample rows, and run history.

Fire & Response

Command What it does
tycoon fire Failing tests, the buildings on fire in the city. Points at data history when models failed to build.
tycoon firehouse Fire trucks on duty: one per failing test.

Services

Command What it does
tycoon start Start the Rill dashboards and the Quack warehouse server.
tycoon start --only <svc> Start one specific service.
tycoon stop Stop all services started by tycoon start.
tycoon city Serve the catalog as an interactive 3D city in the browser.

Tool passthrough

Command What it does
tycoon run dlt ... Pass through to dlt CLI.
tycoon run dbt ... Pass through to dbt CLI.
tycoon run rill ... Pass through to Rill CLI.

Help anywhere

Every command supports --help (or the -h short alias):

tycoon data sync --help
tycoon register dbt -h
tycoon doctor --help