Skip to content

catalyst build

build the project
Usage: catalyst build [OPTIONS]

Options:
  -h,--help                   Print this help message and exit
  -r,--regen                  Regenerate the build file
  -b,--force-rebuild          Recompile dependencies
  --force-refetch             Refetch dependencies
  --workspace,--all           Build all members in the workspace
  -w,--watch                  Continuous build mode. Rebuilds on source file changes
  -P,--package TEXT           Build a specific package from the root
  -p,--profiles TEXT ...      Profile composition to build (default: common)
  -f,--features TEXT ...      Features to enable
  --backend TEXT              Backend to use for generation (ninja, gmake, cbe)

Details

When running with --workspace or --all, Catalyst determines the correct build order based on the dependencies between workspace members. It ensures that dependencies are built before the packages that rely on them.

Examples

Standard build:

catalyst build

Workspace build: Build all packages in the current workspace, automatically ordering them by dependency.

catalyst build --workspace

Build specific package: Build only the app package and its dependencies within the workspace.

catalyst build --package app

Debug build:

catalyst build --profiles debug

Force clean build:

catalyst build --force-rebuild

Enable features:

catalyst build --features logging

Gmake backend:

catalyst build --backend gmake

Disable features:

catalyst build --features no-logging

Watch mode: Continuously watch source and include directories for file changes and automatically rebuild.

catalyst build --watch

Watch mode can be combined with other flags:

catalyst build --watch --profiles debug

Press Ctrl+C to stop watching.