GWZ Documentation¶
GWZ (Git Workspace Zone) coordinates multiple ordinary Git repositories as one reproducible, inspectable workspace. The workspace root records composition and exact state; member repositories remain normal Git repositories.
Start with the Quick Start to install gwz, create or clone a
workspace, make a cross-repository change, and learn the repository lifecycle.
Choose A Path¶
| I want to… | Read… |
|---|---|
| Install and use GWZ for the first time | Quick Start |
| Understand what GWZ adds to Git | Why GWZ |
| Add, create, detach, attach, or replace a member | Repository Member Lifecycle |
| Build or change GWZ itself | Root Workspaces |
| Embed the engine or build a remote client | gwz-core documentation |
| Script the CLI | Machine Output and CLI Reference |
GWZ resolves the workspace from the current directory, including from inside a
member repository. Use --root <path> only to override that discovery.
Guides¶
- Install: installers, source installs, and release verification.
- Concepts: roots, members, manifests, locks, snapshots, selections, remotes, and progress.
- Workflows: task-oriented multi-repository recipes.
- Repository Member Lifecycle: clone, create, publish, detach, attach, evidence-backed re-add, and replacement.
- Root Workspaces: work in a GWZ-managed development root.
- Troubleshooting: common failures and recovery.
- Agent Bootstrap: the generated
AGENTS_GWZ.mdhint. - Releases: release docs and installer verification.
Reference¶
- CLI Reference: generated root and command help.
- Machine Output: JSON, JSONL, porcelain, and exit codes.
- Command pages: semantics and examples by command.
Terminal help and the generated reference come from the Clap command definitions. Check generated documentation after changing the command surface: