Reference
Crab CLI Reference
This section contains the complete reference documentation for every Crab CLI command. Each page documents the command's synopsis, arguments, options, behavior, and structured output format.
For conceptual explanations of how these commands fit together, see the topic-oriented sections in the sidebar (Getting Started, Working with Files, Storage Management, etc.).
Commands by Category
File Operations
| Command | Description |
|---|---|
crab add | Stage files for chunking and deduplication |
crab push | Upload staged chunks and refs to cloud storage |
crab fetch | Download remote changes from cloud storage |
crab hydrate | Materialize pointer files into full content |
crab dehydrate | Replace hydrated files with pointer blobs |
crab reset | Unstage files from the Crab staging area |
crab lock | Lock files to prevent concurrent edits |
crab diff | Show content differences between file versions |
Inspection
| Command | Description |
|---|---|
crab status | Report hydration state of tracked files |
crab ls-files | List files tracked by Crab |
crab du | Report disk usage for tracked files |
crab stat | Show detailed statistics for a file |
Repository Setup
| Command | Description |
|---|---|
crab init | Initialize a new Crab repository |
crab clone | Clone a Crab repository from cloud storage |
crab track | Configure file patterns for Crab to manage |
crab import | Import existing cloud buckets as a repository |
Authentication
| Command | Description |
|---|---|
crab login | Authenticate with cloud storage providers |
crab logout | Remove stored authentication credentials |
crab auth status | Display current authentication state |
crab config | Read and write Crab configuration settings |
crab env | Display environment and configuration info |
Storage
| Command | Description |
|---|---|
crab cache | Manage the local chunk cache |
crab staging | Inspect and manage the local staging area |
crab gc | Remove unreachable objects from storage |
crab prune | Remove local copies of remote objects |
crab repack | Repack remote xorbs for optimal layout |
crab compact | Compact metadata and storage layers |
crab tier | Manage storage tier assignments |
crab restripe | Redistribute data across storage stripes |
Virtual Filesystem
| Command | Description |
|---|---|
crab mount | Mount a repository as a FUSE filesystem |
crab lfs | Manage Git LFS compatibility layer |
Automation
| Command | Description |
|---|---|
crab run | Execute a command with content-addressed caching |
crab workflow | Define and run multi-step pipelines |
crab exp | Create and manage experiment runs |
Diagnostics
| Command | Description |
|---|---|
crab doctor | Run health checks on the repository |
crab fsck | Verify repository integrity |
crab errors | Look up error codes and explanations |
crab logs | View and manage diagnostic logs |
crab version | Display Crab version and build information |
Output Formats
| Page | Description |
|---|---|
| Structured Output | JSON/JSONL envelope contract and event types |
| Pricing Tables | Storage cost reference by provider and tier |