Skip to content

docs: fix npm install references to real package names #137

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
BunsDev merged 1 commit into from
Jul 7, 2026
Merged

docs: fix npm install references to real package names #137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

---
Expand Down
2 changes: 1 addition & 1 deletion docs/familiars.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
11 changes: 6 additions & 5 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down Expand Up @@ -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 <objective>` |

Expand Down Expand Up @@ -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.
Expand Down
65 changes: 27 additions & 38 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

---
Expand All @@ -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 <harness> "<task>"` 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
```

---
Expand Down Expand Up @@ -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 <harness> "<task>"` for direct harness sessions. Coven Code is
fully standalone without the daemon.

**Supported platforms via npm:**

Expand All @@ -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.
Expand Down Expand Up @@ -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.

---
Expand All @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/familiars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ node validators/validate.js ../../familiars/dev</code></pre>

<p>Install the daemon to unlock the full roster:</p>

<pre><code data-lang="bash">npm install -g @opencoven/coven</code></pre>
<pre><code data-lang="bash">npm install -g @opencoven/cli</code></pre>

<p>See <a href="https://github.com/OpenCoven/coven-code/blob/main/docs/familiars.md" target="_blank" rel="noopener">the full familiars reference</a> for access tiers, persona authoring, and CLI integration.</p>
`;
Expand Down
6 changes: 3 additions & 3 deletions docs/src/content/getting-started.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ export function render() {
<h2>1. Install</h2>

<h3>npm</h3>
<pre><code data-lang="bash">npm install -g @opencoven/coven</code></pre>
<pre><code data-lang="bash">npm install -g @opencoven/coven-code</code></pre>

<p>This installs the <code>coven</code> CLI. Run <code>coven</code> with no arguments, or <code>coven tui</code> explicitly, for the interactive UI.</p>
<p>This installs the <code>coven-code</code> CLI (with <code>coven</code> and <code>coven-cave</code> aliases). Run <code>coven-code</code> with no arguments for the interactive UI.</p>

Comment on lines 10 to 14
<h3>From Source</h3>
<pre><code data-lang="bash">git clone https://github.com/OpenCoven/coven-code
Expand Down Expand Up @@ -87,7 +87,7 @@ cargo install --path crates/cli</code></pre>

<p>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.</p>

<pre><code data-lang="bash">npm install -g @opencoven/coven
<pre><code data-lang="bash">npm install -g @opencoven/cli
coven daemon start</code></pre>
Comment on lines +90 to 91

<p>Coven Code is fully standalone without the daemon — install it separately to unlock the Coven ecosystem features.</p>
Expand Down
32 changes: 13 additions & 19 deletions docs/src/content/installation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ export function render() {

<h2>Quick Install</h2>

<pre><code data-lang="bash">npm install -g @opencoven/coven
<pre><code data-lang="bash">npm install -g @opencoven/coven-code
# or
bun install -g @opencoven/coven</code></pre>
bun install -g @opencoven/coven-code</code></pre>

<p>The installed command is <code>coven</code>. Run <code>coven</code> with no arguments, or <code>coven tui</code> explicitly, for the interactive UI. Use <code>coven doctor</code> to inspect local setup, <code>coven daemon start</code> to start the local daemon, and <code>coven run &lt;harness&gt; "&lt;task&gt;"</code> for direct harness sessions.</p>
<p>The installed command is <code>coven-code</code>; <code>coven</code> and <code>coven-cave</code> are installed as aliases for the same CLI. Run <code>coven-code</code> with no arguments for the interactive UI. The postinstall script downloads the correct pre-built binary from GitHub Releases — no compilation needed.</p>
Comment on lines +23 to +27

<pre><code data-lang="bash">npx @opencoven/coven
bunx @opencoven/coven</code></pre>
<pre><code data-lang="bash">npx @opencoven/coven-code
bunx @opencoven/coven-code</code></pre>

<h2>Standalone Coven Code Binary</h2>

Expand All @@ -53,24 +53,18 @@ bunx @opencoven/coven</code></pre>
</tbody>
</table>

<h2>Coven Code npm Package</h2>
<h2>Coven Daemon (Optional)</h2>

<p>Prefer <code>@opencoven/coven</code> for the user-facing <code>coven</code> CLI. The lower-level Coven Code package installs the <code>coven-code</code> binary directly.</p>
<p>The Coven daemon unlocks the ecosystem features (familiars as agents, daemon-registered skills). It ships separately as the Coven CLI. Use <code>coven doctor</code> to inspect local setup and <code>coven daemon start</code> to start the daemon.</p>

<pre><code data-lang="bash">npm install -g @opencoven/coven-code
# or
bun install -g @opencoven/coven-code</code></pre>

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

<pre><code data-lang="bash">npx @opencoven/coven-code
bunx @opencoven/coven-code</code></pre>
<pre><code data-lang="bash">npm install -g @opencoven/cli
coven daemon start</code></pre>
Comment on lines +58 to +61

<h2>Upgrading</h2>

<pre><code data-lang="bash">npm install -g @opencoven/coven@latest
<pre><code data-lang="bash">npm install -g @opencoven/coven-code@latest
# or
bun install -g @opencoven/coven@latest</code></pre>
bun install -g @opencoven/coven-code@latest</code></pre>

<p>Settings under <code>~/.coven/</code> and <code>~/.coven-code/</code> are preserved.</p>

Expand Down Expand Up @@ -131,9 +125,9 @@ compdef _gnu_generic coven</code></pre>

<h2>Uninstalling</h2>

<pre><code data-lang="bash">npm uninstall -g @opencoven/coven
<pre><code data-lang="bash">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

Expand Down
2 changes: 1 addition & 1 deletion docs/src/demos.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
2 changes: 1 addition & 1 deletion docs/src/hero.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export function renderHero(starCount) {
<span class="hero-star-badge px-1.5 py-px rounded-lg text-[11.5px] font-semibold tabular-nums" ${starCount ? '' : 'style="display:none"'}>${starCount ? formatStars(starCount) : ''}</span>
</a>
<button id="hero-copy-btn" title="Copy to clipboard" class="hero-install-btn group inline-flex items-center gap-2.5 rounded-[10px] px-5 h-10 cursor-pointer">
<code class="font-[var(--font-mono)] text-sm font-medium text-accent tracking-[-0.02em] !bg-transparent !border-0 !p-0">npm i -g @opencoven/coven</code>
<code class="font-[var(--font-mono)] text-sm font-medium text-accent tracking-[-0.02em] !bg-transparent !border-0 !p-0">npm i -g @opencoven/coven-code</code>
<svg class="hero-copy-icon text-text-dimmer group-hover:text-accent transition-colors" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><rect x="9" y="9" width="13" height="13" rx="2"/><path d="M5 15H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h9a2 2 0 0 1 2 2v1"/></svg>
<svg class="hero-check-icon hidden text-text-secondary" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2.5"><polyline points="20 6 9 17 4 12"/></svg>
</button>
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(() => {
Expand Down
Loading