pluribus-context 0.3.3 → 0.3.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -0
- package/README.md +31 -24
- package/docs/ci-audit-example.md +5 -7
- package/docs/context-drift-audit.md +7 -16
- package/docs/migrate-existing-context.md +3 -3
- package/docs/quickstart.md +17 -3
- package/examples/github-actions/pluribus-audit.yml +1 -2
- package/package.json +4 -1
- package/src/utils/version.js +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -4,6 +4,22 @@
|
|
|
4
4
|
|
|
5
5
|
All notable changes to Pluribus are documented here.
|
|
6
6
|
|
|
7
|
+
## 0.3.5 — trust copy package-page refresh
|
|
8
|
+
|
|
9
|
+
### Changed
|
|
10
|
+
|
|
11
|
+
- Clarify installation, uninstallation, and network behavior in the README and quickstart so first-run reviewers can verify the CLI without guessing what persists or when remote imports make network requests.
|
|
12
|
+
- Add release-gate checks for uninstall/network transparency copy before future docs or package-page updates.
|
|
13
|
+
|
|
14
|
+
## 0.3.4 — npm package page README refresh prep
|
|
15
|
+
|
|
16
|
+
### Changed
|
|
17
|
+
|
|
18
|
+
- Replace pre-publish GitHub-tag workaround commands in README, quickstart, migration, CI audit, and drift-audit docs with the published `pluribus-context@0.3.3` npm path now that `latest` is current.
|
|
19
|
+
- Let `release:verify` run as a post-publish verification gate when npm `latest` already matches `package.json`, while preserving unreleased-copy checks when `main` is ahead of npm.
|
|
20
|
+
- Mark this docs-only patch as copy-paste compatible with `pluribus-context@0.3.3`, so the release gate can prepare a package-page README refresh without forcing temporary GitHub-tag workaround commands back into docs that already work on the current npm package.
|
|
21
|
+
- Extend `published:smoke` to reject the stale `github:caioribeiroclw-pixel/pluribus#v0.3.3` package-page workaround once npm `latest` reaches `0.3.4`.
|
|
22
|
+
|
|
7
23
|
## 0.3.3 — Publish-window rehearsal hardening
|
|
8
24
|
|
|
9
25
|
### Changed
|
package/README.md
CHANGED
|
@@ -73,8 +73,6 @@ And it generates the right files for each tool:
|
|
|
73
73
|
|
|
74
74
|
## Getting Started
|
|
75
75
|
|
|
76
|
-
> **Version note:** `pluribus audit` is published in `pluribus-context@0.3.0`. The CI-oriented audit flags and read-only init preview documented in the GitHub release tag `v0.3.3` (`--json`, `--output`, `--github-annotations`, `--ci`, `init --dry-run`) are prepared for the next npm patch release `0.3.3`; until that patch is published, use `@0.3.0` for the basic read-only audit, or use the explicit `github:...#v0.3.3` source command shown below when testing the tagged read-only preview flags.
|
|
77
|
-
|
|
78
76
|
### Pick the safe first command
|
|
79
77
|
|
|
80
78
|
If your repo already has AI context files such as `CLAUDE.md`, `.cursorrules`, Copilot instructions, or `AGENTS.md`, start with the read-only audit:
|
|
@@ -88,10 +86,10 @@ It does not write files. Without `pluribus.md`, it lists existing AI context sur
|
|
|
88
86
|
If you are starting from scratch, preview the source-of-truth scaffold first, then create it when it looks right:
|
|
89
87
|
|
|
90
88
|
```bash
|
|
91
|
-
#
|
|
92
|
-
npx --yes
|
|
89
|
+
# Preview only; does not write files:
|
|
90
|
+
npx --yes pluribus-context@latest init --dry-run
|
|
93
91
|
|
|
94
|
-
#
|
|
92
|
+
# Write pluribus.md when the preview looks right:
|
|
95
93
|
npx --yes pluribus-context@latest init
|
|
96
94
|
```
|
|
97
95
|
|
|
@@ -107,29 +105,42 @@ Pluribus is intentionally narrow about filesystem changes:
|
|
|
107
105
|
|
|
108
106
|
When in doubt, run `npx --yes pluribus-context@latest audit` or `npx --yes pluribus-context@latest sync --dry-run` first.
|
|
109
107
|
|
|
110
|
-
### Install
|
|
108
|
+
### Install, uninstall, and network behavior
|
|
111
109
|
|
|
112
110
|
```bash
|
|
113
111
|
# Install globally if you prefer a persistent `pluribus` command
|
|
114
112
|
npm install -g pluribus-context@latest
|
|
115
113
|
pluribus --help
|
|
116
114
|
|
|
117
|
-
#
|
|
115
|
+
# Remove the global CLI later
|
|
116
|
+
npm uninstall -g pluribus-context
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
For local development:
|
|
120
|
+
|
|
121
|
+
```bash
|
|
118
122
|
git clone https://github.com/caioribeiroclw-pixel/pluribus.git
|
|
119
123
|
cd pluribus
|
|
120
124
|
npm link
|
|
125
|
+
|
|
126
|
+
# Remove the local global link later
|
|
127
|
+
npm unlink -g pluribus-context
|
|
121
128
|
```
|
|
122
129
|
|
|
130
|
+
One-off `npx --yes pluribus-context@latest ...` commands install into npm's normal temporary cache and do not create a persistent global `pluribus` command.
|
|
131
|
+
|
|
132
|
+
Pluribus does **not** make network requests during normal `audit`, `validate`, `sync`, or `sync --dry-run` runs. Network access is opt-in for remote imports only when you explicitly pass `--update-imports`; those fetches are limited to `github:`/HTTPS imports, then pinned in `pluribus.lock.json` and cached locally for deterministic offline syncs. Private GitHub imports may use `GH_TOKEN`/`GITHUB_TOKEN` or `gh auth token` during that explicit refresh, but tokens are never written to the lockfile or cache.
|
|
133
|
+
|
|
123
134
|
### 60-second smoke test
|
|
124
135
|
|
|
125
136
|
Want to see exactly what gets generated before adding it to a real project?
|
|
126
137
|
|
|
127
138
|
```bash
|
|
128
139
|
mkdir pluribus-demo && cd pluribus-demo
|
|
129
|
-
#
|
|
130
|
-
npx --yes
|
|
140
|
+
# Preview only; does not write files:
|
|
141
|
+
npx --yes pluribus-context@latest init --dry-run --name "Ana" --description "A Node.js service" --tools claude,cursor,copilot
|
|
131
142
|
|
|
132
|
-
#
|
|
143
|
+
# Write pluribus.md when the preview looks right:
|
|
133
144
|
npx --yes pluribus-context@latest init --name "Ana" --description "A Node.js service" --tools claude,cursor,copilot
|
|
134
145
|
npx --yes pluribus-context@latest validate
|
|
135
146
|
npx --yes pluribus-context@latest sync --dry-run
|
|
@@ -145,10 +156,10 @@ For a fuller walkthrough, see the [Quickstart](docs/quickstart.md). To enforce g
|
|
|
145
156
|
|
|
146
157
|
```bash
|
|
147
158
|
cd your-project/
|
|
148
|
-
#
|
|
149
|
-
npx --yes
|
|
159
|
+
# Preview only; does not write files:
|
|
160
|
+
npx --yes pluribus-context@latest init --dry-run
|
|
150
161
|
|
|
151
|
-
#
|
|
162
|
+
# Write pluribus.md when the preview looks right:
|
|
152
163
|
npx --yes pluribus-context@latest init
|
|
153
164
|
```
|
|
154
165
|
|
|
@@ -157,10 +168,10 @@ The dry-run prints the scaffold without writing files. The second command create
|
|
|
157
168
|
You can also use flags for non-interactive init, including the same dry-run preview:
|
|
158
169
|
|
|
159
170
|
```bash
|
|
160
|
-
#
|
|
161
|
-
npx --yes
|
|
171
|
+
# Preview only; does not write files:
|
|
172
|
+
npx --yes pluribus-context@latest init --dry-run --name "Ana" --description "A background job runner" --tools claude,cursor,openclaw
|
|
162
173
|
|
|
163
|
-
#
|
|
174
|
+
# Write pluribus.md when the preview looks right:
|
|
164
175
|
npx --yes pluribus-context@latest init --name "Ana" --description "A background job runner" --tools claude,cursor,openclaw
|
|
165
176
|
```
|
|
166
177
|
|
|
@@ -234,29 +245,25 @@ pluribus audit --strict
|
|
|
234
245
|
In GitHub Actions, add annotations so drift appears inline in the check UI:
|
|
235
246
|
|
|
236
247
|
```bash
|
|
237
|
-
|
|
238
|
-
npx --yes --package github:caioribeiroclw-pixel/pluribus#v0.3.3 pluribus audit --strict --github-annotations
|
|
248
|
+
npx --yes pluribus-context@latest audit --strict --github-annotations
|
|
239
249
|
```
|
|
240
250
|
|
|
241
251
|
For GitHub Actions, `--ci` is the shorter equivalent of `--strict --github-annotations`:
|
|
242
252
|
|
|
243
253
|
```bash
|
|
244
|
-
|
|
245
|
-
npx --yes --package github:caioribeiroclw-pixel/pluribus#v0.3.3 pluribus audit --ci
|
|
254
|
+
npx --yes pluribus-context@latest audit --ci
|
|
246
255
|
```
|
|
247
256
|
|
|
248
257
|
For CI scripts, dashboards, or migration tooling, use machine-readable output:
|
|
249
258
|
|
|
250
259
|
```bash
|
|
251
|
-
|
|
252
|
-
npx --yes --package github:caioribeiroclw-pixel/pluribus#v0.3.3 pluribus audit --strict --json
|
|
260
|
+
npx --yes pluribus-context@latest audit --strict --json
|
|
253
261
|
```
|
|
254
262
|
|
|
255
263
|
To save the JSON as a CI artifact while keeping stdout quiet, add `--output`:
|
|
256
264
|
|
|
257
265
|
```bash
|
|
258
|
-
|
|
259
|
-
npx --yes --package github:caioribeiroclw-pixel/pluribus#v0.3.3 pluribus audit --strict --json --output pluribus-audit.json
|
|
266
|
+
npx --yes pluribus-context@latest audit --strict --json --output pluribus-audit.json
|
|
260
267
|
```
|
|
261
268
|
|
|
262
269
|
The JSON shape is documented in [`schemas/audit-result.schema.json`](schemas/audit-result.schema.json) so CI wrappers and dashboards can validate integrations without scraping human output. For copy-paste enforcement, see the [CI audit example](docs/ci-audit-example.md) and the [Pre-commit Audit Hook](docs/pre-commit-audit.md).
|
package/docs/ci-audit-example.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Use this when `pluribus.md` is the source of truth and generated context files should stay current in pull requests.
|
|
4
4
|
|
|
5
|
-
`pluribus audit --strict` is read-only: it fails when a generated file is missing or drifted, but it does not rewrite anything in CI. The
|
|
5
|
+
`pluribus audit --strict` is read-only: it fails when a generated file is missing or drifted, but it does not rewrite anything in CI. The `--github-annotations`, `--json`, `--output`, and `--ci` flags are published in `pluribus-context@0.3.3` and available through the npm `latest` tag.
|
|
6
6
|
|
|
7
7
|
Use `--ci` in GitHub Actions when you want the shortest path: it is equivalent to `--strict --github-annotations`, so drift appears inline in the check UI and the job fails on drift. Use the explicit flags when composing custom outputs; pair annotations with `--json --output pluribus-audit.json` when you want a machine-readable artifact for dashboards or review comments. The output contract is documented in [`schemas/audit-result.schema.json`](../schemas/audit-result.schema.json).
|
|
8
8
|
|
|
@@ -35,16 +35,14 @@ jobs:
|
|
|
35
35
|
node-version: 22.x
|
|
36
36
|
|
|
37
37
|
- name: Audit AI context drift
|
|
38
|
-
|
|
39
|
-
run: npx --yes --package github:caioribeiroclw-pixel/pluribus#v0.3.3 pluribus audit --ci
|
|
38
|
+
run: npx --yes pluribus-context@latest audit --ci
|
|
40
39
|
```
|
|
41
40
|
|
|
42
41
|
If you want JSON output as an artifact, use this variant:
|
|
43
42
|
|
|
44
43
|
```yaml
|
|
45
44
|
- name: Audit AI context drift as JSON
|
|
46
|
-
|
|
47
|
-
run: npx --yes --package github:caioribeiroclw-pixel/pluribus#v0.3.3 pluribus audit --ci --json --output pluribus-audit.json
|
|
45
|
+
run: npx --yes pluribus-context@latest audit --ci --json --output pluribus-audit.json
|
|
48
46
|
|
|
49
47
|
- name: Upload Pluribus audit result
|
|
50
48
|
if: always()
|
|
@@ -63,8 +61,8 @@ npx --yes pluribus-context@latest audit
|
|
|
63
61
|
npx --yes pluribus-context@latest sync --dry-run
|
|
64
62
|
npx --yes pluribus-context@latest sync
|
|
65
63
|
npx --yes pluribus-context@latest audit --strict
|
|
66
|
-
# In GitHub Actions
|
|
67
|
-
npx --yes
|
|
64
|
+
# In GitHub Actions, use the CI shorthand:
|
|
65
|
+
npx --yes pluribus-context@latest audit --ci
|
|
68
66
|
```
|
|
69
67
|
|
|
70
68
|
Commit `pluribus.md` and the generated files together, or document that your team regenerates generated files during setup. Do not commit `.pluribus/cache/remote/`; commit `pluribus.lock.json` when you use remote imports.
|
|
@@ -18,19 +18,10 @@ Want to see the workflow before touching a real repo? Use the intentionally drif
|
|
|
18
18
|
|
|
19
19
|
## Version availability
|
|
20
20
|
|
|
21
|
-
The
|
|
22
|
-
|
|
23
|
-
The CI-oriented flags in this guide are available in the GitHub release tag `v0.3.3` while npm latest waits for the `0.3.3` publish:
|
|
24
|
-
|
|
25
|
-
- `--json`
|
|
26
|
-
- `--output <file>`
|
|
27
|
-
- `--github-annotations`
|
|
28
|
-
- `--ci`
|
|
29
|
-
|
|
30
|
-
Until `0.3.3` is published to npm, use `npx --yes pluribus-context@0.3.0 audit` for the stable published audit, or run the immutable GitHub tag when you specifically want to test the new CI flags:
|
|
21
|
+
The read-only audit workflow, including `--json`, `--output <file>`, `--github-annotations`, and `--ci`, is published in `pluribus-context@0.3.3` and available through the npm `latest` tag.
|
|
31
22
|
|
|
32
23
|
```bash
|
|
33
|
-
npx --yes
|
|
24
|
+
npx --yes pluribus-context@latest audit --strict --json
|
|
34
25
|
```
|
|
35
26
|
|
|
36
27
|
## 1. Find AI context surfaces
|
|
@@ -123,28 +114,28 @@ After adoption, the simplest check is:
|
|
|
123
114
|
npx --yes pluribus-context@latest audit --strict
|
|
124
115
|
```
|
|
125
116
|
|
|
126
|
-
If you want GitHub Actions to show drift inline in the check UI, add `--github-annotations
|
|
117
|
+
If you want GitHub Actions to show drift inline in the check UI, add `--github-annotations`:
|
|
127
118
|
|
|
128
119
|
```bash
|
|
129
|
-
npx --yes
|
|
120
|
+
npx --yes pluribus-context@latest audit --strict --github-annotations
|
|
130
121
|
```
|
|
131
122
|
|
|
132
123
|
For GitHub Actions, `--ci` is the shorter equivalent of `--strict --github-annotations`:
|
|
133
124
|
|
|
134
125
|
```bash
|
|
135
|
-
npx --yes
|
|
126
|
+
npx --yes pluribus-context@latest audit --ci
|
|
136
127
|
```
|
|
137
128
|
|
|
138
129
|
If you want machine-readable results for CI, dashboards, or a migration script, add `--json`:
|
|
139
130
|
|
|
140
131
|
```bash
|
|
141
|
-
npx --yes
|
|
132
|
+
npx --yes pluribus-context@latest audit --strict --json
|
|
142
133
|
```
|
|
143
134
|
|
|
144
135
|
To save that JSON as an artifact without relying on shell redirection, add `--output`:
|
|
145
136
|
|
|
146
137
|
```bash
|
|
147
|
-
npx --yes
|
|
138
|
+
npx --yes pluribus-context@latest audit --strict --json --output pluribus-audit.json
|
|
148
139
|
```
|
|
149
140
|
|
|
150
141
|
The JSON output includes `ok`, `source`, `results`, `summary`, and `nextStep`, so callers can fail on drift without parsing the human emoji output. The schema lives at [`schemas/audit-result.schema.json`](../schemas/audit-result.schema.json) for CI wrappers, dashboards, and migration tools that want a stable contract. `--output` writes the same JSON payload to disk and keeps stdout quiet. `--ci` is a shorthand for `--strict --github-annotations`. `--github-annotations` writes annotations to stderr, so it can be combined with `--json`/`--output` while preserving a clean artifact. See the [CI audit example](ci-audit-example.md) for a copy-paste GitHub Actions workflow and JSON artifact variant. If you want the same guard before commits leave a developer machine, use the [Pre-commit Audit Hook](pre-commit-audit.md).
|
|
@@ -51,16 +51,16 @@ Move project facts and shared conventions into `pluribus.md`. Keep tool-specific
|
|
|
51
51
|
|
|
52
52
|
## 2. Preview and scaffold `pluribus.md`
|
|
53
53
|
|
|
54
|
-
Preview the scaffold before writing a new source file
|
|
54
|
+
Preview the scaffold before writing a new source file:
|
|
55
55
|
|
|
56
56
|
```bash
|
|
57
|
-
npx --yes
|
|
57
|
+
npx --yes pluribus-context@latest init --dry-run \
|
|
58
58
|
--name "Your project" \
|
|
59
59
|
--description "What this repo does" \
|
|
60
60
|
--tools claude,cursor,copilot,openclaw
|
|
61
61
|
```
|
|
62
62
|
|
|
63
|
-
When the preview looks right, create `pluribus.md
|
|
63
|
+
When the preview looks right, create `pluribus.md`:
|
|
64
64
|
|
|
65
65
|
```bash
|
|
66
66
|
npx --yes pluribus-context@latest init \
|
package/docs/quickstart.md
CHANGED
|
@@ -18,6 +18,20 @@ The safest path is audit → validate → `sync --dry-run` → `sync`. The first
|
|
|
18
18
|
|
|
19
19
|
Remote imports do not refresh silently; Pluribus writes `pluribus.lock.json` and `.pluribus/cache/remote/` only when you explicitly pass `--update-imports`.
|
|
20
20
|
|
|
21
|
+
## Install, uninstall, and network behavior
|
|
22
|
+
|
|
23
|
+
For one-off use, keep using `npx --yes pluribus-context@latest ...`; npm stores that in its normal temporary cache and does not create a persistent global `pluribus` command.
|
|
24
|
+
|
|
25
|
+
If you want a persistent CLI:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
npm install -g pluribus-context@latest
|
|
29
|
+
pluribus --help
|
|
30
|
+
npm uninstall -g pluribus-context
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Normal `audit`, `validate`, `sync`, and `sync --dry-run` runs do not make network requests. Network access only happens when remote imports are present and you explicitly pass `--update-imports`; Pluribus then fetches `github:`/HTTPS imports, pins them in `pluribus.lock.json`, and uses the local cache for later offline syncs. Private GitHub imports can use `GH_TOKEN`/`GITHUB_TOKEN` or `gh auth token` during that explicit refresh, but tokens are never stored in the lockfile or cache.
|
|
34
|
+
|
|
21
35
|
## 1. Create a disposable demo project
|
|
22
36
|
|
|
23
37
|
```bash
|
|
@@ -27,16 +41,16 @@ cd pluribus-demo
|
|
|
27
41
|
|
|
28
42
|
## 2. Preview and scaffold context
|
|
29
43
|
|
|
30
|
-
Start read-only so you can see the template before writing a file
|
|
44
|
+
Start read-only so you can see the template before writing a file:
|
|
31
45
|
|
|
32
46
|
```bash
|
|
33
|
-
npx --yes
|
|
47
|
+
npx --yes pluribus-context@latest init --dry-run \
|
|
34
48
|
--name "Ana" \
|
|
35
49
|
--description "A Node.js service" \
|
|
36
50
|
--tools claude,cursor,copilot
|
|
37
51
|
```
|
|
38
52
|
|
|
39
|
-
When the scaffold looks right, create it
|
|
53
|
+
When the scaffold looks right, create it:
|
|
40
54
|
|
|
41
55
|
```bash
|
|
42
56
|
npx --yes pluribus-context@latest init \
|
|
@@ -22,5 +22,4 @@ jobs:
|
|
|
22
22
|
node-version: 22.x
|
|
23
23
|
|
|
24
24
|
- name: Audit AI context drift
|
|
25
|
-
|
|
26
|
-
run: npx --yes --package github:caioribeiroclw-pixel/pluribus#v0.3.3 pluribus audit --ci
|
|
25
|
+
run: npx --yes pluribus-context@latest audit --ci
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "pluribus-context",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.5",
|
|
4
4
|
"description": "Sync intentional AI context and rules across Claude Code, Cursor, Copilot, OpenClaw, Windsurf, Continue, and Zed.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"homepage": "https://github.com/caioribeiroclw-pixel/pluribus#readme",
|
|
@@ -63,5 +63,8 @@
|
|
|
63
63
|
"license": "MIT",
|
|
64
64
|
"engines": {
|
|
65
65
|
"node": ">=18.0.0"
|
|
66
|
+
},
|
|
67
|
+
"pluribusRelease": {
|
|
68
|
+
"publishedCommandMinimumVersion": "0.3.3"
|
|
66
69
|
}
|
|
67
70
|
}
|
package/src/utils/version.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const VERSION = '0.3.
|
|
1
|
+
export const VERSION = '0.3.5'
|