Skip to content

Latest commit

 

History

History
2273 lines (1490 loc) · 90.7 KB

cli.md

File metadata and controls

2273 lines (1490 loc) · 90.7 KB

CLI reference

Generated by scripts/generate_reference_docs.py. Do not edit this page directly.

This page lists all 195 installed command paths. The generator reads the Click contract without running a command.

Run python scripts/generate_reference_docs.py to regenerate this page and generated/cli.json.

phlo

Phlo - Modern Data Lakehouse Framework

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
version option --version boolean false false flag
quiet option --quiet boolean false false flag
no_color option --no-color boolean false false flag
json option --json boolean false false flag
non_interactive option --non-interactive boolean false false flag

phlo airbyte

Interact with the Airbyte control plane (status, connections, sync).

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
airbyte_args argument none text false Sentinel.UNSET nargs=-1

phlo alerts

Alert management and configuration.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo alerts list

List configured alert destinations.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo alerts status

Check alert system status.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo alerts test

Send a test alert to configured destinations.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
severity option --severity choice false warning choices: info, warning, error, critical
destination option --destination text false none none

phlo audit

Inspect local Phlo audit records.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo audit query

Query audit records.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
operation option --operation text false Sentinel.UNSET none
since option --since text false Sentinel.UNSET none
output_json option --json boolean false false flag

phlo audit tail

Tail recent audit records.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
limit option --limit integer false 20 none
since option --since text false Sentinel.UNSET none
output_json option --json boolean false false flag

phlo authz

Manage RBAC authorization policies and backend synchronization.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo authz identity

Inspect roles and assign members using an existing administrator session.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
api_url option --api-url text true Sentinel.UNSET none
token option --token text false Sentinel.UNSET env: PHLO_AUTHZ_TOKEN

phlo authz identity assign

Review and sign a member's complete role set, preserving identity metadata.

Capabilities: json=false, dry_run=false, confirmation_flag=true

Name Kind Options Type Required Default Other
subject argument none text true Sentinel.UNSET none
role_names option --role text false Sentinel.UNSET multiple
expected_version option --expected-version integer range false none none
justification option --justification text false none none
operation_id option --operation-id text false none none
yes option --yes boolean false false flag

phlo authz identity members

List installation-wide managed assignments and current versions.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo authz identity permissions

Evaluate your session for a resource identity with no resource attributes.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
action argument none text true Sentinel.UNSET none
resource_type argument none text true Sentinel.UNSET none
resource_id argument none text true Sentinel.UNSET none
environment option --environment text false none none

phlo authz identity roles

List supported assignments and candidate policy rules, not guaranteed grants.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo authz plan

Create a sync plan without applying changes.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
path option --path directory false none none
backend option --backend text false Sentinel.UNSET multiple
environment option --environment text false development none

phlo authz revert

Revert previously applied policy changes.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
revert_ids argument none text true Sentinel.UNSET nargs=-1
path option --path directory false none none
backend option --backend text false Sentinel.UNSET multiple
environment option --environment text false development none

phlo authz sync

Synchronize RBAC policies to backend-native enforcement.

Capabilities: json=false, dry_run=true, confirmation_flag=false

Name Kind Options Type Required Default Other
path option --path directory false none none
backend option --backend text false Sentinel.UNSET multiple
environment option --environment text false development none
dry_run option --dry-run boolean false false flag

phlo authz validate

Validate RBAC configuration files.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
path option --path directory false none none

phlo authz verify

Verify backend state matches desired RBAC state.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
path option --path directory false none none
backend option --backend text false Sentinel.UNSET multiple
environment option --environment text false development none

phlo backfill

Run asset materialization across a date range with parallel execution.

Capabilities: json=true, dry_run=true, confirmation_flag=false

Name Kind Options Type Required Default Other
asset_name argument none text false Sentinel.UNSET none
start_date option --start-date text false Sentinel.UNSET none
end_date option --end-date text false Sentinel.UNSET none
partitions option --partitions text false Sentinel.UNSET none
parallel option --parallel integer false 1 none
resume option --resume boolean false false flag
dry_run option --dry-run boolean false false flag
delay option --delay float false 0.0 none
output_json option --json boolean false false flag
environment option --environment text false Sentinel.UNSET none

phlo branch

Manage Nessie branches for data versioning.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo branch create

Create a new branch.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
branch_name argument none text true Sentinel.UNSET none
from_ref option --from text false main none

phlo branch delete

Delete a branch.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
branch_name argument none text true Sentinel.UNSET none
force option --force boolean false false flag

phlo branch diff

Show differences between branches.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
source_branch argument none text true Sentinel.UNSET none
target_branch argument none text false main none
format option --format choice false table choices: table, json

phlo branch list

List all branches.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
all option --all boolean false false flag
format option --format choice false table choices: table, json

phlo branch merge

Merge source branch into target branch.

Capabilities: json=false, dry_run=true, confirmation_flag=false

Name Kind Options Type Required Default Other
source_branch argument none text true Sentinel.UNSET none
target_branch argument none text false main none
dry_run option --dry-run boolean false false flag
no_delete_source option --no-delete-source boolean false false flag

phlo catalog

