Workspace schema
Shared project identity and repository definitions use workspace schema version 3.
A minimal project definition
version: 3
name: Acme
purpose: Billing software
workspace_repository:
url: git@github.com:acme/acme-workspace.git
default_branch: main
repositories:
api:
url: https://git.example.com/acme/api.git
default_branch: main
web:
url: https://git.example.com/acme/web.git
default_branch: main
relationships:
- from: web
to: api
description: Consumes the billing APIThese are example repository addresses. The workspace's own repository is distinct from the implementation repositories map.
version is the workspace schema. Schema 3 is the per-member ID layout, with one .context-circuit/ids/<member>.yaml file per member; a new workspace starts there. A workspace an earlier CLI wrote is at schema 2, with one shared .context-circuit/ids.yaml, and the first changing command of a 2.4.0 or later CLI splits it and moves version to 3. CLIs before 2.4.0 refuse a schema 3 workspace. A template update reads, rather than applies, a delta that changes version: the CLI migrates it.
Optional configuration
| Field | Meaning |
|---|---|
knowledge_repositories | Read-only repositories of borrowed knowledge; shares the logical ID namespace with implementation repositories. |
knowledge_review_days | Additional review threshold for notes without code anchors. |
cli_registry | CLI installer registry: source, repository, and api. Added in 2.1.0. |
Unknown structured fields and duplicate mapping keys are errors. YAML edits retain surrounding comments and ordering where possible; byte-for-byte formatting preservation is not promised.
Local bindings
The local workspace binding records this checkout's path and base branch. bindings maps implementation IDs to their own path and base_branch. Keep paths and member selection out of shared identity. See configuration files.