Command line

Run every command from the repository root with the project's interpreter: .venv/bin/python -m dpf COMMAND. On a server, run it as the service account with the service's environment loaded — see Deploy. python -m dpf --version prints the version and the build.

This page is generated from the command line's own parser, so it lists exactly what the installed version accepts.

Command	What it does
demo	run the worked example end to end
showcase	the insurer warehouse, and four products mid-flight
connect	try the configured warehouse and report what it found
load	build the warehouse and register its sources
profile	re-profile every registered source
status	what is live, and what is in flight
roles	the registered agent versions
reset	delete all local state
mcp	serve the ontology over MCP on stdio
user	add a person by email, or issue a sign-in link
token	issue, list or revoke a read-only API token
catalog	the data catalog: search it, or sync from it
export	write every document to a folder of markdown
workflow	show the configured process, or check a file
trace	the traceability matrix for what is live
flags	detect drift, and show the board
quality	the agreement's checks, as Databricks-native artefacts
contract	print a published contract as JSON
serve	run the web interface
release	cut a version: VERSION, the changelog, the tag
docs	the documentation: regenerate, check, or stamp a page

dpf demo

run the worked example end to end.

python -m dpf demo [--quick] [--keep]

Argument	What it does
--quick	stop after the first release
--keep	do not wipe existing state first

dpf showcase

the insurer warehouse, and four products mid-flight.

python -m dpf showcase [--keep]

Argument	What it does
--keep	keep existing products instead of tidying them away

dpf connect

try the configured warehouse and report what it found.

python -m dpf connect

dpf load

build the warehouse and register its sources.

python -m dpf load

dpf profile

re-profile every registered source.

python -m dpf profile

dpf status

what is live, and what is in flight.

python -m dpf status

dpf roles

the registered agent versions.

python -m dpf roles

dpf reset

delete all local state.

python -m dpf reset

dpf mcp

serve the ontology over MCP on stdio.

python -m dpf mcp

dpf user

add a person by email, or issue a sign-in link.

python -m dpf user ACTION EMAIL [--name NAME] [--role ROLE]

Argument	What it does
action	One of add, invite.
email
--name	with add: the person's name
--role	with add: admin, use_case, source_system or data_hub Default data_hub.

dpf token

issue, list or revoke a read-only API token.

python -m dpf token ACTION NAME [--note NOTE]

Argument	What it does
action	One of create, list, revoke.
name	what the token is for: jira-intake, ci, claude-desktop Optional.
--note	with create: one line about who holds it

dpf catalog

the data catalog: search it, or sync from it.

python -m dpf catalog ACTION QUERY [--apply]

Argument	What it does
action	One of status, search, sync. Optional.
query	Optional.
--apply	with sync: write the changes, rather than only showing them

dpf export

write every document to a folder of markdown.

python -m dpf export PRODUCT [--to TO]

Argument	What it does
product	Optional.
--to	where to write (default: exports/)

dpf workflow

show the configured process, or check a file.

python -m dpf workflow FILE

Argument	What it does
file	a workflow YAML to validate instead of the shipped one Optional.

dpf trace

the traceability matrix for what is live.

python -m dpf trace PRODUCT

Argument	What it does
product	Optional.

dpf flags

detect drift, and show the board.

python -m dpf flags PRODUCT [--all] [--accept FINGERPRINT] [--reason REASON]

Argument	What it does
product	Optional.
--all	include resolved flags too
--accept	accept a flag: the condition stands and you are shipping anyway
--reason	required with --accept

dpf quality

the agreement's checks, as Databricks-native artefacts.

python -m dpf quality PRODUCT [--target TARGET] [--environment ENVIRONMENT] [--on-error ON_ERROR] [--push] [--check]

Argument	What it does
product	Optional.
--target	which artefact to generate (default: constraints) One of constraints, dlt, monitor. Default constraints.
--environment	the schema the table lives in (default: prod) Default prod.
--on-error	with --target dlt: what a failing row does One of fail, drop. Default fail.
--push	apply the constraint set to the Databricks table
--check	read back what the table enforces, and report drift

dpf contract

print a published contract as JSON.

python -m dpf contract PRODUCT [--full]

Argument	What it does
product	Optional.
--full	include the internal mapping

dpf serve

run the web interface.

python -m dpf serve [--port PORT]

Argument	What it does
--port	defaults to $PORT, then 8200

dpf release

cut a version: VERSION, the changelog, the tag.

python -m dpf release PART

Argument	What it does
part	major, minor or patch — or an exact MAJOR.MINOR.PATCH

dpf docs

the documentation: regenerate, check, or stamp a page.

python -m dpf docs ACTION PAGES

Argument	What it does
action	build: regenerate the generated sections; check: everything the test suite checks; stamp: mark pages reviewed One of build, check, stamp.
pages	with stamp: the pages you reviewed, e.g. how-to/deploy Optional.