Manage the lakehouse catalog (Nessie-backed).

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo catalog describe

Show detailed table metadata.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
table_name argument none text true Sentinel.UNSET none
ref option --ref text false main none

phlo catalog history

Show table snapshot history.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
table_name argument none text true Sentinel.UNSET none
limit option --limit integer false 10 none
ref option --ref text false main none
output_format option --format choice false table choices: table, json

phlo catalog tables

List all Iceberg tables in the catalog.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
namespace option --namespace text false none none
ref option --ref text false main none
output_format option --format choice false table choices: table, json

phlo clickhouse

Query and inspect the ClickHouse data plane service.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo clickhouse query

Execute a SQL query against the running ClickHouse service via clickhouse-client inside the container backend, printing results to stdout.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
query argument none text false Sentinel.UNSET none
query_file option --file file false Sentinel.UNSET none
output_format option --format text false TabSeparatedRaw none
timeout_seconds option --timeout integer false 30 none

phlo clickhouse status

Show ClickHouse service status: version, uptime, and current database.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo clickstack

Query and inspect the ClickStack service.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo clickstack query

Execute a ClickHouse query against the running ClickStack service.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
query argument none text false Sentinel.UNSET none
query_file option --file file false Sentinel.UNSET none
output_format option --format text false TabSeparatedRaw none
timeout_seconds option --timeout integer false 30 none

phlo commands

List installed commands and their output, preview, and confirmation options.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
path argument none text false Sentinel.UNSET nargs=-1
output_json option --json boolean false false flag

phlo compliance

Manage compliance features and evidence.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo compliance export-evidence

Export a compliance evidence pack.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
output option --output -o path true Sentinel.UNSET none
created_by option --created-by text true Sentinel.UNSET none
domain option --domain text false Sentinel.UNSET none
description option --description -d text false Sentinel.UNSET none
audit_records option --audit-records file false Sentinel.UNSET none
signatures option --signatures file false Sentinel.UNSET none
manifest option --manifest file false Sentinel.UNSET none

phlo compliance verify-evidence

Verify the integrity of an evidence pack.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
zip_path argument none path true Sentinel.UNSET none

phlo config

Manage infrastructure configuration.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
json option --json boolean false false flag
non_interactive option --non-interactive boolean false false flag

phlo config show

Show the effective infrastructure configuration.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
output_json option --json boolean false false flag
format option --format choice false yaml choices: yaml, json

phlo config upgrade

Upgrade phlo.yaml through ordered detect -> plan -> apply -> validate steps.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
force option --force boolean false false flag
plan_only option --plan-only boolean false false flag

phlo config validate

Validate infrastructure configuration in phlo.yaml.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
output_json option --json boolean false false flag

phlo contracts

Schema registry and data contract management.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo contracts check

Check schema compatibility for a table against its previous snapshot.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
table option --table text true Sentinel.UNSET none
fail_on option --fail-on choice false breaking choices: breaking, warning

phlo contracts snapshot

Snapshot a schema from a JSON file into the registry.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
table option --table text true Sentinel.UNSET none
schema_file option --schema-file file true Sentinel.UNSET none
run_id option --run-id text false none none
source option --source text false cli none

phlo dataset

Dataset workflow commands.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
json option --json boolean false false flag
non_interactive option --non-interactive boolean false false flag

phlo dataset list

List canonical projections for every governed table.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
store_mode option --store-mode choice false none choices: durable, memory
output_json option --json boolean false false flag

phlo dataset migrate-overlay

Plan, apply, or discard the legacy Observatory dataset workflow overlay.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
json option --json boolean false false flag
non_interactive option --non-interactive boolean false false flag

phlo dataset migrate-overlay apply

Import the planned overlay once, digest-confirmed and idempotent.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
source option --source file true Sentinel.UNSET none
plan_path option --plan file true Sentinel.UNSET none
digest option --digest text true Sentinel.UNSET none
store_mode option --store-mode choice false none choices: durable, memory
output_json option --json boolean false false flag

phlo dataset migrate-overlay discard

Explicitly discard the planned overlay import (audited; legacy file retained).

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
source option --source file true Sentinel.UNSET none
plan_path option --plan file true Sentinel.UNSET none
digest option --digest text true Sentinel.UNSET none
store_mode option --store-mode choice false none choices: durable, memory
output_json option --json boolean false false flag

phlo dataset migrate-overlay plan

Plan the overlay import without touching any store (read-only).

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
source option --source file true Sentinel.UNSET none
output option --output file false none none
output_json option --json boolean false false flag

phlo dataset show

Show the canonical Dataset projection for one Dataset ID.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
dataset_id argument none text true Sentinel.UNSET none
action option --action text false none none
store_mode option --store-mode choice false none choices: durable, memory
output_json option --json boolean false false flag

phlo dataset transition

Apply one authorized Dataset transition through the core service.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
dataset_id argument none text true Sentinel.UNSET none
action argument none choice true Sentinel.UNSET choices: claim, promote, publish, reject, retire, review
action_id option --action-id text false none none
expected_state option --expected-state text false none none
owner option --owner text false none none
store_mode option --store-mode choice false none choices: durable, memory
output_json option --json boolean false false flag

phlo dbt

