Skip to content

docs: add working-with-state standard; home both standards in-repo #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rianjs merged 2 commits into from
May 19, 2026
Merged

docs: add working-with-state standard; home both standards in-repo #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c8cedf0
docs: add working-with-state standard; home both standards in-repo
rianjs May 19, 2026
8419a6c
docs: de-link cli-deployment-manifest.md refs in working-with-secrets.md
rianjs May 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,20 @@ Shared libraries for the Open CLI Collective CLIs.

`github.com/open-cli-collective/cli-common/credstore` is the shared
credential-store library. It implements the **Open CLI Collective
Secret-Handling Standard** (`working-with-secrets.md`), the source of truth
for how Collective CLIs handle secrets and credentials.
Secret-Handling Standard** ([`docs/working-with-secrets.md`](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:

- [`docs/working-with-secrets.md`](docs/working-with-secrets.md) — secret
state (OS keyring; implemented by `credstore`).
- [`docs/working-with-state.md`](docs/working-with-state.md) — **non-secret**
on-disk state (config + cache) and its rollout plan; companion pillar to
the secrets standard.

The standard is maintained outside this repository and is not published;
this README references it by name and section number rather than by link.
Tracking: epic **INT-310** (Get Claude desktop working for people).

### Status
Expand Down
Loading
Loading