docs: fix npm install references to real package names#137
Merged
Conversation
@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>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
Updates the project’s user-facing docs and docs-site copy to reference npm packages that actually exist on the registry, aligning installation instructions with the current published package names and repo URLs.
Changes:
- Replaces
npm install -g @opencoven/coven//coven-codereferences with@opencoven/coven-codefor Coven Code installation. - Updates Coven daemon install references to
@opencoven/cliin docs and docs-site content. - Fixes
coven-codes→coven-coderepo/Pages URL typos inindex.htmland related social/meta links.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updates global install/upgrade commands to @opencoven/coven-code and adjusts binary guidance. |
| index.html | Fixes GitHub Pages/repo URLs and updates npm/bun install commands to real package names. |
| docs/src/main.js | Updates hero copy-to-clipboard install command. |
| docs/src/hero.js | Updates displayed hero install command. |
| docs/src/demos.js | Updates demo copy to reference @opencoven/cli for the daemon. |
| docs/src/content/installation.js | Updates installation page commands and reorganizes daemon guidance. |
| docs/src/content/getting-started.js | Updates getting-started install/daemon snippets to the new packages. |
| docs/src/content/familiars.js | Updates familiars page daemon install snippet to @opencoven/cli. |
| docs/installation.md | Updates installation guide package names and daemon section. |
| docs/index.md | Updates quick install and daemon references to the new packages. |
| docs/familiars.md | Updates familiars reference daemon install snippet to @opencoven/cli. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+23
to
+27
| <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 <harness> "<task>"</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
+58
to
+61
| <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
158
to
+162
| | Field | What it shows | Configured in | | ||
| |-------|---------------|---------------| | ||
| | `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 | |
Comment on lines
10
to
14
| <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
+90
to
91
| <pre><code data-lang="bash">npm install -g @opencoven/cli | ||
| coven daemon start</code></pre> |
| # bun | ||
| bun install -g @opencoven/coven-code | ||
| npm install -g @opencoven/cli | ||
| coven daemon start |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Context
/coveninstall in npm for@opencoven". Verified:npm view @opencoven/covenreturns 404; the real packages are@opencoven/coven-code(this CLI; binscoven-code,coven,coven-cave) and@opencoven/cli(Coven daemon CLI; bincoven).docs/src/), andindex.html. Docs only — no Rust changes.covenbin-name collision between@opencoven/coven-codeand@opencoven/cli(tracked separately).Changes
@opencoven/coven-code(README, docs/installation.md, docs/index.md, docs-site installation/getting-started pages, hero copy button).@opencoven/cli(docs/index.md, docs/familiars.md, docs-site familiars/getting-started/demos), matching the existing/covencommand hint.index.html:npm install -g /coven-code→@opencoven/coven-code; 13OpenCoven/coven-codesrepo-URL typos →coven-code.coven-code(withcoven/coven-cavealiases);coven doctor/coven daemon start/coven runmoved to the daemon section they belong to.scripts/bump-version.pytargets.Validation
Record exact commands and outcomes. Mark items N/A with a reason when they do not apply.
git diff --check— clean.npm view @opencoven/coven→ 404;npm view @opencoven/coven-code version→ 0.3.0;npm view @opencoven/cli version→ 0.0.53; grep confirms no remaining@opencoven/coven(bare),/coven-codeinstall, orcoven-codesreferences.PR Readiness