From 8a7b782ae44def6f0e91601ca1b3db8c03d5cc3a Mon Sep 17 00:00:00 2001 From: Val Alexander <68980965+BunsDev@users.noreply.github.com> Date: Tue, 7 Jul 2026 02:01:56 -0500 Subject: [PATCH] docs: fix npm install references to real package names @opencoven/coven does not exist on npm (404). Point Coven Code installs at @opencoven/coven-code (which ships the coven-code binary plus coven and coven-cave aliases) and Coven daemon installs at @opencoven/cli, matching the daemon hint already used in the /coven command. Also fix npm install -g /coven-code and thirteen OpenCoven/coven-codes repo-URL typos in index.html, and align the installed-command narrative with what the package actually installs. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- README.md | 6 +-- docs/familiars.md | 2 +- docs/index.md | 11 ++--- docs/installation.md | 65 ++++++++++++----------------- docs/src/content/familiars.js | 2 +- docs/src/content/getting-started.js | 6 +-- docs/src/content/installation.js | 32 ++++++-------- docs/src/demos.js | 2 +- docs/src/hero.js | 2 +- docs/src/main.js | 2 +- index.html | 30 ++++++------- 11 files changed, 72 insertions(+), 88 deletions(-) diff --git a/README.md b/README.md index 115a5c0b..3632e5b7 100644 --- a/README.md +++ b/README.md @@ -41,15 +41,15 @@ Recent highlights: ### Install ```bash -npm install -g @opencoven/coven +npm install -g @opencoven/coven-code ``` -Then open a new terminal and run `coven` or `coven tui`. The lower-level `coven-code` binary and `coven-cave` alias are also installed for compatibility. +Then open a new terminal and run `coven-code`. The `coven` and `coven-cave` aliases are also installed. ### Upgrade ```bash -npm install -g @opencoven/coven@latest +npm install -g @opencoven/coven-code@latest ``` --- diff --git a/docs/familiars.md b/docs/familiars.md index e3fe11e7..95a6b252 100644 --- a/docs/familiars.md +++ b/docs/familiars.md @@ -264,7 +264,7 @@ The familiar-sourced entry will be suppressed; only the workspace definition app If the Coven daemon is not installed or `~/.coven/` does not exist, `load_agent_definitions()` returns only workspace agents. No errors are shown — Coven Code degrades gracefully. Install the Coven daemon to unlock familiars: ``` -npm install -g @opencoven/coven +npm install -g @opencoven/cli ``` Or check the [Coven documentation](https://opencoven.ai/docs) for installation instructions. diff --git a/docs/index.md b/docs/index.md index 86a177ee..89cc2db5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -73,11 +73,12 @@ Cast `/incant caveman` or `/incant rocky` to compress model responses by 40–85 ```bash # Linux / macOS -npm install -g @opencoven/coven +npm install -g @opencoven/coven-code ``` -The package installs the `coven` CLI. Run `coven` with no arguments, or -`coven tui` explicitly, for the interactive UI. See [Installation](installation) +The package installs the `coven-code` CLI (with `coven` and `coven-cave` +aliases). Run `coven-code` with no arguments for the interactive UI. See +[Installation](installation) for npm, bun, standalone binary, and source install options. **2. Set your API key** @@ -158,7 +159,7 @@ When you launch the interactive UI with `coven` or `coven tui`, the home screen |-------|---------------|---------------| | `Model` | Active model id, or the effective default if unset | `model` in [settings.json](configuration), `/model` | | `Provider` | Active provider id (`anthropic` when unset) | `provider` in [settings.json](configuration), see [Providers](providers) | -| `Daemon` | `online` / `offline` from a cheap socket check — no RPC | Install `@opencoven/coven` to bring it online | +| `Daemon` | `online` / `offline` from a cheap socket check — no RPC | Install `@opencoven/cli` to bring it online | | `Familiar` | Current familiar id, with an `(F2 to switch)` hint | `familiar` in settings, `/familiar`, or **F2** | | `Goal` | Active autonomous goal (only shown when one is set) | `/coven goal ` | @@ -210,7 +211,7 @@ Coven Code connects natively to the [Coven daemon](https://opencoven.ai/docs) wh Coven Code is fully standalone without the daemon — install it separately to unlock the Coven ecosystem features. ``` -npm install -g @opencoven/coven +npm install -g @opencoven/cli ``` See [Coven Familiars](familiars) for the full integration reference. diff --git a/docs/installation.md b/docs/installation.md index 9fe7dad5..6145c235 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,8 +1,8 @@ # Coven Code Installation Guide Coven Code is a Rust reimplementation of the Claude Code CLI. The recommended -npm install path is the Coven package, which installs the `coven` CLI. Run -`coven` with no arguments, or `coven tui` explicitly, to open the interactive +npm install path is the `@opencoven/coven-code` package, which installs the +`coven-code` CLI. Run `coven-code` with no arguments to open the interactive Coven Code UI. --- @@ -24,33 +24,31 @@ possible; on Linux it links against the system glibc. ## Quick install (recommended) -If you have Node.js or Bun installed, install the Coven CLI globally: +If you have Node.js or Bun installed, install Coven Code globally: ```bash # npm -npm install -g @opencoven/coven +npm install -g @opencoven/coven-code # bun -bun install -g @opencoven/coven +bun install -g @opencoven/coven-code ``` -After installation, run: +The postinstall script downloads the correct pre-built binary from GitHub +Releases — no compilation needed. After installation, run: ```bash -coven -# or explicitly: -coven tui +coven-code ``` -The installed command is `coven`. Use `coven doctor` to inspect local setup, -`coven daemon start` to start the local daemon, and -`coven run ""` for direct harness sessions. +The installed command is `coven-code`; `coven` and `coven-cave` are installed +as aliases for the same CLI. -You can also run Coven without a permanent install: +You can also run Coven Code without a permanent install: ```bash -npx @opencoven/coven # via npm -bunx @opencoven/coven # via bun +npx @opencoven/coven-code # via npm +bunx @opencoven/coven-code # via bun ``` --- @@ -98,29 +96,20 @@ Example: `curl -fsSL https://.../install.sh | bash -s -- --version 0.1.0` --- -## Coven Code npm package +## Coven daemon (optional) -The lower-level Coven Code npm package installs the `coven-code` binary -directly. Prefer `@opencoven/coven` for the user-facing `coven` CLI unless you -specifically need the underlying Coven Code binary. +The Coven daemon unlocks the ecosystem features (familiars as agents, +daemon-registered skills, roster glyphs). It ships separately as the Coven +CLI: ```bash -# npm -npm install -g @opencoven/coven-code - -# bun -bun install -g @opencoven/coven-code +npm install -g @opencoven/cli +coven daemon start ``` -After installation, run `coven-code` directly from your terminal. `coven-cave` -is installed as an alias for the same CLI. - -You can also run Coven Code without a permanent install: - -```bash -npx @opencoven/coven-code # via npm -bunx @opencoven/coven-code # via bun -``` +Use `coven doctor` to inspect local setup and +`coven run ""` for direct harness sessions. Coven Code is +fully standalone without the daemon. **Supported platforms via npm:** @@ -137,9 +126,9 @@ bunx @opencoven/coven-code # via bun Once installed, upgrade in place at any time: ```bash -npm install -g @opencoven/coven@latest +npm install -g @opencoven/coven-code@latest # or -bun install -g @opencoven/coven@latest +bun install -g @opencoven/coven-code@latest ``` Settings in `~/.coven/` and `~/.coven-code/` are preserved. @@ -330,7 +319,7 @@ cd coven-code/src-rust cargo install --path crates/cli --locked --force ``` -For npm or bun installs, reinstall the `@opencoven/coven` package — see the +For npm or bun installs, reinstall the `@opencoven/coven-code` package — see the [Upgrading](#upgrading) section above. --- @@ -340,9 +329,9 @@ For npm or bun installs, reinstall the `@opencoven/coven` package — see the If you used the recommended npm or bun package, remove it globally: ```bash -npm uninstall -g @opencoven/coven +npm uninstall -g @opencoven/coven-code # or -bun remove -g @opencoven/coven +bun remove -g @opencoven/coven-code ``` If you used the install script, remove the install directory: diff --git a/docs/src/content/familiars.js b/docs/src/content/familiars.js index 17de051e..7a8f8133 100644 --- a/docs/src/content/familiars.js +++ b/docs/src/content/familiars.js @@ -86,7 +86,7 @@ node validators/validate.js ../../familiars/dev

