cli

Blackline CLI version 0.1.2

Usage:

cli [OPTIONS] COMMAND [ARGS]...

Options:

  --debug / --no-debug  Debug mode
  --version             Show the version and exit.
  --help                Show this message and exit.

debug

Test data store connections.

Usage:

cli debug [OPTIONS]

Options:

  --profile TEXT          Data stores profile to use  [required]
  -p, --project-dir PATH  Project directory, where blackline_project.yml is
                          located  [default: /home/runner/work/blackline-
                          core/blackline-core]
  --help                  Show this message and exit.

init

Initialize a project.

Usage:

cli init [OPTIONS]

Options:

  -p, --project-dir PATH  Project directory, where blackline_project.yml is
                          located  [default: /home/runner/work/blackline-
                          core/blackline-core]
  -n, --name TEXT         Project name  [default: blackline]
  --default-profile TEXT  Default profile to use  [default: default]
  --catalogue-path PATH   Path to the catalogue folder  [default: catalogue]
  --adapters-path PATH    Path to the adapters folder  [default: adapters]
  --help                  Show this message and exit.

report

Report the defined project.

Usage:

cli report [OPTIONS]

Options:

  -p, --project-dir PATH  Project directory, where blackline_project.yml is
                          located  [default: /home/runner/work/blackline-
                          core/blackline-core]
  --help                  Show this message and exit.

run

Run project.

Usage:

cli run [OPTIONS]

Options:

  --profile TEXT                  Data stores profile to use  [required]
  -p, --project-dir PATH          Project directory, where
                                  blackline_project.yml is located  [default:
                                  /home/runner/work/blackline-core/blackline-
                                  core]
  --start-date [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]
                                  Start date for deidentification  [default:
                                  2023-07-20]
  --help                          Show this message and exit.

sample

Create a sample project.

Usage:

cli sample [OPTIONS]

Options:

  -p, --project-dir PATH        Project directory, where blackline_project.yml
                                is located  [default:
                                /home/runner/work/blackline-core/blackline-
                                core/blackline_sample]
  -n, --name TEXT               Project name  [default: blackline_sample]
  --overwrite / --no-overwrite  Overwrite existing project  [default: no-
                                overwrite]
  --default-profile TEXT        Default profile to use  [default: default]
  --data-only / --no-data-only  Only create a sample sqlite database
                                [default: no-data-only]
  --help                        Show this message and exit.