CLI Reference

Global Options

The top-level dits parser accepts only help and version:

-h, --help       Show help
-V, --version    Show the Dits version

Subcommands define their own flags. --verbose, --quiet, --no-color, --json, -C, and command-scoped config overrides are not global options.

Command Categories

Commands are organized into logical categories. Click on a category to see detailed documentation for each command.

Quick Reference Table

All commands at a glance. Use the category pages above for detailed documentation with examples and options.

Environment Variables

Commit identity is the only Dits-specific input currently read from the environment. General environment-based configuration overrides are not implemented.

Hook subprocesses receive DITS_DIR and DITS_HOOK as context. Setting DITS_DIR before running the CLI does not redirect repository discovery. See the environment reference for unsupported names that appeared in older drafts.

Exit Codes

The current CLI distinguishes success, runtime failure, and parser usage failure. It does not implement the detailed authentication, network, repository, lock, or merge-conflict code taxonomy shown in older drafts.

Common Workflows

Initial Setup

# Set the identity currently consumed by commits
export DITS_AUTHOR_NAME="Your Name"
export DITS_AUTHOR_EMAIL="you@example.com"

# Clone an existing local repository
dits clone /path/to/existing-repository project
cd project

# Or initialize a new one
dits init my-new-project
cd my-new-project

Daily Workflow

# Check what's changed
dits status

# Work on your files...

# Stage and commit changes
dits add footage/scene01.mov
dits commit -m "Color grade scene 1"

# Inspect local history
dits log

Experimental local FUSE build

Mount and unmount are absent from default binaries. Source builds can enable the experimental local fuser feature on a machine with the required OS FUSE support. This is not remote or on-demand hydration.

cargo build --locked --release -p dits --features fuser
./target/release/dits mount /mnt/project
./target/release/dits unmount /mnt/project

Working with Video

# Inspect video structure
dits inspect footage/hero.mov

# Check deduplication stats
dits inspect-file footage/hero.mov

# Generate proxy files for offline editing
dits proxy-generate --resolution 1080p footage/

# Check proxy status
dits proxy-status

Related Topics

• Getting Started - Quick start guide
• Configuration - Configure Dits behavior
• Core Concepts - Understanding how Dits works