@volute_cvc/cvc 0.0.0 → 0.7.1
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/README.md +59 -5
- package/THIRD-PARTY-NOTICES.md +11884 -0
- package/bin/cvc-lsp.js +7 -0
- package/bin/cvc-mcp.js +7 -0
- package/bin/cvc.js +7 -0
- package/bin/release.js +981 -0
- package/package.json +18 -6
- package/scripts/stage-third-party-notices.mjs +26 -0
package/README.md
CHANGED
|
@@ -1,11 +1,65 @@
|
|
|
1
1
|
# @volute_cvc/cvc
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The `cvc` command-line tool for [Volute CVC](https://github.com/meirka8/volute) (Cognitive Version Control). CVC records AI-assisted development context — prompts, responses, integration-exposed reasoning, and tool metadata — alongside Git history, private by default.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
This package is a launcher: it downloads the released CVC binaries for your platform, verifies them, and runs them. It is the same launcher that is published as [`@volute_cvc/cvc-mcp`](https://www.npmjs.com/package/@volute_cvc/cvc-mcp), under a name for command-line users.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
## Install
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
```bash
|
|
10
|
+
npm install --global @volute_cvc/cvc
|
|
11
|
+
cvc --version
|
|
12
|
+
```
|
|
10
13
|
|
|
11
|
-
|
|
14
|
+
Or run it once without installing: `npx @volute_cvc/cvc --version`.
|
|
15
|
+
|
|
16
|
+
The first run downloads the release that matches this package's version, so it needs network access once. Supported platforms: Linux x86-64, macOS x86-64, macOS ARM64, and Windows x86-64. Linux ARM64 is not published, and the launcher rejects an unsupported platform before downloading.
|
|
17
|
+
|
|
18
|
+
Install this package or `@volute_cvc/cvc-mcp` globally, not both. They provide the same three commands, so npm stops the second install with an `EEXIST` error.
|
|
19
|
+
|
|
20
|
+
## Commands
|
|
21
|
+
|
|
22
|
+
- `cvc` — the CVC command-line interface (init, capture, sharing, and the Claude Code harness).
|
|
23
|
+
- `cvc-mcp` — the MCP server, for coding agents that speak the Model Context Protocol.
|
|
24
|
+
- `cvc-lsp` — the language server that editor integrations use.
|
|
25
|
+
|
|
26
|
+
## Get started
|
|
27
|
+
|
|
28
|
+
From a Git working tree:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
cvc init
|
|
32
|
+
cvc privacy acknowledge-capture
|
|
33
|
+
cvc harness install claude-code
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Then start a new Claude Code session and run `cvc conversations`. The [repository README](https://github.com/meirka8/volute#capture-claude-code-sessions) explains each step, including `cvc init`, and the [CLI README](https://github.com/meirka8/volute/blob/main/cvc-cli/README.md) covers the full command set.
|
|
37
|
+
|
|
38
|
+
## Where the binaries run from
|
|
39
|
+
|
|
40
|
+
The launcher keeps `cvc`, `cvc-mcp`, and `cvc-lsp` in `~/.cvc/bin` (`%USERPROFILE%\.cvc\bin` on Windows), the directory the `install.sh` and `install.ps1` installer scripts use, and runs them from there. It downloads and replaces them only when that directory is missing, out of date, or unexecutable, and it never downgrades. `cvc harness install claude-code` records `~/.cvc/bin/cvc` in your Claude Code hooks, so an upgrade reaches the hooks without reinstalling them. What the launcher does when it cannot publish, how it verifies a download, and its configuration variables are in the [launcher README](https://github.com/meirka8/volute/blob/main/npm/cvc-mcp/README.md).
|
|
41
|
+
|
|
42
|
+
## Upgrading
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
npm install --global @volute_cvc/cvc@latest
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
The package has no post-install step, so the new release reaches `~/.cvc/bin` only when the npm-installed `cvc` next runs: `"$(npm prefix -g)/bin/cvc" --version` on Linux and macOS, or `& "$(npm prefix -g)\cvc.cmd" --version` in PowerShell. Plain `cvc --version` is not enough if `~/.cvc/bin` comes first on your `PATH`, which is what the PATH setup offered by `install.sh` does: that runs the installed binary, which publishes nothing.
|
|
49
|
+
|
|
50
|
+
## Already using `@volute_cvc/cvc-mcp`?
|
|
51
|
+
|
|
52
|
+
MCP client configurations that run `cvc-mcp` or `npx @volute_cvc/cvc-mcp` keep working, and that package is still published with every release. To move a global install over for the command line:
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
npm uninstall --global @volute_cvc/cvc-mcp
|
|
56
|
+
npm install --global @volute_cvc/cvc
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## Privacy
|
|
60
|
+
|
|
61
|
+
Everything is private by default and fail-closed. Capture requires a one-time local acknowledgement, and remote sharing and auto-push each require a separate interactive challenge tied to the destination. See [Privacy.md](https://github.com/meirka8/volute/blob/main/Privacy.md).
|
|
62
|
+
|
|
63
|
+
## License
|
|
64
|
+
|
|
65
|
+
Apache-2.0. Each published archive and this package include `THIRD-PARTY-NOTICES.md`.
|