Dbt commands (compile, run, test, publishing).

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo dbt compile

Compile dbt models in the local project.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
target option --target text false dev none
local option --local boolean false false flag

phlo dbt publishing

Manage publishing configuration.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo dbt publishing scaffold

Scaffold publishing.yaml from a dbt manifest.

Capabilities: json=false, dry_run=true, confirmation_flag=false

Name Kind Options Type Required Default Other
manifest option --manifest file false Sentinel.UNSET none
output option --output file false publishing.yaml none
select_patterns option --select text false ["mrt_*"] multiple
source_key option --source text false none none
physical_schema option --physical-schema text false marts none
physical_schema option --iceberg-schema text false Sentinel.UNSET none
logical_refs option --logical-refs --physical-tables boolean false true flag
group option --group text false publishing none
asset_name option --asset-name text false none none
dry_run option --dry-run boolean false false flag

phlo dbt run

Run dbt models in the local project.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
target option --target text false dev none
select_exprs option --select text false Sentinel.UNSET multiple
local option --local boolean false false flag

phlo dbt test

Run dbt tests in the local project.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
target option --target text false dev none
select_exprs option --select text false Sentinel.UNSET multiple
local option --local boolean false false flag

phlo dev

Start the Dagster development server for your workflows.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
host option --host text false 127.0.0.1 none
port option --port integer false 3000 none
workflows_path option --workflows-path text false workflows none

phlo doctor

Diagnose local Phlo setup and service health.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
output_json option --json boolean false false flag
verbose option --verbose boolean false false flag

phlo env

Manage environment configuration.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo env export

Export the generated environment configuration.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
include_secrets option --include-secrets boolean false false flag
output option --output file false Sentinel.UNSET none
_format option --format choice false dotenv choices: dotenv

phlo governance

Check and export governance readiness from Phlo declarations.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo governance check

Validate governed tables for publish and production readiness.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
output_json option --json boolean false false flag
modules option --module text false Sentinel.UNSET multiple

phlo governance export

Export the browser-safe governance read model.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
output_json option --json boolean false false flag
modules option --module text false Sentinel.UNSET multiple

phlo hasura

Hasura GraphQL metadata management CLI.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo hasura apply

Apply Hasura metadata from a previously exported JSON file, replacing the current metadata.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
input option --input path true Sentinel.UNSET none

phlo hasura auto-setup

Run track, relationships, and permissions in sequence — one-command setup for a new schema.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
schema option --schema text false api none
verbose option -v --verbose boolean false false flag

phlo hasura export

Export the complete Hasura metadata (tracked tables, relationships, permissions) to a JSON file.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
output option --output path true Sentinel.UNSET none

phlo hasura permissions

Create default SELECT permissions for standard roles (anon, analyst, admin) on all tracked tables in the schema.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
schema option --schema text false api none
verbose option -v --verbose boolean false false flag

phlo hasura relationships

Analyze foreign key constraints in the schema and create object relationships (many-to-one) in Hasura metadata.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
schema option --schema text false api none
verbose option -v --verbose boolean false false flag

phlo hasura status

Show a summary of all tracked tables organized by schema, reflecting the current Hasura metadata.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo hasura sync-permissions

Apply permission configurations from a YAML or JSON config file that defines tables, roles, and their SELECT/INSERT/UPDATE/DELETE grants.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
config option --config path true Sentinel.UNSET none

phlo hasura track

Auto-discover and track tables in Hasura, optionally excluding specific tables, and print a summary of tracked tables.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
schema option --schema text false api none
exclude option --exclude text false Sentinel.UNSET multiple
verbose option -v --verbose boolean false false flag

phlo init

Initialize a new Phlo project.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
project_name argument none text false Sentinel.UNSET none
template option --template text false minimal none
force option --force boolean false false flag
list_templates option --list-templates boolean false false flag
output_json option --json boolean false false flag

phlo kafka

Interact with the Kafka broker (status, topics).

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
kafka_args argument none text false Sentinel.UNSET nargs=-1

phlo lineage

Asset dependency and lineage visualization commands.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo lineage column

Column-level lineage commands.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo lineage column downstream

Show downstream column lineage for an asset.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
asset argument none text true Sentinel.UNSET none
column option --column text false none none

phlo lineage column import-dbt

Import column lineage from a dbt manifest.json file.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
manifest option --manifest file true Sentinel.UNSET none

phlo lineage column upstream

Show upstream column lineage for an asset.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
asset argument none text true Sentinel.UNSET none
column option --column text false none none

phlo lineage export

Export lineage to external visualization formats.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
asset_name argument none text true Sentinel.UNSET none
format option --format choice false dot choices: dot, mermaid, json
output option --output Path true Sentinel.UNSET none

phlo lineage impact

Analyze downstream impact of an asset.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
asset_name argument none text true Sentinel.UNSET none

phlo lineage show

Display asset dependencies in ASCII tree format.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
asset_name argument none text true Sentinel.UNSET none
direction option --direction choice false both choices: upstream, downstream, both
depth option --depth integer false none none

phlo lineage status

Show lineage graph status and statistics.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo logs

