pluribus-context 0.3.5 → 0.3.6
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 +6 -0
- package/README.md +1 -1
- package/docs/community-review-packet.md +72 -0
- package/package.json +1 -1
- package/src/utils/version.js +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -4,6 +4,12 @@
|
|
|
4
4
|
|
|
5
5
|
All notable changes to Pluribus are documented here.
|
|
6
6
|
|
|
7
|
+
## 0.3.6 — community review packet package-page refresh
|
|
8
|
+
|
|
9
|
+
### Added
|
|
10
|
+
|
|
11
|
+
- Add a community review packet with listing copy, safety/removability notes, and a disposable 60-second smoke test for reviewers, curators, and small distribution opportunities.
|
|
12
|
+
|
|
7
13
|
## 0.3.5 — trust copy package-page refresh
|
|
8
14
|
|
|
9
15
|
### Changed
|
package/README.md
CHANGED
|
@@ -148,7 +148,7 @@ npx --yes pluribus-context@latest sync --dry-run
|
|
|
148
148
|
|
|
149
149
|
If the preview looks right, run `npx --yes pluribus-context@latest sync` to write the tool-specific files.
|
|
150
150
|
|
|
151
|
-
For a fuller walkthrough, see the [Quickstart](docs/quickstart.md). To enforce generated context files in pull requests, use the [CI audit example](docs/ci-audit-example.md); to catch drift before commits leave your machine, use the [Pre-commit Audit Hook](docs/pre-commit-audit.md). If your repo already has `CLAUDE.md`, `.cursorrules`, Copilot instructions, or `AGENTS.md`, run a [Context Drift Audit](docs/context-drift-audit.md) first, try the intentionally drifted [audit example](examples/context-drift-audit/), then follow [Migrate Existing AI Context Files](docs/migrate-existing-context.md). Before committing shared or generated AI instructions, use the [Context File Review Checklist](docs/context-file-review.md). If you're deciding between Pluribus and a one-way rules converter, see [When to use Pluribus](docs/when-to-use-pluribus.md). If you are debugging "context drift" after compaction or long sessions, start with the [Context Drift Taxonomy](docs/context-drift-taxonomy.md) to separate file drift from runtime precedence drift.
|
|
151
|
+
For a fuller walkthrough, see the [Quickstart](docs/quickstart.md). To enforce generated context files in pull requests, use the [CI audit example](docs/ci-audit-example.md); to catch drift before commits leave your machine, use the [Pre-commit Audit Hook](docs/pre-commit-audit.md). If your repo already has `CLAUDE.md`, `.cursorrules`, Copilot instructions, or `AGENTS.md`, run a [Context Drift Audit](docs/context-drift-audit.md) first, try the intentionally drifted [audit example](examples/context-drift-audit/), then follow [Migrate Existing AI Context Files](docs/migrate-existing-context.md). Before committing shared or generated AI instructions, use the [Context File Review Checklist](docs/context-file-review.md). If you're deciding between Pluribus and a one-way rules converter, see [When to use Pluribus](docs/when-to-use-pluribus.md). If you are debugging "context drift" after compaction or long sessions, start with the [Context Drift Taxonomy](docs/context-drift-taxonomy.md) to separate file drift from runtime precedence drift. If you are reviewing Pluribus for a list, newsletter, or tool directory, use the [Community Review Packet](docs/community-review-packet.md) for a one-line description, safety notes, and a disposable 60-second smoke test.
|
|
152
152
|
|
|
153
153
|
### Usage
|
|
154
154
|
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# Community review packet
|
|
2
|
+
|
|
3
|
+
Use this when reviewing Pluribus for a list, newsletter, package roundup, or tool directory. It is written to be copy-pasteable without requiring private project context.
|
|
4
|
+
|
|
5
|
+
## One-line description
|
|
6
|
+
|
|
7
|
+
Pluribus keeps intentional AI coding context in one `pluribus.md` source of truth, then syncs or audits the tool-specific files used by Claude Code, Cursor, Copilot, OpenClaw, Windsurf, Continue, and Zed.
|
|
8
|
+
|
|
9
|
+
## Short listing copy
|
|
10
|
+
|
|
11
|
+
Pluribus is an open-source CLI for teams and solo developers who use multiple AI coding tools. It treats project instructions, conventions, constraints, and shared team context as versioned Markdown, then generates each tool's expected context file (`CLAUDE.md`, `.cursorrules`, Copilot instructions, `AGENTS.md`, Windsurf/Continue rules, and Zed rules). The safest first command is a read-only audit:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npx --yes pluribus-context@latest audit
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Why it may be useful
|
|
18
|
+
|
|
19
|
+
- Reduces copy-paste drift between AI tool instruction files.
|
|
20
|
+
- Lets users preview generated files with `sync --dry-run` before writing anything.
|
|
21
|
+
- Supports composable local context and explicit remote imports for shared team/org guidance.
|
|
22
|
+
- Provides CI/pre-commit audit paths so generated context drift is visible in code review.
|
|
23
|
+
|
|
24
|
+
## Safety and removability
|
|
25
|
+
|
|
26
|
+
- `audit`, `validate`, and `sync --dry-run` are read-only.
|
|
27
|
+
- `init` writes only `pluribus.md` and refuses to overwrite an existing file.
|
|
28
|
+
- `sync` writes only generated AI context files for the selected tools.
|
|
29
|
+
- Normal `audit`, `validate`, `sync`, and `sync --dry-run` runs do not make network requests.
|
|
30
|
+
- Remote imports fetch only when the user explicitly passes `--update-imports`; fetched content is pinned in `pluribus.lock.json` and cached under `.pluribus/cache/remote/`.
|
|
31
|
+
- A global install can be removed with `npm uninstall -g pluribus-context`; one-off `npx --yes pluribus-context@latest ...` does not create a persistent global `pluribus` command.
|
|
32
|
+
|
|
33
|
+
## 60-second review smoke
|
|
34
|
+
|
|
35
|
+
Run this in a disposable directory:
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
mkdir pluribus-review && cd pluribus-review
|
|
39
|
+
npx --yes pluribus-context@latest --version
|
|
40
|
+
npx --yes pluribus-context@latest init --dry-run --name "Review" --description "Disposable review project" --tools claude,cursor,copilot
|
|
41
|
+
npx --yes pluribus-context@latest init --name "Review" --description "Disposable review project" --tools claude,cursor,copilot
|
|
42
|
+
npx --yes pluribus-context@latest validate
|
|
43
|
+
npx --yes pluribus-context@latest sync --dry-run
|
|
44
|
+
npx --yes pluribus-context@latest audit --ci --json --output pluribus-audit.json || test $? -eq 1
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Expected result:
|
|
48
|
+
|
|
49
|
+
- `--version` prints the current npm release.
|
|
50
|
+
- `init --dry-run` previews `pluribus.md` without writing.
|
|
51
|
+
- `init` writes `pluribus.md`.
|
|
52
|
+
- `validate` succeeds.
|
|
53
|
+
- `sync --dry-run` previews generated context files without writing them.
|
|
54
|
+
- `audit --ci` may exit `1` before generated files are synced; that is expected when outputs are missing or drifted.
|
|
55
|
+
|
|
56
|
+
## Useful links
|
|
57
|
+
|
|
58
|
+
- npm package: <https://www.npmjs.com/package/pluribus-context>
|
|
59
|
+
- GitHub repo: <https://github.com/caioribeiroclw-pixel/pluribus>
|
|
60
|
+
- Quickstart: <https://github.com/caioribeiroclw-pixel/pluribus/blob/main/docs/quickstart.md>
|
|
61
|
+
- Context drift audit guide: <https://github.com/caioribeiroclw-pixel/pluribus/blob/main/docs/context-drift-audit.md>
|
|
62
|
+
- When to use Pluribus: <https://github.com/caioribeiroclw-pixel/pluribus/blob/main/docs/when-to-use-pluribus.md>
|
|
63
|
+
- First-run audit feedback: <https://github.com/caioribeiroclw-pixel/pluribus/issues/new?template=audit-feedback.yml>
|
|
64
|
+
|
|
65
|
+
## Feedback requested
|
|
66
|
+
|
|
67
|
+
If you try it on a real repo, please avoid pasting private context or full audit JSON from non-public projects. The most useful report is:
|
|
68
|
+
|
|
69
|
+
1. OS/shell and exact Pluribus version.
|
|
70
|
+
2. Which context files already existed (`CLAUDE.md`, `.cursorrules`, Copilot instructions, `AGENTS.md`, etc.).
|
|
71
|
+
3. Whether `audit` identified the expected missing/drifted files.
|
|
72
|
+
4. Whether the next safe step was obvious (`init`, edit `pluribus.md`, `sync --dry-run`, or `sync`).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "pluribus-context",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.6",
|
|
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",
|
package/src/utils/version.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const VERSION = '0.3.
|
|
1
|
+
export const VERSION = '0.3.6'
|