README
¶
cli-common
Shared libraries for the Open CLI Collective CLIs.
credstore
github.com/open-cli-collective/cli-common/credstore is the shared
credential-store library. It implements the Open CLI Collective
Secret-Handling Standard (docs/working-with-secrets.md),
the source of truth for how Collective CLIs handle secrets and credentials.
Standards
The Collective's cross-CLI standards are versioned here, alongside the code
they govern, so consumers pin them with the same module version. See
docs/README.md for a one-line "use this when…" index:
docs/working-with-secrets.md— secret state (OS keyring; implemented bycredstore).docs/working-with-state.md— non-secret on-disk state (config + cache) and its rollout plan; companion pillar to the secrets standard.docs/command-surface.md— command-tree shape: verbs, positional-vs-flag, mutation safety, prompt classes, async, flag conventions.docs/output-and-rendering.md— what a command prints: text-first,--id/--extended/--fulltext/--fields, tables, key:value blocks, ISO-8601, stream discipline, JSON scope, the data ↔ presentation seam.docs/scriptability.md— installer-script ergonomics:initwizard parity,--non-interactive, exit codes, browser-open,--profilereservation.
Tracking: epic INT-310 (Get Claude desktop working for people).
Status
This is an in-progress build (standard §2.1). Implemented so far:
- Credential-ref grammar (§1.3):
ParseRef,FormatRef,EscapeRefSegment, and the §2.1 default-ref codification (DefaultProfile,DefaultRef). A ref is"<service>/<profile>"— two non-empty segments drawn from[A-Za-z0-9_-], joined by a single/. Errors are the typed*RefError, matchable viaerrors.IsagainstErrRefEmpty,ErrRefSegmentCount,ErrRefInvalidChar.
Not yet implemented (separate units of work under INT-310): the OS-keyring
backends (Keychain / Credential Manager / Secret Service / encrypted file),
the Store/Open lifecycle, single-key and bundle operations, SetBundle
atomicity, Linux fail-closed backend classification, redaction helpers, and
legacy-migration helpers.
Development
make check # tidy + lint + test
Requires Go 1.24+ and golangci-lint (v2). The module is standard-library
only; there is no go.sum.
License
MIT — see LICENSE.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cache is the directory-agnostic tier-1 cache core (working-with-state.md §5b): a self-describing JSON envelope with atomic temp-file-rename writes, version-mismatch-as-miss, and freshness classification.
|
Package cache is the directory-agnostic tier-1 cache core (working-with-state.md §5b): a self-describing JSON envelope with atomic temp-file-rename writes, version-mismatch-as-miss, and freshness classification. |
|
Package credstore is the shared credential-store library for Open CLI Collective CLIs.
|
Package credstore is the shared credential-store library for Open CLI Collective CLIs. |
|
Package statedir is the shared path/dir resolver for non-secret on-disk state (working-with-state.md §5a).
|
Package statedir is the shared path/dir resolver for non-secret on-disk state (working-with-state.md §5a). |
|
Package statedirtest provides the single hermetic environment helper for state-component tests (working-with-state.md §3.1).
|
Package statedirtest provides the single hermetic environment helper for state-component tests (working-with-state.md §3.1). |