View logs from Phlo infrastructure services.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
services argument none text false Sentinel.UNSET nargs=-1
service_options option -s --service --package text false Sentinel.UNSET multiple
follow option -f --follow boolean false false flag
tail option -n --tail --lines integer range false 100 none
since option --since text false Sentinel.UNSET none
until option --until text false Sentinel.UNSET none
timestamps option --timestamps boolean false false flag
no_color option --no-color boolean false false flag
backend_name option --backend choice false none choices: docker, podman, auto

phlo materialize

Materialize Dagster assets via the configured container backend.

Capabilities: json=true, dry_run=true, confirmation_flag=false

Name Kind Options Type Required Default Other
asset_name argument none text false Sentinel.UNSET none
partition option -p --partition text false Sentinel.UNSET none
no_default_partition option --no-default-partition boolean false false flag
select option --select text false Sentinel.UNSET none
no_contract_refresh option --no-contract-refresh boolean false false flag
dry_run option --dry-run boolean false false flag
output_json option --json boolean false false flag
environment option --environment text false Sentinel.UNSET none

phlo mcp

Run and inspect the Phlo MCP server.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo mcp config

Print resolved MCP configuration with secrets redacted.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
output_json option --json boolean false false flag

phlo mcp install

Print or write an MCP client configuration snippet.

Capabilities: json=true, dry_run=true, confirmation_flag=false

Name Kind Options Type Required Default Other
client argument none choice true Sentinel.UNSET choices: claude-code, amp, cursor, vscode
dry_run option --dry-run boolean false false flag
output_json option --json boolean false false flag

phlo mcp prompts

List prompts registered by the local MCP server.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
output_json option --json boolean false false flag

phlo mcp serve

Serve the Phlo MCP server.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
transport option --transport choice false Sentinel.UNSET choices: stdio, streamable-http
api_base_url option --api-base-url text false Sentinel.UNSET none
api_token option --api-token text false Sentinel.UNSET none
enable_write_tools option --enable-write-tools boolean false false flag
host option --host text false Sentinel.UNSET none
port option --port integer false Sentinel.UNSET none
streamable_http_path option --path text false Sentinel.UNSET none

phlo mcp tools

List tools registered by the local MCP server.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
output_json option --json boolean false false flag

phlo metrics

Pipeline and data metrics exposure.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo metrics asset

Show per-asset metrics.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
asset_name argument none text true Sentinel.UNSET none
runs option --runs integer false 10 none
output_json option --json boolean false false flag

phlo metrics export

Export metrics to JSON, CSV, or Prometheus text.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
export_format option --format choice false json choices: json, csv, prometheus
output option --output Path true Sentinel.UNSET none
period option --period text false 24h none
output_json option --json boolean false false flag

phlo metrics summary

Show key metrics overview.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
period option --period text false 24h none
output_json option --json boolean false false flag

phlo migrate

Data migration commands.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo migrate decorators-2026-05

Migrate May 2026 decorator APIs.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
path argument none path true Sentinel.UNSET none
check option --check boolean false false flag
write option --write boolean false false flag
show_diff option --diff boolean false false flag

phlo migrate list

List available migration spec files.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
directory option --directory directory false none none

phlo migrate run

Execute a migration spec.

Capabilities: json=false, dry_run=true, confirmation_flag=false

Name Kind Options Type Required Default Other
spec_file argument none file true Sentinel.UNSET none
dry_run option --dry-run boolean false false flag
fmt option --format choice false table choices: table, json

phlo migrate status

Show recent migration history.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
limit option --limit integer false 10 none
fmt option --format choice false table choices: table, json

phlo migrate validate

Validate a migration spec without executing.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
spec_file argument none file true Sentinel.UNSET none

phlo minio

Run MinIO client (mc) commands inside the project service container.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
mc_args argument none text false Sentinel.UNSET nargs=-1

phlo openmetadata

Manage OpenMetadata integration (optional): check health and sync catalog tables and dbt documentation.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo openmetadata health

Check OpenMetadata connectivity using configured credentials; exits 1 when the server is unreachable.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo openmetadata sync

Sync Nessie catalog tables (and optionally dbt docs) into OpenMetadata; exits 1 when sync fails or OpenMetadata is unreachable.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
include_namespace option --include-namespace text false Sentinel.UNSET multiple
exclude_namespace option --exclude-namespace text false Sentinel.UNSET multiple
dbt option --dbt --no-dbt boolean false true flag
dbt_schema option --dbt-schema text false none none

phlo operations

Guarded plan-first operations (maintenance, backup, restore, upgrade).

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
json option --json boolean false false flag
non_interactive option --non-interactive boolean false false flag

phlo operations backup

Create and verify immutable v1 backup sets (ADR 0049 §3).

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
json option --json boolean false false flag
non_interactive option --non-interactive boolean false false flag

phlo operations backup create

Create one verified backup set for all v1-owned state (authorized).

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
target option --target directory true Sentinel.UNSET none
output_json option --json boolean false false flag
output_format option --format choice false table choices: json, table

phlo operations backup verify

Independently verify a backup set (read-only, no service mutation).

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
backup_set option --backup-set directory true Sentinel.UNSET none
expected_deployment option --expected-deployment text false none none
output_json option --json boolean false false flag
output_format option --format choice false table choices: json, table

