Command Line Interface

CollectOSS provides a command line interface (CLI) for interacting with your CollectOSS installation. It’s broken up into a few categories: db, backend, util, config, and logging.

Each command is invoked by first specifying the category, then the command name, and then the parameters/options; e.g. the list command under collectoss util would be invoked as uv run collectoss utli list --option1 ....

Note

Throughout this section of the documentation, all lines that start with a $ denote a bash command, and lines with > denote some sample output of command.

• Database Commands
• Backend Commands
• Configuration Commands
• Logging Commands