Skip to content

CLI Command Reference

Catalyst provides a suite of subcommands to manage the entire project lifecycle.

Command Description
add Add a dependency to the project.
bench Execute project benchmarks.
build Build the project.
clean Remove build artifacts.
doc Build a package's documentation.
download Download, build, and install a project from git.
fetch Fetch remote dependencies.
fmt Format source code.
generate Generate build scripts (Ninja, Make, etc.).
ide-sync Sync IDE configuration files for an existing project.
init Initialize a new project or profile.
install Install build artifacts.
lock Pin dependency versions to a lockfile.
pack Assemble the local package for distribution.
profile-ls List all available profiles in the current workspace.
run Run the built executable.
test Run project tests.
tidy Run static analysis.

Global Options

These options apply to all commands:

  • -v, --version: Print version information.
  • -V, --verbose: Enable verbose logging (debug output).
  • -h, --help: Print help message.