phlo operations maintenance

Plan and apply v1 table maintenance (compaction, snapshot expiry).

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
json option --json boolean false false flag
non_interactive option --non-interactive boolean false false flag

phlo operations maintenance apply

Apply an exact, still-current maintenance plan (authorized, fail-before-mutation).

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
plan_path option --plan path true Sentinel.UNSET none
confirmation_token option --confirmation-token text true Sentinel.UNSET none
output_json option --json boolean false false flag
output_format option --format choice false table choices: json, table

phlo operations maintenance inventory

List v1 tables with their provider and maintenance state (read-only).

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
output_json option --json boolean false false flag
output_format option --format choice false table choices: json, table

phlo operations maintenance plan

Create a deterministic maintenance plan (read-only, no mutation).

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
operation option --operation choice true Sentinel.UNSET choices: compact, snapshot_expiry
table option --table text true Sentinel.UNSET none
ref option --ref text false main none
catalog option --catalog text false Sentinel.UNSET none
retention_hours option --retention-hours integer false Sentinel.UNSET none
retain_last option --retain-last integer false Sentinel.UNSET none
max_affected_objects option --max-affected-objects integer false Sentinel.UNSET none
max_affected_bytes option --max-affected-bytes integer false Sentinel.UNSET none
output_json option --json boolean false false flag
output_format option --format choice false table choices: json, table

phlo operations restore

Plan and apply an explicit-target restore (ADR 0049 §4).

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
json option --json boolean false false flag
non_interactive option --non-interactive boolean false false flag

phlo operations restore apply

Apply a plan only to its bound target (authorized, fail-before-mutation).

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
plan_path option --plan path true Sentinel.UNSET none
confirmation_token option --confirmation-token text true Sentinel.UNSET none
fixture_substrate option --fixture-substrate boolean false false flag
output_json option --json boolean false false flag
output_format option --format choice false table choices: json, table

phlo operations restore plan

Create a mutation-free restore plan bound to set digest + target.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
backup_set option --backup-set directory true Sentinel.UNSET none
target option --target directory true Sentinel.UNSET none
output_json option --json boolean false false flag
output_format option --format choice false table choices: json, table

phlo operations upgrade

Prove the supported deployment upgrade pair (ADR 0049 §5).

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
json option --json boolean false false flag
non_interactive option --non-interactive boolean false false flag

phlo operations upgrade apply

Apply the bound upgrade (authorized, requires verified backup).

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
plan_path option --plan path true Sentinel.UNSET none
confirmation_token option --confirmation-token text true Sentinel.UNSET none
fixture_substrate option --fixture-substrate boolean false false flag
output_json option --json boolean false false flag
output_format option --format choice false table choices: json, table

phlo operations upgrade plan

Create a mutation-free upgrade plan after a verified backup.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
from_version option --from text true Sentinel.UNSET none
to_version option --to text true Sentinel.UNSET none
backup_set option --backup-set directory true Sentinel.UNSET none
target option --target directory true Sentinel.UNSET none
output_json option --json boolean false false flag
output_format option --format choice false table choices: json, table

phlo plugin

Manage Phlo plugins.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
json option --json boolean false false flag
non_interactive option --non-interactive boolean false false flag

phlo plugin check

Validate installed plugins.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
output_json option --json boolean false false flag
containers option --containers boolean false false flag
remote_images option --remote-images boolean false false flag
vulnerability_waiver_values option --allow-vulnerable-image text false Sentinel.UNSET multiple

phlo plugin create

Create scaffolding for a new plugin.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
plugin_name argument none text true Sentinel.UNSET none
plugin_type option --type choice false sources choices: sources, source, quality, service, hook, catalog, assets, resources, orchestrator
path option --path path false Sentinel.UNSET none
output_json option --json boolean false false flag

phlo plugin info

Show detailed plugin information.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
plugin_name argument none text true Sentinel.UNSET none
plugin_type option --type choice false Sentinel.UNSET choices: sources, source, quality, quality-providers, quality-provider, quality_provider, ingestion, ingestion-providers, ingestion-provider, ingestion_provider, transformation-providers, transformation-provider, transformation_provider, service, cli, cli-commands, cli-command, cli_command, hook, assets, asset, resources, resource, orchestrator, catalog
output_json option --json boolean false false flag

phlo plugin install

Install a plugin from the registry (wraps pip).

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
plugin_name argument none text true Sentinel.UNSET none
output_json option --json boolean false false flag

phlo plugin list

List all discovered plugins.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
plugin_type option --type choice false all choices: sources, source, quality, quality-providers, quality-provider, quality_provider, ingestion, ingestion-providers, ingestion-provider, ingestion_provider, transformation-providers, transformation-provider, transformation_provider, service, cli, cli-commands, cli-command, cli_command, hook, assets, asset, resources, resource, orchestrator, catalog, all
include_registry option --all boolean false false flag
output_json option --json boolean false false flag

phlo plugin search

