DataHub CLI - Paradime

The Paradime SDK provides a CLI command to push Bolt dbt™ artifacts (manifest and catalog) to DataHub.

🔑 API Access RequiredYou will need your DataHub GMS server URL to use this command. A DataHub personal access token is required for DataHub Cloud / auth-enabled instances, and can be omitted for a local instance with metadata service auth disabled.

Push DataHub Artifacts

Push Bolt dbt™ artifacts (manifest + catalog) to DataHub. The command pushes every dbt™ project in the run that has both target/manifest.json and target/catalog.json, and skips one without a catalog.

On dbt™ v2, dbt docs generate no longer writes catalog.json. Add --write-catalog to a dbt™ command earlier in the schedule, for example dbt build --write-catalog. See Prepare for dbt™ v2.

CLI Command

paradime run datahub-artifacts-push

Options

Flag	Type	Description
`--datahub-server`	Required, TEXT	The DataHub GMS server URL (e.g. https://<instance>.acryl.io/gms). Can be set via `DATAHUB_GMS_URL` environment variable.
`--datahub-token`	Optional, TEXT	The DataHub personal access token used to authenticate to GMS. Required for DataHub Cloud / auth-enabled instances; omit for a local instance with metadata service auth disabled. Can be set via `DATAHUB_GMS_TOKEN` environment variable.
`--target-platform`	Required, TEXT	The data warehouse platform the dbt models run on (e.g. snowflake, bigquery, redshift). Can be set via `DATAHUB_TARGET_PLATFORM` environment variable.
`--domain`	Optional, TEXT	Optional DataHub domain URN to associate the pushed assets with (e.g. urn:li:domain:sales). Can be set via `DATAHUB_DOMAIN` environment variable.
`--paradime-resources-directory`	Optional, TEXT	The directory where the paradime resources are stored. Can be set via `PARADIME_RESOURCES_DIRECTORY` environment variable.
`--json`	Optional, Flag	Output results as JSON. Default: `False`.
`--help`	Optional, Flag	Show the help message and exit.

Recommended SetupFor security and convenience, set your DataHub configuration as environment variables:

DATAHUB_GMS_URL="https://your-instance.acryl.io/gms"
DATAHUB_GMS_TOKEN="your_personal_access_token"
DATAHUB_TARGET_PLATFORM="snowflake"

Usage Example

# Push dbt™ artifacts to DataHub (using environment variables)
paradime run datahub-artifacts-push

# Or with explicit flags
paradime run datahub-artifacts-push \
  --datahub-server "https://your-instance.acryl.io/gms" \
  --datahub-token "your_personal_access_token" \
  --target-platform "snowflake"

Environment Variable Reference

Environment Variable	Description
`DATAHUB_GMS_URL`	The DataHub GMS server URL
`DATAHUB_GMS_TOKEN`	The DataHub personal access token used to authenticate to GMS
`DATAHUB_TARGET_PLATFORM`	The data warehouse platform the dbt models run on
`DATAHUB_DOMAIN`	Optional DataHub domain URN to associate the pushed assets with
`PARADIME_RESOURCES_DIRECTORY`	The directory where the paradime resources are stored