Install the daemon to unlock the full roster:

- 
npm install -g @opencoven/coven
+ 
npm install -g @opencoven/cli

See the full familiars reference for access tiers, persona authoring, and CLI integration.

`; diff --git a/docs/src/content/getting-started.js b/docs/src/content/getting-started.js index cad31da2..6c1e397e 100644 --- a/docs/src/content/getting-started.js +++ b/docs/src/content/getting-started.js @@ -8,9 +8,9 @@ export function render() {

1. Install

npm

- 
npm install -g @opencoven/coven
+ 
npm install -g @opencoven/coven-code
-

This installs the coven CLI. Run coven with no arguments, or coven tui explicitly, for the interactive UI.

+

This installs the coven-code CLI (with coven and coven-cave aliases). Run coven-code with no arguments for the interactive UI.

From Source

git clone https://github.com/OpenCoven/coven-code
@@ -87,7 +87,7 @@ cargo install --path crates/cli

Coven Code connects natively to the Coven daemon when it's running on your machine. With the daemon active, familiars appear as agents, daemon-registered skills become awareness context, and the welcome panel animates with your familiar's glyph.

- 
npm install -g @opencoven/coven
+    
npm install -g @opencoven/cli
 coven daemon start

 
     
Coven Code is fully standalone without the daemon — install it separately to unlock the Coven ecosystem features.

diff --git a/docs/src/content/installation.js b/docs/src/content/installation.js
index b233fc31..e795021a 100644
--- a/docs/src/content/installation.js
+++ b/docs/src/content/installation.js
@@ -20,14 +20,14 @@ export function render() {
 
     
Quick Install

 
-    
npm install -g @opencoven/coven
+    
npm install -g @opencoven/coven-code
 # or
-bun install -g @opencoven/coven

+bun install -g @opencoven/coven-code

 
-    
The installed command is coven. Run coven with no arguments, or coven tui explicitly, for the interactive UI. Use coven doctor to inspect local setup, coven daemon start to start the local daemon, and coven run <harness> "<task>" for direct harness sessions.

+    
The installed command is coven-code; coven and coven-cave are installed as aliases for the same CLI. Run coven-code with no arguments for the interactive UI. The postinstall script downloads the correct pre-built binary from GitHub Releases — no compilation needed.

 
-    
npx @opencoven/coven
-bunx @opencoven/coven

+    
npx @opencoven/coven-code
+bunx @opencoven/coven-code

 
     
Standalone Coven Code Binary

 
@@ -53,24 +53,18 @@ bunx @opencoven/coven
-

Coven Code npm Package

+

Coven Daemon (Optional)

-

Prefer @opencoven/coven for the user-facing coven CLI. The lower-level Coven Code package installs the coven-code binary directly.

+

The Coven daemon unlocks the ecosystem features (familiars as agents, daemon-registered skills). It ships separately as the Coven CLI. Use coven doctor to inspect local setup and coven daemon start to start the daemon.

- 
npm install -g @opencoven/coven-code
-# or
-bun install -g @opencoven/coven-code
- -

The postinstall script downloads the correct pre-built binary from GitHub Releases — no compilation needed. Or run without a permanent install:

- - 
npx @opencoven/coven-code
-bunx @opencoven/coven-code
+ 
npm install -g @opencoven/cli
+coven daemon start

Upgrading

- 
npm install -g @opencoven/coven@latest
+    
npm install -g @opencoven/coven-code@latest
 # or
-bun install -g @opencoven/coven@latest

+bun install -g @opencoven/coven-code@latest

Settings under ~/.coven/ and ~/.coven-code/ are preserved.

@@ -131,9 +125,9 @@ compdef _gnu_generic coven

Uninstalling

- 
npm uninstall -g @opencoven/coven
+    
npm uninstall -g @opencoven/coven-code
 # or
-bun remove -g @opencoven/coven
+bun remove -g @opencoven/coven-code
 
 rm -rf ~/.coven ~/.coven-code     # Linux / macOS
 
diff --git a/docs/src/demos.js b/docs/src/demos.js
index ce9fccc9..2c72cbbb 100644
--- a/docs/src/demos.js
+++ b/docs/src/demos.js
@@ -19,7 +19,7 @@ export function registerDemos(Alpine) {
       },
       daemon: {
         title: 'Daemon',
-        body: 'Coven daemon online/offline status. A cheap socket check — no RPC. Install @opencoven/coven to bring it online; familiars and skills light up when it is.',
+        body: 'Coven daemon online/offline status. A cheap socket check — no RPC. Install @opencoven/cli to bring it online; familiars and skills light up when it is.',
       },
       familiar: {
         title: 'Familiar',
diff --git a/docs/src/hero.js b/docs/src/hero.js
index 0efa64a8..8223e341 100644
--- a/docs/src/hero.js
+++ b/docs/src/hero.js
@@ -21,7 +21,7 @@ export function renderHero(starCount) {
               ${starCount ? formatStars(starCount) : ''}
             
             
diff --git a/docs/src/main.js b/docs/src/main.js
index 4a85d4d0..b889a531 100644
--- a/docs/src/main.js
+++ b/docs/src/main.js
@@ -258,7 +258,7 @@ function bindCopyBtn() {
   const btn = document.getElementById('hero-copy-btn');
   if (!btn) return;
   btn.addEventListener('click', () => {
-    navigator.clipboard.writeText('npm i -g @opencoven/coven').then(() => {
+    navigator.clipboard.writeText('npm i -g @opencoven/coven-code').then(() => {
       btn.querySelector('.hero-copy-icon').classList.add('hidden');
       btn.querySelector('.hero-check-icon').classList.remove('hidden');
       setTimeout(() => {
diff --git a/index.html b/index.html
index 8fbf7b7c..859917de 100644
--- a/index.html
+++ b/index.html
@@ -8,19 +8,19 @@
 
     
     
-    
+    
     
     
-    
+    
     
     
 
     
     
-    
+    
     
     
-    
+    
 
     
     
@@ -563,7 +563,7 @@
                         
COVEN CODE

                     
                     

-                        
+                        
                             
                                 
                                 
@@ -605,7 +605,7 @@ 
Agentic coding for builders who ship.

                             # macOS. One-liner installer.
                             

                                 $
-                                curl -fsSL https://github.com/OpenCoven/coven-codes/releases/latest/download/install.sh | bash
+                                curl -fsSL https://github.com/OpenCoven/coven-code/releases/latest/download/install.sh | bash
                             

                         

                     
@@ -615,7 +615,7 @@ 
Agentic coding for builders who ship.

             
         
     
@@ -623,7 +623,7 @@ 
Agentic coding for builders who ship.