Search plugin registry.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
query argument none text false Sentinel.UNSET none
plugin_type option --type choice false Sentinel.UNSET choices: sources, source, quality, quality-providers, quality-provider, quality_provider, ingestion, ingestion-providers, ingestion-provider, ingestion_provider, transformation-providers, transformation-provider, transformation_provider, service, cli, cli-commands, cli-command, cli_command, hook, assets, asset, resources, resource, orchestrator, catalog
tags option --tag text false Sentinel.UNSET multiple
output_json option --json boolean false false flag

phlo plugin update

Update installed plugins based on registry versions.

Capabilities: json=true, dry_run=true, confirmation_flag=false

Name Kind Options Type Required Default Other
output_json option --json boolean false false flag
dry_run option --dry-run boolean false false flag

phlo polaris

Manage the Polaris catalog service (status, bootstrap, migration).

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
polaris_args argument none text false Sentinel.UNSET nargs=-1

phlo postgres

Run psql or PostgreSQL helper commands against the project database.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
postgres_args argument none text false Sentinel.UNSET nargs=-1

phlo postgrest

PostgREST API management commands.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo postgrest generate-views

Generate PostgREST API views from dbt models.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
output option --output path false Sentinel.UNSET none
apply option --apply boolean false false flag
diff option --diff boolean false false flag
models option --models text false Sentinel.UNSET none
schema option --schema text false api none

phlo postgrest reload-schema

Reload PostgREST's schema cache after migrations or table creation.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo postgrest setup-auth

Set up PostgREST authentication infrastructure.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
host option --host text false Sentinel.UNSET none
port option --port integer false Sentinel.UNSET none
database option --database text false Sentinel.UNSET none
user option --user text false Sentinel.UNSET none
password option --password text false Sentinel.UNSET none
force option --force boolean false false flag
quiet option -q --quiet boolean false false flag

phlo schema

Manage Pandera schemas and schema validation.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo schema diff

Compare a schema version against an older one.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
schema_name argument none text true Sentinel.UNSET none
old option --old text false HEAD~1 none
format option --format choice false text choices: text, json

phlo schema generate

Generate Pandera schemas from a bounded DLT inference sample.

Capabilities: json=false, dry_run=true, confirmation_flag=false

Name Kind Options Type Required Default Other
from_ref option --from text true Sentinel.UNSET none
dry_run option --dry-run boolean false false flag
domain option --domain text true Sentinel.UNSET none
table_name option --table text false none none
class_name option --class text false none none
partition_date option --partition-date text false none none
max_records option --max-records integer false 200 none
out_path option --out text false none none
update option --update boolean false false flag
overwrite option --overwrite boolean false false flag

phlo schema list

List all available Pandera schemas with name, field count, and file path.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
domain option --domain text false none none
format option --format choice false table choices: table, json

phlo schema show

Show a schema's fields, types, constraints, and descriptions.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
schema_name argument none text true Sentinel.UNSET none
iceberg option --iceberg boolean false false flag

phlo schema validate

Validate a schema file's syntax and common integration issues.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
schema_path argument none text true Sentinel.UNSET none

phlo schema-migrate

Schema migration between quality schemas and storage tables.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
json option --json boolean false false flag
non_interactive option --non-interactive boolean false false flag

phlo schema-migrate apply

Apply schema migration to a storage table.

Capabilities: json=true, dry_run=true, confirmation_flag=true

Name Kind Options Type Required Default Other
table_name argument none text true Sentinel.UNSET none
schema_class option --schema-class text false none none
migration_file option --migration-file file false none none
rename option --rename text false Sentinel.UNSET multiple
output_json option --json boolean false false flag
non_interactive option --non-interactive boolean false false flag
yes option --yes boolean false false flag
dry_run option --dry-run boolean false false flag

phlo schema-migrate diff

Show pending schema changes between quality schema and storage table.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
table_name argument none text true Sentinel.UNSET none
schema_class option --schema-class text false none none
migration_file option --migration-file file false none none
rename option --rename text false Sentinel.UNSET multiple
fmt option --format choice false table choices: table, json

phlo schema-migrate export-contract

Export a Phlo contract snapshot for a table.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
table_name argument none text true Sentinel.UNSET none
schema_class option --schema-class text false none none
output_path option --output file false none none
force option --force boolean false false flag

phlo schema-migrate history

Show schema version history for a table.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
table_name argument none text true Sentinel.UNSET none
limit option --limit integer false 10 none
fmt option --format choice false table choices: table, json

phlo schema-migrate plan

Generate a migration plan for a table.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
table_name argument none text true Sentinel.UNSET none
schema_class option --schema-class text false none none
migration_file option --migration-file file false none none
rename option --rename text false Sentinel.UNSET multiple
fmt option --format choice false table choices: table, json

phlo schema-migrate scaffold-yaml

Generate migration scaffold YAML from a Phlo contract.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
table_name argument none text true Sentinel.UNSET none
contract_path option --from-contract file false none none
output_path option --output file false none none
force option --force boolean false false flag

phlo schema-migrate scaffold-yaml-recent

Generate migration scaffold YAML files for recent .phlo/contracts additions.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
since_hours option --since-hours integer false 24 none
limit option --limit integer false none none
force option --force boolean false false flag

phlo services

Manage Phlo infrastructure services (Docker).

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo services add

