CLI Reference

This page provides documentation for our command line tools.

opensampl-server

Command line interface for the opensampl server.

Usage:

opensampl-server [OPTIONS] COMMAND [ARGS]...

Options:

  --env-file PATH  Path to the file with cli configuration settings defined
  --help           Show this message and exit.

down

Stop the opensampl server.

Usage:

opensampl-server down [OPTIONS] [EXTRA_ARGS]...

Options:

  --help  Show this message and exit.

logs

Show the logs from the opensampl server.

Usage:

opensampl-server logs [OPTIONS]

Options:

  --help  Show this message and exit.

ps

Docker compose ps of the opensampl server

Usage:

opensampl-server ps [OPTIONS]

Options:

  --help  Show this message and exit.

run

Run command: add anything you would after docker compose run

Usage:

opensampl-server run [OPTIONS] [RUN_COMMANDS]...

Options:

  --help  Show this message and exit.

up

Start the opensampl server. Configures the local environment to use the backend

Usage:

opensampl-server up [OPTIONS] [EXTRA_ARGS]...

Options:

  --help  Show this message and exit.