fix(npm): drop the coven bin alias to end the @opencoven/cli collision#140
Merged
Conversation
The coven command belongs to the Coven daemon CLI (@opencoven/cli), which execs into coven-code for the TUI when it is on PATH. Shipping a competing coven bin from @opencoven/coven-code made the command depend on install order for dual-install users. - npm/package.json: bin map keeps coven-code + coven-cave only - install.sh / install.ps1: stop creating the coven alias and clean up stale coven symlinks/exes left by older installers - docs + site content: alias references updated, completions use coven-code - prepare-npm-package.test.mjs: bin map expectation updated fixes #139 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
Removes the coven npm bin alias from @opencoven/coven-code to avoid collisions with the Coven daemon CLI’s coven command (@opencoven/cli), updating installers, docs, and the npm-prepare test to match.
Changes:
- Drop
covenfrom the npmbinmap, keepingcoven-codeandcoven-cave. - Update install scripts to stop installing
covenand to clean up stale aliases from older installs. - Update docs/site content and the npm packaging test expectation to reference
coven-code(including shell completion snippets).
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/prepare-npm-package.test.mjs | Updates expected npm bin map to remove coven. |
| README.md | Updates install instructions to remove coven alias mention and clarify daemon ownership. |
| npm/package.json | Removes coven from bin map to prevent global install collisions. |
| install.sh | Stops creating coven alias; adds cleanup for stale coven from older installs; updates summary output. |
| install.ps1 | Stops installing coven.exe; renames aside stale coven.exe on upgrade; updates output. |
| docs/src/content/installation.js | Updates web installation copy and completion examples to use coven-code. |
| docs/src/content/getting-started.js | Updates getting-started copy to remove coven alias mention and clarify daemon ownership. |
| docs/installation.md | Updates installation docs to remove coven alias mention and update completion examples to coven-code. |
| docs/index.md | Updates docs homepage to use coven-code instead of coven for interactive run instructions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+118
to
+122
| # Remove any `coven` symlink left by older installers — that name belongs to | ||
| # the Coven daemon CLI (@opencoven/cli). | ||
| if [[ -L "${INSTALL_DIR}/coven" ]]; then | ||
| rm -f "${INSTALL_DIR}/coven" | ||
| fi |
| @@ -297,15 +298,15 @@ cross build --release --locked --package claurst --target aarch64-unknown-linux- | |||
| ## Shell Completions | |||
|
|
|||
| Coven does not currently ship a dedicated `completions` subcommand. All | |||
| <h2>Shell Completions</h2> | ||
|
|
||
| <p>Coven does not currently ship a dedicated completions subcommand. All flags can be discovered via <code>coven --help</code>. If you want basic tab completion in bash or zsh, use the generic completion helper built into your shell:</p> | ||
| <p>Coven does not currently ship a dedicated completions subcommand. All flags can be discovered via <code>coven-code --help</code>. If you want basic tab completion in bash or zsh, use the generic completion helper built into your shell:</p> |
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
covenbin alias from@opencoven/coven-codeso it no longer collides with the Coven daemon CLI'scovenbin from@opencoven/cli.Context
covencommand depend on install order; npm/bun overwrite or refuse the colliding symlink.covenalready execs intocoven-codefor the TUI when it is on PATH, so TUI users lose nothing.coven ...doc references are intentionally unchanged.Changes
npm/package.json: bin map nowcoven-code+coven-caveonly.install.sh: stops symlinkingcoven, removes a stalecovensymlink from older installs, updated summary output.install.ps1: stops copyingcoven.exe, moves a stalecoven.exeaside on upgrade.README.md,docs/index.md,docs/installation.md,docs/src/content/{getting-started,installation}.js: alias references updated; shell-completion snippets now usecoven-code.scripts/prepare-npm-package.test.mjs: bin map expectation updated.Validation
git diff --check— cleanbash -n install.sh— oknode -e "JSON.parse(...npm/package.json)"— valid JSONnode --test scripts/prepare-npm-package.test.mjs— 1 pass, 0 failPR Readiness
binmap in npm/package.json; the stampedversionfield is untouched).