Add optional services or profiles to the rendered project stack.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
service_name argument none text false Sentinel.UNSET none
profiles option --profile text false Sentinel.UNSET multiple
services option --service text false Sentinel.UNSET multiple
no_start option --no-start boolean false false flag

phlo services exec

Run a command inside a running Phlo service container.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
service_name argument none text true Sentinel.UNSET none
command argument none text false Sentinel.UNSET nargs=-1
tty option --tty --no-tty boolean false false flag
backend_name option --backend choice false none choices: docker, podman, auto

phlo services init

Initialize Phlo infrastructure in .phlo/ directory.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
force option --force boolean false false flag
project_name option --name text false Sentinel.UNSET none
dev option --dev boolean false false flag
no_dev option --no-dev boolean false false flag
phlo_source option --phlo-source path false Sentinel.UNSET none
service_dev option --service-dev boolean false false flag
observatory_dev option --observatory-dev boolean false false flag
production option --production boolean false false flag
publish_all_interfaces option --publish-all-interfaces boolean false false flag
allow_insecure option --allow-insecure boolean false false flag
profiles option --profile text false Sentinel.UNSET multiple

phlo services list

List available services with status and configuration.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
show_all option --all boolean false false flag
output_json option --json boolean false false flag
backend_name option --backend choice false none choices: docker, podman, auto

phlo services logs

View logs from Phlo infrastructure services.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
services argument none text false Sentinel.UNSET nargs=-1
service_options option -s --service --package text false Sentinel.UNSET multiple
follow option -f --follow boolean false false flag
tail option -n --tail --lines integer range false 100 none
since option --since text false Sentinel.UNSET none
until option --until text false Sentinel.UNSET none
timestamps option --timestamps boolean false false flag
no_color option --no-color boolean false false flag
backend_name option --backend choice false none choices: docker, podman, auto

phlo services migrate

Move personal files aside and make existing .phlo configuration shareable.

Capabilities: json=false, dry_run=true, confirmation_flag=false

Name Kind Options Type Required Default Other
dry_run option --dry-run boolean false false flag
includes option --include text false Sentinel.UNSET multiple

phlo services ports

Show port mappings for all services.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
output_json option --json boolean false false flag
show_all option --all boolean false false flag
backend_name option --backend choice false none choices: docker, podman, auto

phlo services preflight

Evaluate production readiness for the generated stack.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
production option --production boolean false false flag
as_json option --json boolean false false flag
observatory_dev option --observatory-dev boolean false false flag
output_path option --output file false Sentinel.UNSET none

phlo services remove

Remove a service from the project.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
service_name argument none text true Sentinel.UNSET none
keep_running option --keep-running boolean false false flag

phlo services reset

Reset Phlo infrastructure by stopping services and deleting volumes.

Capabilities: json=true, dry_run=true, confirmation_flag=true

Name Kind Options Type Required Default Other
service option --service text false Sentinel.UNSET multiple
yes option --yes -y boolean false false flag
backend_name option --backend choice false none choices: docker, podman, auto
dry_run option --dry-run boolean false false flag
output_json option --json boolean false false flag
non_interactive option --non-interactive boolean false false flag

phlo services restart

Restart Phlo infrastructure services.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
build option --build boolean false false flag
profile option --profile text false Sentinel.UNSET multiple
service option --service text false Sentinel.UNSET multiple
dev option --dev boolean false false flag
backend_name option --backend choice false none choices: docker, podman, auto

phlo services start

Start Phlo infrastructure services.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
detach option -d --detach --no-detach boolean false true flag
build option --build boolean false false flag
profile option --profile text false Sentinel.UNSET multiple
service option --service text false Sentinel.UNSET multiple
native option --native boolean false false flag
backend_name option --backend choice false none choices: docker, podman, auto
observatory_dev option --observatory-dev boolean false false flag

phlo services status

Show status of Phlo infrastructure services.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
backend_name option --backend choice false none choices: docker, podman, auto
output_json option --json boolean false false flag
service option --service text false Sentinel.UNSET multiple

phlo services stop

Stop Phlo infrastructure services.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
volumes option -v --volumes boolean false false flag
stop_native option --native boolean false false flag
profile option --profile text false Sentinel.UNSET multiple
service option --service text false Sentinel.UNSET multiple
backend_name option --backend choice false none choices: docker, podman, auto

phlo services upgrade

Reconcile installed templates, preserving secrets, volumes and personal overrides.

Capabilities: json=false, dry_run=true, confirmation_flag=false

Name Kind Options Type Required Default Other
dry_run option --dry-run boolean false false flag
output option --output path false Sentinel.UNSET none
plan_path option --apply path false Sentinel.UNSET none
confirm option --confirm text false Sentinel.UNSET none
previous_generated option --previous-generated directory false Sentinel.UNSET none
production option --production boolean false false flag
observatory_dev option --observatory-dev boolean false false flag
repair_empty_api_binds option --repair-empty-api-binds boolean false false flag
allow_insecure option --allow-insecure boolean false false flag

phlo sling

Sling replication commands.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo sling conns

List available Sling connections.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
auto option --auto --no-auto boolean false true flag

phlo sling discover

Discover available streams from a Sling connection.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
connection argument none text true Sentinel.UNSET none
schema option --schema text false Sentinel.UNSET none
output_format option --format choice false table choices: table, json

