Command reference

Which dlake command does what?

dlake groups its commands by job. Each group below says what it is for in plain words, lists the commands, and shows one example. For the full chapter from the product help, see Command-Line Interface; dlake --help and dlake <command> --help are always authoritative for the version you have installed (v0.5.49 is current).

Onboarding

In plain wordsCreate your own Data Lake from the terminal, no browser needed, and finish the setup wizard.

dlake register start
dlake register status [--watch]
dlake register resend
dlake register login --email <e>
dlake register erpssince 0.5.32
dlake registration oauth --crm <name>
dlake registration pin --crm <name>since 0.5.44
dlake registration oauth --erp QBOnline --field environment=sandbox|productionsince 0.5.47
dlake registration action --crm <name> --action <name>
dlake registration products list|add|remove|request-installsince 0.5.34
dlake registration products allow-sync-agent on|off

$ dlake register status --watch

Auth & profiles

In plain wordsSign in once per tenant and keep customers apart with named profiles.

dlake login --domain <slug> [--profile NAME]
dlake logout
dlake profiles list
dlake profiles remove <name>
dlake --profile <name> (on every command)
dlake DLAKE_PROFILE / DLAKE_API_KEY env vars

$ DLAKE_API_KEY=dlk_... dlake login --domain acme --profile acme

Everyday data

In plain wordsAsk questions of your data, pull files out, and check that everything is healthy.

dlake query "<sql>"
dlake export <table> --format csv|parquet -o <file>
dlake entities list
dlake status
dlake watch [--once] [--webhook URL] [--log FILE]since 0.5.33

$ dlake query "SELECT TOP 10 * FROM DLO.account" --profile acme --json

API keys & projects

In plain wordsHand out access to apps and people, and take it back again.

dlake keys list [--project P]
dlake keys create --name N [--expires-days D]
dlake keys extend <id> --days D
dlake keys revoke <id> | restore <id>
dlake keys move <id> --project P
dlake projects list

$ dlake keys create --name ci-reader --profile acme

Admin control plane

In plain wordsBuild and run the platform: tables, views, procedures, exposure, keys, DAB restarts, RLS, events, the registration wizard and every sync product. Each tool documents its own arguments.

dlake admin list
dlake admin <tool> --help
dlake admin <tool> [--arg value ...]
dlake admin create_table / add_column / create_index / describe_table
dlake admin set_entity_exposure / list_exposed_entities / restart_dab --confirm true
dlake admin create_api_key --keyName N --expirationDays D --scope @scope.json

$ dlake admin create_table --tableName Invoice --columns @columns.json --primaryKey Id

Data plane

In plain wordsRead and write rows exactly as an AI agent would through MCP: records, queries, aggregates, exports, ingest and time travel.

dlake tool list
dlake tool <tool> --help
dlake tool read_records / create_record / execute_entity
dlake tool query / aggregate / export_table / export_query
dlake tool ingest_table
dlake tool get_active_schema

$ dlake tool read_records --entity pizza_menu_items --profile acme

Documentation & agent skills

In plain wordsRead the guides from the terminal and install the agent skill summaries; whitelisted customers fetch the operational skills from the admin plane.

dlake guide api | guide help [--section <name>] | guide cli
dlake skills list
dlake skills install [--dir D] [--skip-existing]
dlake skills show <name>
dlake admin get_skill <name> | admin list_skills

$ dlake skills install

Commercient SYNC products

In plain wordsOperate the sync products that move data between your ERP, your CRM and the lake, without opening the portal.

dlake crmpro processes|process|status|enable|disable|history|errors|connections|mapping|logsince 0.5.9 / log 0.5.34
dlake normalsync tables|selected|readiness|select|enable|disable|filter|catalog|add|resync|resync-statussince 0.5.16 / resync 0.5.24
dlake txdownloaderpro errors|transactions|transactionsince 0.5.34
dlake admin odbcsync_* (8 tools)
dlake admin apisync_* (6 tools)
dlake admin crmpro_* / normalsync_* / txdownloaderpro_* (full tool sets)

$ dlake normalsync readiness --profile acme

Object storage, documents & views

In plain wordsLink S3 buckets, upload and download files, export tables straight into a bucket, attach parquet and CSV as queryable tables, manage documents and SQL views.

dlake s3 connections list|add|test|remove
dlake s3 ls|put|get|rm <connection> ...
dlake s3 export <connection> <entity> --format csv|parquet
dlake s3 attach|detach|discover|attached <connection> ...
dlake docs upload|list|search|get|update|rm|restore
dlake view list|show|create|alter|drop

$ dlake s3 export sales account --format parquet --profile acme

Backups, database storage & row history

In plain wordsMake and download restorable backups of your schema, see what space your database files hold and release what is free, and decide how long row-change history is kept.

dlake backup runsince 0.5.43
dlake backup listsince 0.5.43
dlake backup show <id>since 0.5.43
dlake backup download <id> [--format native|portable] --out <folder>since 0.5.43
dlake backup scope-tablessince 0.5.43
dlake backup settings [--enabled] [--schedule] [--include-sync-tables] [--format] [--tables ...]since 0.5.43
dlake storage showsince 0.5.42
dlake storage sweep [--shrink]since 0.5.42
dlake storage shrink-enabled on|offsince 0.5.42
dlake audit retention show|set <days>since 0.5.42
dlake audit purge [--run]since 0.5.42
dlake setup export-spec --out <file>

$ dlake backup run --profile acme

Conventions that apply to every command

--json: Machine-readable output on every command. Human tables are the default.
Exit codes: 0 ok · 1 error · 2 usage · 3 permission or auth denied. Branch on them in scripts and CI.
--profile <name>: Names the tenant on every command (no default profile since 0.5.7). Set DLAKE_PROFILE once per shell session instead.
@file.json: Read any argument from a file. The reliable form on Windows, where quoted JSON is mangled by the shell. @@ passes a literal leading @.
JSON arguments: A value starting with [ or { is sent as JSON; a plain comma list still works for arrays of scalars.
--confirm true: Required by destructive tools such as restart_dab and drop_table; the command stops before doing anything if it is missing.
--help everywhere: Every command prints its help without a profile. For dlake admin <tool> --help and dlake tool <tool> --help, the tool's live argument schema comes from the MCP host, so it is shown when a profile is given; without one you get the generic help for the verb.
--field Name=Value: On dlake admin, a tool with a single object argument (such as a wizard step's fields) takes a repeated --field, each setting one value over the --fields JSON. Name=@path reads the value from a file. In PowerShell, quote @file values: a bare leading @ is the splatting operator.
Secrets: Prefer DLAKE_API_KEY or --api-key-stdin over --api-key on the command line, which leaks to shell history. Passwords are prompted hidden or piped with --password-stdin; a plain --password flag is refused.

Going deeper

The full CLI chapter

Every command with its flags and output, as published in the product help: install, register, profiles, both tool planes, the sync products, object storage, views and scripting.

Setup & configuration

How keys and profiles work, what a scoped key can do, the build sequence that publishes an API, environment variables and exit codes.

Skills for AI agents

20 capability summaries, one per Commercient integration: what it does for the business and how to get its operating guide.

From the terminal

dlake --help and dlake <command> --help are authoritative for the version you have installed. dlake guide cli prints the whole reference, and every admin or data tool documents its own arguments.