⊢ Docs ⊢ Blog
[d] Book a demo
Reference

CLI Reference

The Zipline CLI (zipline) is a tool for compiling and running Zipline pipelines.

zipline compile

Compile Chronon configs.

zipline compile [OPTIONS]

Options:

  • --chronon-root TEXT (env: CHRONON_ROOT) — Path to the root Chronon folder.
  • --ignore-python-errors — Allow compilation to proceed even with Python errors (useful for testing)
  • -f, --format [json|text] (default: text) — Output format.
  • --force — Force compilation to proceed even with errors
  • --dry-run — Perform a dry run of the compilation without writing any files

zipline run

Run a Zipline pipeline.

CONF is the path to the compiled conf (e.g. compiled/joins/team/my_join).

zipline run [OPTIONS] CONF

Arguments:

  • CONF

Options:

  • -e, --env TEXT (default: dev) — Running environment.
  • -m, --mode [backfill|backfill-left|backfill-final|upload|upload-to-kv|stats-summary|log-summary|analyze|streaming|metadata-upload|fetch|consistency-metrics-compute|build-comparison-table|compare|local-streaming|log-flattener|metadata-export|label-join|streaming-client|source-job|join-part-job|merge-job|metastore|info] (default: backfill)
  • --ds TEXT — the end partition to backfill the data
  • --app-name TEXT — app name. Default to chronon_{conf_type}{mode}{context}_{name}
  • --force-overwrite — Overwrite existing partitions for a staging query backfill.
  • --start-ds TEXT — override the original start partition for a range backfill. It only supports staging query, group by backfill and join jobs. It could leave holes in your final output table due to the override date range.
  • --end-ds TEXT — the end ds for a range backfill
  • --parallelism TEXT — break down the backfill range into this number of tasks in parallel. Please use it along with --start-ds and --end-ds and only in manual mode
  • --chronon-root TEXT (default: ., env: CHRONON_ROOT, CHRONON_REPO_PATH) — Path to chronon repo
  • -r, --repo TEXT (deprecated) — Deprecated alias for --chronon-root. (DEPRECATED: Use --chronon-root instead.)
  • --online-jar TEXT — Jar containing Online KvStore & Deserializer Impl. Used for streaming and metadata-upload mode.
  • --online-class TEXT — Class name of Online Impl. Used for streaming and metadata-upload mode.
  • --version TEXT — Chronon version to use.
  • --spark-version TEXT (default: 2.4.0) — Spark version to use for downloading jar.
  • --spark-submit-path TEXT — Path to spark-submit
  • --spark-streaming-submit-path TEXT — Path to spark-submit for streaming
  • --online-jar-fetch TEXT — Path to script that can pull online jar. This will run only when a file doesn't exist at location specified by online_jar
  • --sub-help — print help command of the underlying jar and exit
  • --conf-type TEXT — related to sub-help - no need to set unless you are not working with a conf
  • --online-args TEXT — Basic arguments that need to be supplied to all online modes
  • --chronon-jar TEXT — Path to chronon OS jar
  • --release-tag TEXT — Use the latest jar for a particular tag.
  • --list-apps TEXT — command/script to list running jobs on the scheduler
  • --render-info TEXT — Path to script rendering additional information of the given config. Only applicable when mode is set to info
  • --kafka-bootstrap TEXT — Kafka bootstrap server in host:port format
  • --latest-savepoint — Deploys streaming job with latest savepoint
  • --custom-savepoint TEXT — Savepoint to deploy streaming job with.
  • --no-savepoint — Deploys streaming job without a savepoint
  • --version-check — Checks if Zipline version of running streaming job is different from local version and deploys the job if they are different
  • --flink-state-uri TEXT — Bucket for storing flink state checkpoints/savepoints and other internal pieces for orchestration.
  • --flink-jars-uri TEXT — Base URI path for Flink job jars (e.g. gs://bucket/libs/). If not specified, defaults to gs://zipline-spark-libs/spark-3.5.3/libs/
  • --additional-jars TEXT — Comma separated list of additional jar URIs to be included in the Spark/Flink job classpath. Accepts gs://, s3://, http(s)://, file: and local: schemes (e.g. gs://bucket/jar1.jar,https://artifactory.example.com/path/jar2.jar).
  • --flink-deployment-mode [default|application] (default: default) — Flink deployment mode
  • --validate — Validate the catalyst util Spark expression evaluation logic
  • --validate-rows TEXT (default: 10000) — Number of rows to run the validation on
  • --join-part-name TEXT — Name of the join part to use for join-part-job
  • --artifact-prefix TEXT — Remote artifact URI to install zipline client artifacts necessary for interacting with Zipline infrastructure.
  • --warehouse-bucket TEXT — GCS or S3 bucket to use as warehouse for staging metadata/configs.
  • --no-cloud-logging — Disables cloud logging
  • --debug — Enables verbose debug logging in run modes that support it
  • --uploader [spark|bigquery] — Bulk put uploader to use when load data to kv store, applied to upload-to-kv mode
  • --publish-timestamp PARTITION_DATE|EPOCH_MILLIS — Publication date/time (UTC) or epoch milliseconds to assign to every uploaded KV value. Date formats: YYYY-MM-DD, YYYY-MM-DD-HH, YYYY-MM-DD-HH-mm, ISO, or space-separated datetime.

zipline init-agent

Install Zipline/Chronon agent context for your AI coding assistant.

Supports Claude Code, Codex, Cursor, Gemini CLI, Windsurf, and GitHub Copilot. Installs the context file into the appropriate location for the selected agent.

zipline init-agent [OPTIONS]

Options:

  • --agent [claude|codex|cursor|gemini|windsurf|copilot] — AI agent to install context for. Prompted interactively if not provided.

zipline compare-tables

Compare two tables by submitting a Spark job via EMR Serverless.

Joins the two tables on the specified keys, computes comparison metrics, and writes both a side-by-side and a per-column metrics table. Output table names default to <output_catalog>.<output_schema>.compare_{'{'}sbs,metrics{'}'}_<ts> — catalog/schema fall back to those of --left-table when unset.

Requires a --team flag to load spark configs and env vars from teams.py. Run from a directory containing teams.py or pass --chronon-root.

 Examples: zipline compare-tables
--team=aws_databricks
--left-table=workspace.poc.dim_listings
--right-table=workspace.poc.dim_listings_v2
--keys=listing_id,date

zipline compare-tables 
    --team=aws_databricks 
    --left-table=workspace.poc.dim_listings 
    --right-table=workspace.poc.dim_listings_v2 
    --keys=listing_id 
    --output-catalog=workspace_iceberg 
    --output-schema=staging 
    --mapping='{'{'}"old_col": "new_col"{'}'}' 
    --migration-check
zipline compare-tables [OPTIONS]

Options:

  • --left-table TEXT (required) — Fully qualified left table name (e.g. database.schema.table).
  • --right-table TEXT (required) — Fully qualified right table name (e.g. database.schema.table).
  • --keys TEXT (required) — Comma-separated list of key columns to join on (using left table column names).
  • --output-catalog TEXT — Catalog to write the comparison output tables into. Defaults to the catalog of --left-table.
  • --output-schema TEXT — Schema (database) to write the comparison output tables into. Defaults to the schema of --left-table.
  • --yes, -y — Skip the interactive confirmation of resolved output table names. Useful for scripted / CI invocations.
  • --team TEXT (required) — Team name from teams.py (e.g. 'aws', 'aws_databricks'). Loads spark configs and env vars for the target environment.
  • --mapping TEXT — JSON mapping of left_col_name -> SQL expression for renaming/transforming right table columns. E.g. '{"left_col": "right_col", "amount": "CAST(value AS DOUBLE)"}'
  • --timestamp-millis-left TEXT — SQL expression on the left table that produces a timestamp in milliseconds (Long).
  • --timestamp-millis-right TEXT — SQL expression on the right table that produces a timestamp in milliseconds (Long). Must be paired with --timestamp-millis-left.
  • --left-columns TEXT — Comma-separated subset of left columns to compare. Defaults to all non-key columns.
  • --migration-check — Allow the left table to have extra columns not present in the right table.
  • --version TEXT — Zipline version to use. Defaults to VERSION from teams.py or env var.
  • --chronon-root TEXT (env: CHRONON_ROOT) — Path to the Chronon root (containing teams.py). Auto-discovered if omitted.
  • --warehouse-id TEXT (env: DATABRICKS_WAREHOUSE_ID) — Databricks SQL warehouse ID used to fetch the metrics summary after the job completes. Resolution order: --warehouse-id flag > DATABRICKS_WAREHOUSE_ID env var > DATABRICKS_WAREHOUSE_ID from teams.py env section. If unresolved, the CLI prints the output table names and skips the summary.

zipline auth

zipline auth login

Authenticate with Zipline via browser-based device flow.

zipline auth login [OPTIONS]

Options:

  • --url TEXT — Zipline Auth URL (e.g. https://zipline.example.com). Defaults to FRONTEND_URL from teams.py.
  • --no-browser — Don't automatically open the browser

zipline auth logout

Remove stored Zipline credentials.

zipline auth logout [OPTIONS]

Options:

  • --url TEXT — Zipline Auth URL to log out of. If omitted, logs out of all accounts.

zipline auth get-access-token

Print a JWT access token to stdout (for use in scripts and curl).

zipline auth get-access-token [OPTIONS]

Options:

  • --url TEXT — Zipline Auth URL to get token for. Defaults to the most recently authenticated account.

zipline auth status

Show current authentication status.

zipline auth status [OPTIONS]

Options:

  • --url TEXT — Zipline Auth URL to check status for. If omitted, shows all accounts.

zipline config

zipline config list

List all config values for the resolved team (and optional conf).

zipline config list [OPTIONS]

Options:

  • --all — List config for every team in the selected teams file instead of a single team.
  • --team TEXT — Team name from teams.py (e.g. 'gcp', 'aws'). Defaults to the 'default' team.
  • --conf TEXT — Path to a compiled conf file (e.g. compiled/joins/team/my_join). When set, values come from the conf's merged executionInfo.
  • --chronon-root TEXT (env: CHRONON_ROOT) — Path to the Chronon root (containing teams.py). Auto-discovered if omitted.
  • --env [prod|canary] (default: prod) — Which teams file to inspect: 'prod' (teams.py) or 'canary' (teams.canary.py).
  • -f, --format [json|text] (default: text) — Output format.

zipline config get

Get a config value by KEY (case-insensitive).

KEY may be the fully-qualified name (e.g. 'env.CUSTOMER_ID') or the bare name (e.g. 'CUSTOMER_ID'). When multiple sections define the same bare key, all matches are returned.

zipline config get [OPTIONS] KEY

Arguments:

  • KEY

Options:

  • --team TEXT — Team name from teams.py (e.g. 'gcp', 'aws'). Defaults to the 'default' team.
  • --conf TEXT — Path to a compiled conf file (e.g. compiled/joins/team/my_join). When set, values come from the conf's merged executionInfo.
  • --chronon-root TEXT (env: CHRONON_ROOT) — Path to the Chronon root (containing teams.py). Auto-discovered if omitted.
  • --env [prod|canary] (default: prod) — Which teams file to inspect: 'prod' (teams.py) or 'canary' (teams.canary.py).
  • -f, --format [json|text] (default: text) — Output format.

zipline hub

zipline hub backfill

Submit a backfill job to Zipline Hub.

CONF is the path to the compiled conf (e.g. compiled/joins/team/my_join).

zipline hub backfill [OPTIONS] CONF

Arguments:

  • CONF

Options:

  • --force — Force compile even if there are version changes to existing confs
  • -f, --format [json|text] (default: text) — Output format.
  • --use-auth / --no-use-auth — Use authentication when connecting to Zipline Hub
  • --hub-url TEXT — Zipline Hub address, e.g. http://localhost:3903
  • --chronon-root TEXT (default: ., env: CHRONON_ROOT) — Path to the Chronon root (containing teams.py).
  • -r, --repo TEXT (deprecated) — Deprecated alias for --chronon-root. (DEPRECATED: Use --chronon-root instead.)
  • --start-date, --start-ds PARTITION — Start date override for a range backfill (format: YYYY-MM-DD, YYYY-MM-DD-HH, YYYY-MM-DD-HH-mm, ISO, or space-separated datetime). Supports staging query, group by, and join jobs. May leave holes in the output table due to the overridden date range.
  • --end-date, --end-ds PARTITION (default: 2 days ago) — End date for a range backfill (format: YYYY-MM-DD, YYYY-MM-DD-HH, YYYY-MM-DD-HH-mm, ISO, or space-separated datetime).
  • -y, --yes, --assume-yes — Skip the end-date confirmation prompt. Use in non-interactive CI where stdin isn't a TTY and the prompt would otherwise abort the job.
  • --concurrency INTEGER RANGE — Max workflow steps Hub may allocate concurrently for this workflow.
  • --skip-compile — Skip compile before running the command

zipline hub run-adhoc

Submit a one-off deploy job to test a conf online.

CONF is the path to the compiled conf (e.g. compiled/joins/team/my_join).

zipline hub run-adhoc [OPTIONS] CONF

Arguments:

  • CONF

Options:

  • --force — Force compile even if there are version changes to existing confs
  • -f, --format [json|text] (default: text) — Output format.
  • --use-auth / --no-use-auth — Use authentication when connecting to Zipline Hub
  • --hub-url TEXT — Zipline Hub address, e.g. http://localhost:3903
  • --chronon-root TEXT (default: ., env: CHRONON_ROOT) — Path to the Chronon root (containing teams.py).
  • -r, --repo TEXT (deprecated) — Deprecated alias for --chronon-root. (DEPRECATED: Use --chronon-root instead.)
  • --end-date, --end-ds PARTITION (default: 2 days ago) — End date for a range backfill (format: YYYY-MM-DD, YYYY-MM-DD-HH, YYYY-MM-DD-HH-mm, ISO, or space-separated datetime).
  • -y, --yes, --assume-yes — Skip the end-date confirmation prompt. Use in non-interactive CI where stdin isn't a TTY and the prompt would otherwise abort the job.
  • --skip-compile — Skip compile before running the command

zipline hub schedule

Deploy a recurring schedule for a conf.

CONF is the path to the compiled conf (e.g. compiled/joins/team/my_join).

zipline hub schedule [OPTIONS] CONF

Arguments:

  • CONF

Options:

  • --force — Force compile even if there are version changes to existing confs
  • -f, --format [json|text] (default: text) — Output format.
  • --use-auth / --no-use-auth — Use authentication when connecting to Zipline Hub
  • --hub-url TEXT — Zipline Hub address, e.g. http://localhost:3903
  • --chronon-root TEXT (default: ., env: CHRONON_ROOT) — Path to the Chronon root (containing teams.py).
  • -r, --repo TEXT (deprecated) — Deprecated alias for --chronon-root. (DEPRECATED: Use --chronon-root instead.)
  • --skip-compile — Skip compile before running the command

zipline hub schedule-all

Deploy recurring schedules for all changed confs that have schedules defined.

zipline hub schedule-all [OPTIONS]

Options:

  • --chronon-root TEXT (default: ., env: CHRONON_ROOT) — Path to the Chronon root (containing teams.py).
  • -r, --repo TEXT (deprecated) — Deprecated alias for --chronon-root. (DEPRECATED: Use --chronon-root instead.)
  • --hub-url TEXT — Zipline Hub address, e.g. http://localhost:3903
  • --use-auth / --no-use-auth — Use authentication when connecting to Zipline Hub
  • -f, --format [json|text] (default: text) — Output format.
  • --cloud [gcp|aws|azure] — Cloud provider for the hub and related services
  • --customer-id TEXT — Customer ID for authentication. Required for Azure.
  • --env [prod|canary] (default: prod) — Environment to run against

zipline hub cancel

Cancel a running workflow.

WORKFLOW_ID is the ID of the workflow to cancel.

zipline hub cancel [OPTIONS] WORKFLOW_ID

Arguments:

  • WORKFLOW_ID

Options:

  • --chronon-root TEXT (default: ., env: CHRONON_ROOT) — Path to the Chronon root (containing teams.py).
  • -r, --repo TEXT (deprecated) — Deprecated alias for --chronon-root. (DEPRECATED: Use --chronon-root instead.)
  • --hub-url TEXT — Zipline Hub address, e.g. http://localhost:3903
  • --use-auth / --no-use-auth — Use authentication when connecting to Zipline Hub
  • -f, --format [json|text] (default: text) — Output format.
  • --cloud [gcp|aws|azure] — Cloud provider for the hub and related services
  • --customer-id TEXT — Customer ID for authentication. Required for Azure.
  • --env [prod|canary] (default: prod) — Environment to run against

zipline hub clear-downstream

Clear a conf's terminal node and all downstream nodes for a date range.

CONF is the path to the compiled conf (e.g. compiled/joins/team/my_join).

zipline hub clear-downstream [OPTIONS] CONF

Arguments:

  • CONF

Options:

  • --chronon-root TEXT (default: ., env: CHRONON_ROOT) — Path to the Chronon root (containing teams.py).
  • -r, --repo TEXT (deprecated) — Deprecated alias for --chronon-root. (DEPRECATED: Use --chronon-root instead.)
  • --hub-url TEXT — Zipline Hub address, e.g. http://localhost:3903
  • --use-auth / --no-use-auth — Use authentication when connecting to Zipline Hub
  • -f, --format [json|text] (default: text) — Output format.
  • --start-date, --start-ds PARTITION — Start date override for a range backfill (format: YYYY-MM-DD, YYYY-MM-DD-HH, YYYY-MM-DD-HH-mm, ISO, or space-separated datetime). Supports staging query, group by, and join jobs. May leave holes in the output table due to the overridden date range.
  • --end-date, --end-ds PARTITION (default: 2 days ago) — End date for a range backfill (format: YYYY-MM-DD, YYYY-MM-DD-HH, YYYY-MM-DD-HH-mm, ISO, or space-separated datetime).
  • -y, --yes, --assume-yes — Skip the end-date confirmation prompt. Use in non-interactive CI where stdin isn't a TTY and the prompt would otherwise abort the job.

zipline hub fetch

Fetch data from the Zipline fetcher server.

CONF is the path to the compiled conf (e.g. compiled/joins/team/my_join).

zipline hub fetch [OPTIONS] CONF

Arguments:

  • CONF

Options:

  • --force — Force compile even if there are version changes to existing confs
  • -f, --format [json|text] (default: text) — Output format.
  • --use-auth / --no-use-auth — Use authentication when connecting to Zipline Hub
  • --hub-url TEXT — Zipline Hub address, e.g. http://localhost:3903
  • --chronon-root TEXT (default: ., env: CHRONON_ROOT) — Path to the Chronon root (containing teams.py).
  • -r, --repo TEXT (deprecated) — Deprecated alias for --chronon-root. (DEPRECATED: Use --chronon-root instead.)
  • --fetcher-url TEXT — Fetcher server address (e.g. http://localhost:3904).
  • --schema — Get only the schema
  • --key-json TEXT — Json of the keys to fetch

zipline hub eval

Validate a conf against source tables and schemas.

CONF is the path to the compiled conf (e.g. compiled/joins/team/my_join).

zipline hub eval [OPTIONS] CONF

Arguments:

  • CONF

Options:

  • --force — Force compile even if there are version changes to existing confs
  • -f, --format [json|text] (default: text) — Output format.
  • --use-auth / --no-use-auth — Use authentication when connecting to Zipline Hub
  • --hub-url TEXT — Zipline Hub address, e.g. http://localhost:3903
  • --chronon-root TEXT (default: ., env: CHRONON_ROOT) — Path to the Chronon root (containing teams.py).
  • -r, --repo TEXT (deprecated) — Deprecated alias for --chronon-root. (DEPRECATED: Use --chronon-root instead.)
  • --eval-url TEXT — Eval server address (e.g. http://localhost:3904).
  • --generate-test-config — Generate a test config for data testing.
  • --test-data-path TEXT — Path to the test data yaml file to upload and use for evaluation.
  • --skip-compile — Skip compile before running the command

zipline hub eval-table

Validate a table's schema.

TABLE is the table name for schema evaluation (e.g. data.loggable_response).

zipline hub eval-table [OPTIONS] TABLE

Arguments:

  • TABLE

Options:

  • --chronon-root TEXT (default: ., env: CHRONON_ROOT) — Path to the Chronon root (containing teams.py).
  • -r, --repo TEXT (deprecated) — Deprecated alias for --chronon-root. (DEPRECATED: Use --chronon-root instead.)
  • --conf TEXT — Optional conf to use for executionInfo. Takes precedence over --team.
  • --team TEXT — Optional team name to use for executionInfo. If not specified, uses default team metadata.
  • --hub-url TEXT — Zipline Hub address, e.g. http://localhost:3903
  • --use-auth / --no-use-auth — Use authentication when connecting to Zipline Hub
  • -f, --format [json|text] (default: text) — Output format.
  • --eval-url TEXT — Eval server address (e.g. http://localhost:3904).
  • --engine-type TEXT (default: SPARK) — Engine type for table evaluation.
  • --env [prod|canary] (default: prod) — Environment to run against

zipline hub list-tables

List tables in a schema.

SCHEMA_NAME is the schema/database to list tables from (e.g. demo).

zipline hub list-tables [OPTIONS] SCHEMA_NAME

Arguments:

  • SCHEMA_NAME

Options:

  • --chronon-root TEXT (default: ., env: CHRONON_ROOT) — Path to the Chronon root (containing teams.py).
  • -r, --repo TEXT (deprecated) — Deprecated alias for --chronon-root. (DEPRECATED: Use --chronon-root instead.)
  • --team TEXT — Optional team name to use for executionInfo. If not specified, uses default team metadata.
  • --hub-url TEXT — Zipline Hub address, e.g. http://localhost:3903
  • --use-auth / --no-use-auth — Use authentication when connecting to Zipline Hub
  • -f, --format [json|text] (default: text) — Output format.
  • --eval-url TEXT — Eval server address (e.g. http://localhost:3904).
  • --engine-type TEXT (default: SPARK) — Engine type for listing tables.
  • --env [prod|canary] (default: prod) — Environment to run against

zipline admin

zipline admin install

Install Zipline images into a private registry or the local Docker daemon.

CLOUD is the cloud provider variant (gcp, aws, or azure).

zipline admin install [OPTIONS] CLOUD

Arguments:

  • CLOUD ({gcp|aws|azure})

Options:

  • --registry TEXT (default: local) — Target registry URL (e.g. us-docker.pkg.dev/project/repo) or 'local' for the local Docker daemon.
  • --api-token TEXT (env: ZIPLINE_API_TOKEN) — Zipline API token for Docker Hub access. Can also be set via ZIPLINE_API_TOKEN env var. Optional when using --bundle or when already authenticated to Docker Hub.
  • --release TEXT — Zipline release to load (e.g. 0.1.42). Defaults to the installed zipline-ai package version.
  • --artifact-prefix TEXT — Target prefix for engine JARs: a blob store URI (e.g. gs://bucket/zipline) or a local filesystem path.
  • --bundle PATH — Path to air-gap tarball (alternative to pulling from Docker Hub).

zipline admin init

Initialize a new Zipline project with scaffolding.

CLOUD is the cloud provider to use (gcp, aws, or azure).

zipline admin init [OPTIONS] CLOUD

Arguments:

  • CLOUD ({gcp|aws|azure})

Options:

  • --chronon-root DIRECTORY — Path to the root chronon folder.

zipline admin upgrade

zipline admin upgrade control-plane

Upgrade running EKS service deployments to a given release.

CLOUD is the cloud provider variant (gcp, aws, or azure). Currently only AWS EKS deployments are supported.

zipline admin upgrade control-plane [OPTIONS] CLOUD

Arguments:

  • CLOUD ({gcp|aws|azure})

Options:

  • --release TEXT — Zipline release to upgrade to (e.g. 1.4.2). Defaults to the installed zipline-ai package version.
  • -y, --yes — Skip the kubectl-context confirmation prompt. Use for scripts/CI.

zipline admin upgrade data-plane

Redeploy running streaming GroupBy jobs.

CONFs are the path to the compiled conf (e.g. compiled/joins/team/my_join). Syncs confs to Hub then triggers a redeploy - the job will use the version as configured in the VERSION of the conf / teams.py (in that order)

zipline admin upgrade data-plane [OPTIONS] CONFS...

Arguments:

  • CONFS

Options:

  • --chronon-root TEXT (default: ., env: CHRONON_ROOT) — Path to the Chronon root (containing teams.py).
  • -r, --repo TEXT (deprecated) — Deprecated alias for --chronon-root. (DEPRECATED: Use --chronon-root instead.)
  • --hub-url TEXT — Zipline Hub address, e.g. http://localhost:3903
  • --use-auth / --no-use-auth — Use authentication when connecting to Zipline Hub
  • -f, --format [json|text] (default: text) — Output format.

zipline admin doctor

zipline admin doctor hub-health

Check that the Zipline hub is reachable and healthy.

HUB_URL is the URL of the running Zipline hub (e.g. https://hub.example.com).

zipline admin doctor hub-health [OPTIONS] HUB_URL

Arguments:

  • HUB_URL

Options:

  • --expected-version TEXT — Expected Zipline version (optional).

zipline admin doctor streaming-health

Check that the Flink streaming infrastructure is correctly configured.

Requires kubectl to be installed and configured with access to the cluster.

zipline admin doctor streaming-health [OPTIONS]

Options:

  • --cloud [gcp|aws|azure] (default: aws) — Cloud provider variant.
  • -y, --yes — Skip the kubectl-context confirmation prompt. Use for scripts/CI.

zipline admin doctor infra-health

Check that the Zipline deployment's infrastructure is healthy.

Runs every check group by default (network, Karpenter, autoscaling, Spark/Flink URLs, hub domain wiring, observability, streaming). Pass one or more group flags (e.g. --karpenter --network) to run only those. Requires kubectl configured for the target cluster. Exits non-zero if any check FAILs; WARNs do not fail.

zipline admin doctor infra-health [OPTIONS]

Options:

  • --cloud [gcp|aws|azure] (default: aws) — Cloud provider variant.
  • --network — Only run network-connectivity checks.
  • --karpenter — Only run Karpenter checks.
  • --autoscaling — Only run autoscaling checks.
  • --urls — Only run Spark/Flink URL checks.
  • --domain — Only run hub URL / custom-domain checks.
  • --observability — Only run logging/metrics checks.
  • --streaming — Only run Flink streaming checks.
  • --report-file TEXT — Write non-passing checks (WARN/FAIL) as TSV lines to this file (for CI/Slack reporting).
  • -y, --yes — Skip the kubectl-context confirmation prompt. Use for scripts/CI.
Edit this page
Prev
Python API
Next
Tiled Architecture