Skip to content

divbase-cli version

Add, view and remove versions representing the state of all files in the entire project at the current timestamp.

Usage:

$ divbase-cli version [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 version entry which...
  • update: Update an existing project version entry's...
  • ls: List all entries in the project versioning...
  • info: Provide detailed information about a user...
  • rm: Delete a version entry in the project...

divbase-cli version add

Add a new project version entry which specifies the current state of all files in the project at the current timestamp.

Usage:

$ divbase-cli version add [OPTIONS] NAME

Arguments:

  • NAME: Name of the version (e.g., semantic version). [required]

Options:

  • --description TEXT: Optional description of the version.
  • -p, --project TEXT: Name of the DivBase project, if not provided uses the default in your DivBase config file
  • --help: Show this message and exit.

divbase-cli version update

Update an existing project version entry's name and/or description.

The files and timestamp associated with a version entry are immutable and cannot be changed. This is by design to ensure version entries are representations of the project's state at the timepoint they were created at. You can create a new version entry to capture the current state of the project instead.

To see your current version entries run: divbase-cli version ls

Usage:

$ divbase-cli version update [OPTIONS] VERSION_NAME

Arguments:

  • VERSION_NAME: Name of the existing version you want to modify [required]

Options:

  • -n, --new-name TEXT: New name for the version. If not specified, the name will remain unchanged.
  • -d, --new-description TEXT: Optional new description of the version. If not specified, the description will remain unchanged.
  • -p, --project TEXT: Name of the DivBase project, if not provided uses the default in your DivBase config file
  • --help: Show this message and exit.

divbase-cli version ls

List all entries in the project versioning file.

Displays version name, creation timestamp, and description for each project version. If you specify --include-deleted, soft-deleted versions will also be shown. Soft-deleted versions can be restored by a DivBase admin within 30 days of deletion.

Usage:

$ divbase-cli version ls [OPTIONS]

Options:

  • -p, --project TEXT: Name of the DivBase project, if not provided uses the default in your DivBase config file
  • --include-deleted / --no-include-deleted: Include soft-deleted versions in the listing. [default: no-include-deleted]
  • -t, --tsv: If set, will print the output in .TSV format for easier programmatic parsing.
  • --help: Show this message and exit.

divbase-cli version info

Provide detailed information about a user specified project version, including all files present and their unique hashes.

Usage:

$ divbase-cli version info [OPTIONS] VERSION

Arguments:

  • VERSION: Specific version to retrieve information for [required]

Options:

  • -p, --project TEXT: Name of the DivBase project, if not provided uses the default in your DivBase config file
  • -t, --tsv: If set, will print the output in .TSV format for easier programmatic parsing.
  • --help: Show this message and exit.

divbase-cli version rm

Delete a version entry in the project versioning table. This does not delete the files themselves.

Deleted version entries older than 30 days will be permanently deleted. You can ask a DivBase admin to restore a deleted version within that time period.

Usage:

$ divbase-cli version rm [OPTIONS] NAME

Arguments:

  • NAME: Name of the version (e.g., semantic version). [required]

Options:

  • -p, --project TEXT: Name of the DivBase project, if not provided uses the default in your DivBase config file
  • --help: Show this message and exit.