Skip to content

divbase-cli config

Manage your user configuration file for the DivBase CLI.

Usage:

$ divbase-cli config [OPTIONS] COMMAND [ARGS]...

Options:

  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • add: Add a new project to your user...
  • rm: Remove a project from your user...
  • set-default: Set the default project to use in all...
  • show-default: Print the currently set default project to...
  • set-dload-dir: Set the default download directory in your...
  • show: Pretty print the contents of your current...

divbase-cli config add

Add a new project to your user configuration file.

Usage:

$ divbase-cli config add [OPTIONS] {name}

Arguments:

  • name: Name of the project to add to your config file. [required]

Options:

  • -u, --divbase-url <str>: DivBase API URL associated with this project. [default: https://divbase.scilifelab-2-prod.sys.kth.se/api]
  • -d, --default: Set this project as the default project in your config file.
  • --help: Show this message and exit.

divbase-cli config rm

Remove a project from your user configuration file.

Usage:

$ divbase-cli config rm [OPTIONS] {name}

Arguments:

  • name: Name of the project to remove from your user configuration file. [required]

Options:

  • --help: Show this message and exit.

divbase-cli config set-default

Set the default project to use in all divbase-cli commands.

The project must already be added to your config file using the 'add' command.

Usage:

$ divbase-cli config set-default [OPTIONS] {name}

Arguments:

  • name: Name of the project to set as the default. [required]

Options:

  • --help: Show this message and exit.

divbase-cli config show-default

Print the currently set default project to the console.

Usage:

$ divbase-cli config show-default [OPTIONS]

Options:

  • --help: Show this message and exit.

divbase-cli config set-dload-dir

Set the default download directory in your user configuration file.

This is by default unset, meaning files will be downloaded to the current working directory.

Usage:

$ divbase-cli config set-dload-dir [OPTIONS] {download_dir}

Arguments:

  • download_dir: Directory to download files to by default. If no default is set, files are downloaded to the current working directory. Use an absolute path. To always download to the directory you run each command from, use '.' as the argument. [required]

Options:

  • --help: Show this message and exit.

divbase-cli config show

Pretty print the contents of your current config file.

Usage:

$ divbase-cli config show [OPTIONS]

Options:

  • -t, --tsv: If set, will print the output in TSV format for easier programmatic parsing.
  • --help: Show this message and exit.