Skip to content

Usage

over is the standalone CLI. Its git subcommand group (over git mount/add/status) integrates the same overlay model with git workflows.

over

Command Description
over add Add files or directories to an overlay
over new Create a new overlay
over list (ls) List known overlays
over show Display details about an overlay
over apply Apply a given overlay
over lint Check overlays for configuration issues
over doctor Check the environment and overlays for issues
over completion Generate shell completion scripts
over status Get the current repository/directory overlays status
over diff Show differences between desired and actual overlay state
over sync Reconcile a checkout-materialized overlay with its git source
over unapply Remove a given overlay's own entries from the target
over commit Commit local changes in a checkout-materialized overlay back to its source repository
over log Show the git history behind a checkout-materialized overlay

over git

Command Description
over git mount Mount the current git repository to an overlay
over git add Add files from the current git repository to an overlay
over git status Show overlay status for the current git repository

Every over subcommand, including the git group, accepts -H/--home (or the OVER_HOME environment variable) to point at the overlays root, and -d/--debug, -v/--verbose for diagnostics.