# Rift Documentation > Reference for Rift copy-on-write development workspaces: CLI commands, JavaScript FFI API, registry metadata, platform copy backends, and workspace lifecycle operations. This is a Grok-Wiki source-grounded repository documentation set. Use the complete Markdown link when an agent needs the full repo context. ## Context Links - [Complete Markdown docs](https://www.grok-wiki.com/public/docs/anomalyco-rift-ea3fd5dbf662/llms-full.txt) - [Complete Markdown alias](https://www.grok-wiki.com/public/docs/anomalyco-rift-ea3fd5dbf662.md) - [Human interactive docs](https://www.grok-wiki.com/public/docs/anomalyco-rift-ea3fd5dbf662) - [GitHub repository](https://github.com/anomalyco/rift) ## Repository - Repository: anomalyco/rift - Generated: 2026-06-17T23:36:20.738Z - Updated: 2026-06-18T05:51:33.347Z - Runtime: Grok CLI - Format: Documentation - Pages: 19 ## Pages - [Overview](https://www.grok-wiki.com/public/docs/anomalyco-rift-ea3fd5dbf662/pages/01-overview.md): What Rift exposes (CLI, npm package, FFI), supported platforms and backends, and the shortest path from init to create. - [Installation](https://www.grok-wiki.com/public/docs/anomalyco-rift-ea3fd5dbf662/pages/02-installation.md): Install via npm/bun global package or Cargo build script; platform support matrix and prebuilt binary layout. - [Quickstart](https://www.grok-wiki.com/public/docs/anomalyco-rift-ea3fd5dbf662/pages/03-quickstart.md): Initialize a source workspace, create a filtered copy-on-write child, list it, and remove it with expected stdout signals. - [Workspaces and registry](https://www.grok-wiki.com/public/docs/anomalyco-rift-ea3fd5dbf662/pages/04-workspaces-and-registry.md): Managed workspace model: ULID identity, `.rift` markers, SQLite registry schema, parent-child provenance tree, and upward resolution. - [Copy strategies and platforms](https://www.grok-wiki.com/public/docs/anomalyco-rift-ea3fd5dbf662/pages/05-copy-strategies-and-platforms.md): Platform-specific copy-on-write backends (btrfs subvolumes, Linux reflinks, APFS clonefile), filtered vs exact copy modes, and unsupported platforms. - [Storage layout](https://www.grok-wiki.com/public/docs/anomalyco-rift-ea3fd5dbf662/pages/06-storage-layout.md): Default `.rifts` sibling storage, custom `--into` paths, trash relocation naming, and central SQLite database location. - [Git integration](https://www.grok-wiki.com/public/docs/anomalyco-rift-ea3fd5dbf662/pages/07-git-integration.md): Git repository detection, detached HEAD behavior, marker exclusion, unsafe source states, and preserved index/working-tree semantics. - [Initialize a workspace](https://www.grok-wiki.com/public/docs/anomalyco-rift-ea3fd5dbf662/pages/08-initialize-a-workspace.md): Run `rift init` with Git-root vs `--here` selection, btrfs subvolume conversion progress, marker restoration, and success signals. - [Create workspaces](https://www.grok-wiki.com/public/docs/anomalyco-rift-ea3fd5dbf662/pages/09-create-workspaces.md): Create child workspaces with `--name`, `--into`, filtered vs `--copy-all` copy, `--no-hooks`, random name generation, and Git preparation. - [Manage and remove workspaces](https://www.grok-wiki.com/public/docs/anomalyco-rift-ea3fd5dbf662/pages/10-manage-and-remove-workspaces.md): List children, trace ancestors, remove created rifts to trash, unregister source roots with `-f`, `--children` mode, and `rift gc` physical deletion. - [Shell integration](https://www.grok-wiki.com/public/docs/anomalyco-rift-ea3fd5dbf662/pages/11-shell-integration.md): Install Bash, Zsh, or Nushell wrappers via `rift shell-init` for automatic `cd` after init, create, and remove operations. - [Postcreate hooks](https://www.grok-wiki.com/public/docs/anomalyco-rift-ea3fd5dbf662/pages/12-postcreate-hooks.md): Configure `.rift.toml` v1 postcreate hooks, hook environment variables, sequential execution, and failure behavior after workspace registration. - [CLI reference](https://www.grok-wiki.com/public/docs/anomalyco-rift-ea3fd5dbf662/pages/13-cli-reference.md): All `rift` subcommands, flags, defaults, stdout/stderr behavior, hidden `--database` and `--shell-cwd` flags, and exit codes. - [JavaScript API reference](https://www.grok-wiki.com/public/docs/anomalyco-rift-ea3fd5dbf662/pages/14-javascript-api-reference.md): `rift-snapshot` exports, Bun vs Node conditional bindings, FFI request protocol, function signatures, and Node.js 26.1+ FFI requirements. - [Configuration reference](https://www.grok-wiki.com/public/docs/anomalyco-rift-ea3fd5dbf662/pages/15-configuration-reference.md): `.rift.toml` schema: `version`, `hooks.postcreate` array, validation rules, and CLI/API hook skip flags. - [Error codes](https://www.grok-wiki.com/public/docs/anomalyco-rift-ea3fd5dbf662/pages/16-error-codes.md): Complete `RiftError` code catalog from FFI and TypeScript bindings, CLI user-facing messages, and path-bearing error variants. - [Troubleshooting](https://www.grok-wiki.com/public/docs/anomalyco-rift-ea3fd5dbf662/pages/17-troubleshooting.md): Common failure modes: uninitialized workspaces, missing markers, CoW unavailable, unsafe Git state, hook failures, and platform limitations. - [Development](https://www.grok-wiki.com/public/docs/anomalyco-rift-ea3fd5dbf662/pages/18-development.md): Build and test the Rust workspace, install the CLI locally, CI test matrix, and filesystem integration test environment variables. - [Benchmarking](https://www.grok-wiki.com/public/docs/anomalyco-rift-ea3fd5dbf662/pages/19-benchmarking.md): Measure `rift create` performance with `create` and `compare` Cargo benches, sample counts, JSON output schema, and candidate comparison workflow. ## Source Files - `.github/workflows/ci.yml` - `.github/workflows/release.yml` - `Cargo.toml` - `crates/cli/src/main.rs` - `crates/cli/tests/filesystem_e2e.rs` - `crates/core/benches/AUTORESEARCH.md` - `crates/core/benches/compare.rs` - `crates/core/benches/create.rs` - `crates/core/Cargo.toml` - `crates/core/src/config.rs` - `crates/core/src/filter.rs` - `crates/core/src/git.rs` - `crates/core/src/hook.rs` - `crates/core/src/id.rs` - `crates/core/src/lib.rs` - `crates/core/src/marker.rs` - `crates/core/src/name.rs` - `crates/core/src/registry.rs` - `crates/core/src/strategy/apfs.rs` - `crates/core/src/strategy/btrfs.rs` - `crates/core/src/strategy/linux.rs` - `crates/core/src/strategy/mod.rs` - `crates/core/src/strategy/reflink.rs` - `crates/ffi/src/lib.rs` - `npm/rift-snapshot/bin/rift.js` - `npm/rift-snapshot/bun/index.js` - `npm/rift-snapshot/index.d.ts` - `npm/rift-snapshot/node/index.js` - `npm/rift-snapshot/package.json` - `README.md` - `scripts/ci/linux-fs.sh` - `scripts/install.sh` - `specs.md`