Metaplane CLI

The source code for the CLI can be found on the public GitHub repository.

Installation

If you're using macOS and homebrew, you can install the CLI with the following command:

brew tap metaplane/metaplane
brew install metaplane

Otherwise, the easiest way to install the CLI is by using the provided install script.

/bin/bash -c "$(curl -fsSL https://cli.metaplane.dev/spm/install.sh)"

The script will download the latest binary appropriate for your platform and add it to your PATH for easy access.

If you'd prefer to manually install the CLI, you can download the latest binary for the supported platforms:

After downloading the binary, we recommend adding it to your PATH.

mkdir -p $HOME/.local/bin
curl -LSs https://cli.metaplane.dev/spm/download/macos-arm64/metaplane -o $HOME/.local/bin/metaplane
chmod +x $HOME/.local/bin/metaplane
PATH=$HOME/.local/bin:$PATH

Alternatively, you can run the binary directly from wherever you stored it after downloading it.

./path/to/metaplane

dbt

Generate a UI from the latest dbt run

metaplane dbt ui build

This command will provide a .metaplane directory in the current working directory containing an index.html file that you can open in your browser.

If you're invoking the CLI from outside of your dbt project's root or if your dbt project is configured with a custom target-path, you can run the command with the --target-path flag to specify the path to the dbt run results.

metaplane dbt ui build --target-path /path/to/dbt/target

CI/CD usage

While it's useful to visualize runs that were executed locally, it's often more useful to visualize runs that were executed in a CI/CD pipeline.

The exact steps will vary depending on your CI/CD provider, but the following is an example of how you might generate the UI report in a GitHub Actions workflow.

- name: run dbt
  run: dbt run

- name: install metaplane cli
  run: |
    /bin/bash -c "$(curl -fsSL https://cli.metaplane.dev/spm/install.sh)"

- name: generate dbt results ui
  run: metaplane dbt ui build

- uses: actions/upload-artifact@v4
  with:
    name: metaplane-dbt-report
    path: .metaplane/index.html

The actions/upload-artifact action is used to upload and associated the generated UI as an artifact to the workflow run. This allows you to download the after the workflow has completed.

If you're not using GitHub Actions, the steps will still be roughly the same but you'll need to figure out how to store the generated artifact. For example, CircleCI supports storing artifacts which you could then download and view after the workflow has completed.

You can also choose to upload the artifact to S3 or another storage service and then download it from there.