refter-cli

CLI Commands

Available commands for refter-cli. You can also run refter --help to see all available options.

• validate
• deploy

Global options

--help/-h

See all available client options by running refter --help.

validate

--manifest/-m

(Optional) The path to the manifest file that should be deployed to Refter. Defaults to target/manifest.json.

Example:

refter validate --manifest dbt-sub-project/target/manifest.json

deploy

--manifest/-m

(Optional) The path to the manifest file that should be deployed to Refter. Defaults to target/manifest.json.

Example:

refter validate --manifest dbt-sub-project/target/manifest.json

--token/-t

(Required) The API key that should be used to authenticate with refter. You can find your API key in the refter dashboard.

Example:

refter deploy --token <your-api-key>

--commit/-c

(Optional) The commit hash that should be used to identify this deployment. Defaults to the current commit hash.

Example:

refter deploy --token <your-api-key> --commit <commit-hash>

--branch/-b

(Optional) The branch that should be used to identify this deployment. Defaults to the current branch.

Example:

refter deploy --token <your-api-key> --branch <branch-name>

info

refter uses the branch and commit options to identify unique deployments. It is recommended to supply these options for production deployments. To learn more about deployments check out the deployment docs. To learn more about setting up CI/CD to automatically deploy your dbt project to refter check out the CI/CD docs.