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:

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

divbase-cli config create

Create a user configuration file for divbase-cli.

Usage:

$ divbase-cli config create [OPTIONS]

Options:

  • -c, --config PATH: Where to store your config file locally on your pc. [default: /home/runner/.config/divbase/config.yaml]
  • --help: Show this message and exit.

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 TEXT: DivBase API URL associated with this project. [default: http://localhost:8000/api]
  • -d, --default: Set this project as the default project in your config file.
  • -c, --config PATH: Path to your user configuration file. If you didn't specify a custom path when you created it, you don't need to set this. [default: /home/runner/.config/divbase/config.yaml]
  • --help: Show this message and exit.

divbase-cli config remove

Remove a project from your user configuration file.

Usage:

$ divbase-cli config remove [OPTIONS] NAME

Arguments:

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

Options:

  • -c, --config PATH: Path to your user configuration file. If you didn't specify a custom path when you created it, you don't need to set this. [default: /home/runner/.config/divbase/config.yaml]
  • --help: Show this message and exit.

divbase-cli config set-default

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

Usage:

$ divbase-cli config set-default [OPTIONS] NAME

Arguments:

  • NAME: Name of the project to add to the user configuration file. [required]

Options:

  • -c, --config PATH: Path to your user configuration file. If you didn't specify a custom path when you created it, you don't need to set this. [default: /home/runner/.config/divbase/config.yaml]
  • --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:

  • -c, --config PATH: Path to your user configuration file. If you didn't specify a custom path when you created it, you don't need to set this. [default: /home/runner/.config/divbase/config.yaml]
  • --help: Show this message and exit.

divbase-cli config set-dload-dir

Set the default download dir

Usage:

$ divbase-cli config set-dload-dir [OPTIONS] DOWNLOAD_DIR

Arguments:

  • DOWNLOAD_DIR: Set the default directory to download files to. By default files are downloaded to the current working directory. You can specify an absolute path. You can use '.' to refer to the directory you run the command from. [required]

Options:

  • -c, --config PATH: Path to your user configuration file. If you didn't specify a custom path when you created it, you don't need to set this. [default: /home/runner/.config/divbase/config.yaml]
  • --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:

  • -c, --config PATH: Path to your user configuration file. If you didn't specify a custom path when you created it, you don't need to set this. [default: /home/runner/.config/divbase/config.yaml]
  • --help: Show this message and exit.