phlo sling run

Run a Sling replication.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
replication option --replication -r path false Sentinel.UNSET none
source option --source -s text false Sentinel.UNSET none
target option --target -t text false Sentinel.UNSET none
stream option --stream text false Sentinel.UNSET none
target_object option --object text false Sentinel.UNSET none
mode option --mode text false none none

phlo status

Show current state of assets, jobs, and services: asset materialization status and freshness, service health (Dagster, Trino, MinIO, Nessie), with color-coded indicators.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
assets option --assets boolean false false flag
services option --services boolean false false flag
group option --group text false Sentinel.UNSET none
stale option --stale boolean false false flag
output_json option --json boolean false false flag

phlo support

Inspect the bundled, offline support contract.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo support status

Compare installed Phlo artifacts with the bundled release set.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
output_json option --json boolean false false flag

phlo test

Run tests for Phlo workflows.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
asset_name argument none text false Sentinel.UNSET none
local option --local boolean false false flag
coverage option --coverage boolean false false flag
verbose option -v --verbose boolean false false flag
marker option -m --marker text false Sentinel.UNSET none

phlo transform

Phlo Transform workspace commands (check, plan, run, test, lineage).

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo transform check

Compile the workspace and print diagnostics.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
as_json option --json boolean false false flag

phlo transform doctor

Diagnose workspace, adapter, and state health.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
as_json option --json boolean false false flag

phlo transform explain

Explain one model: SQL, columns, lineage, and state.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
model argument none text true Sentinel.UNSET none
as_json option --json boolean false false flag

phlo transform install

Download the pinned portable engine binary into .phlo/bin.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
version option --version text false none none
force option --force boolean false false flag

phlo transform lineage

Export the workspace lineage graph.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
lineage_format option --format choice false graph choices: graph, openlineage
as_json option --json boolean false false flag

phlo transform list

List compiled models, dependencies, and tests.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
as_json option --json boolean false false flag

phlo transform plan

Explain what would change and why.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
select option --select text false Sentinel.UNSET multiple
exclude option --exclude text false Sentinel.UNSET multiple
upstream option --upstream boolean false false flag
downstream option --downstream boolean false false flag
force option --force boolean false false flag
ref option --ref text false none none
adapter option --adapter text false none none
as_json option --json boolean false false flag

phlo transform run

Plan, apply, and test the selected models.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
select option --select text false Sentinel.UNSET multiple
exclude option --exclude text false Sentinel.UNSET multiple
upstream option --upstream boolean false false flag
downstream option --downstream boolean false false flag
force option --force boolean false false flag
ref option --ref text false none none
adapter option --adapter text false none none
as_json option --json boolean false false flag

phlo transform status

Show the active provider, workspace, binary, and compiled counts.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
as_json option --json boolean false false flag

phlo transform test

Run workspace tests against the selected models.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
select option --select text false Sentinel.UNSET multiple
ref option --ref text false none none
adapter option --adapter text false none none
as_json option --json boolean false false flag

phlo transform translate

Translate a dbt project into a native transform workspace.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
source option --from text false dbt none
source_root option --source-root directory false none none
out option --out directory false none none
check_only option --check boolean false false flag
overwrite option --overwrite boolean false false flag
verify option --verify boolean false false flag
as_json option --json boolean false false flag

phlo transform use

Select the transformation provider that owns the asset graph.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
provider argument none text false Sentinel.UNSET none
unset option --unset boolean false false flag

phlo trino

Run the Trino shell or a Trino-specific helper command.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
trino_args argument none text false Sentinel.UNSET nargs=-1

phlo validate-schema

Validate a Pandera schema file for valid DataFrameModel syntax, field descriptions, constraints, and type annotations; exits 0 when valid and 1 when issues are found.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
schema_file argument none file true Sentinel.UNSET none
check_constraints option --check-constraints boolean false true flag
check_descriptions option --check-descriptions boolean false true flag

phlo validate-workflow

Validate a workflow asset file for decorator usage, unique_key presence, cron validity, function signature, and return types before deployment; exits 0 when valid and 1 when issues are found.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
asset_file argument none path true Sentinel.UNSET none
fix option --fix boolean false false flag

phlo workflow

Manage workflows.

Capabilities: json=false, dry_run=false, confirmation_flag=false

Parameters: none.

phlo workflow check

Validate a workflow and its inferred schema before materialization.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
workflow_file argument none file true Sentinel.UNSET none
output_json option --json boolean false false flag

phlo workflow create

Create a workflow scaffold.

Capabilities: json=true, dry_run=false, confirmation_flag=false

Name Kind Options Type Required Default Other
workflow_type option --type choice false ingestion choices: ingestion
domain option --domain text false Sentinel.UNSET none
table option --table text false Sentinel.UNSET none
unique_key option --unique-key text false Sentinel.UNSET none
cron option --cron text false 0 */1 * * * none
api_base_url option --api-base-url text false "" none
fields option --field text false Sentinel.UNSET multiple
provider option --provider text false Sentinel.UNSET none
source_kind option --source-kind choice false rest-api choices: rest-api, partitioned-sql
output_json option --json boolean false false flag