caretta Help

Installation and build

This page covers development and release build flows for caretta.

Build from source

From repository root:

cargo build

This produces a debug build for fast local iteration.

Run locally

Show command-line help:

cargo run -- --help

Launch the desktop app:

cargo run -- gui

Release build with bundled runtime

cargo build --release --features bundle-runtime

The bundle-runtime feature embeds the agent runtime archive into the binary. This is disabled by default to keep development builds fast.

Without bundle-runtime, caretta loads runtime assets from crates/agent-runtime/node_modules at runtime.

Formatting and lint checks

Run these before creating a pull request:

cargo fmt --all cargo clippy --workspace --all-targets -- -D warnings

Workspace tests

Run the full suite:

cargo test --workspace

Run a targeted tracker test subset while iterating:

cargo test agent::tracker::tests::

Optional verification scripts

Install local pre-commit hooks:

./scripts/setup-hooks.sh

Run smoke checks when changing install or CLI behavior:

./scripts/smoke-test.sh

Build output expectations

  • cargo build compiles all crates in debug mode.

  • cargo build --release --features bundle-runtime emits a standalone binary.

  • cargo test --workspace validates cross-crate behavior.

  • cargo clippy ... -D warnings ensures no lint warnings are left unresolved.

Last modified: 02 July 2026