This file points to repository-specific rules and family-wide sources. It is not a standalone style guide.
| Document | Use it for |
|---|---|
| Golden principles | Mechanically enforced safety and package rules |
| Architecture | Package graph, composition, identities, and structural tests |
| Adding a read domain | A new Google API read surface |
| Adding a write surface | Write-capable client and command extensions |
| Workspace administrators | Organization-managed OAuth setup for both binaries |
The source of truth is the cli-common documentation. A local convenience copy may exist at ../cli-common/docs.
| Document | Use it for |
|---|---|
| Repository layout | Repository shape, required files, Go policy, Make targets, and commit hygiene |
| CI | CI behavior and required checks |
| Distribution | Packaging and installation channels |
| Release | Release triggers, tags, and publishing |
| Command surface | Commands, arguments, flags, prompts, aliases, and mutation safety |
| Output and rendering | Text output, JSON carve-outs, streams, color, and pagination |
| Scriptability | Non-interactive setup and automation behavior |
| Working with secrets | Credential ingress, keyrings, migrations, redaction, and no-leak testing |
| Working with state | Config/cache locations, credential references, migrations, and hermetic tests |
Reusable actions and workflows live in https://github.com/open-cli-collective/.github. A local convenience copy may exist at ../.github.
Repository-specific constraints belong here; family-wide changes belong in the relevant source above.