diff --git a/README.md b/README.md index 3632e5b..a5d0215 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ Recent highlights: npm install -g @opencoven/coven-code ``` -Then open a new terminal and run `coven-code`. The `coven` and `coven-cave` aliases are also installed. +Then open a new terminal and run `coven-code`. The `coven-cave` alias is also installed. (The bare `coven` command belongs to the [Coven daemon CLI](https://github.com/OpenCoven/coven) — `@opencoven/cli` — which execs into `coven-code` for the TUI.) ### Upgrade diff --git a/docs/index.md b/docs/index.md index 89cc2db..d41ec9d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -76,8 +76,9 @@ Cast `/incant caveman` or `/incant rocky` to compress model responses by 40–85 npm install -g @opencoven/coven-code ``` -The package installs the `coven-code` CLI (with `coven` and `coven-cave` -aliases). Run `coven-code` with no arguments for the interactive UI. See +The package installs the `coven-code` CLI (with a `coven-cave` alias). Run +`coven-code` with no arguments for the interactive UI. The bare `coven` +command belongs to the Coven daemon CLI (`@opencoven/cli`). See [Installation](installation) for npm, bun, standalone binary, and source install options. @@ -90,7 +91,7 @@ export ANTHROPIC_API_KEY=sk-ant-... **3. Run interactively** ```bash -coven +coven-code ``` Or launch a direct harness session: diff --git a/docs/installation.md b/docs/installation.md index 6145c23..861e712 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -41,8 +41,9 @@ Releases — no compilation needed. After installation, run: coven-code ``` -The installed command is `coven-code`; `coven` and `coven-cave` are installed -as aliases for the same CLI. +The installed command is `coven-code`; `coven-cave` is installed as an alias +for the same CLI. The bare `coven` command is owned by the Coven daemon CLI +(`@opencoven/cli`) and is not installed by this package. You can also run Coven Code without a permanent install: @@ -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 -flags can be discovered via `coven --help`. If you want basic tab completion +flags can be discovered via `coven-code --help`. If you want basic tab completion in bash or zsh you can use the generic completion helper built into your shell: ```bash # bash — add to ~/.bashrc -complete -C coven coven +complete -C coven-code coven-code # zsh — add to ~/.zshrc (requires compinit) -compdef _gnu_generic coven +compdef _gnu_generic coven-code ``` Richer completion scripts may be added in a future release. diff --git a/docs/src/content/getting-started.js b/docs/src/content/getting-started.js index 6c1e397..4f6323a 100644 --- a/docs/src/content/getting-started.js +++ b/docs/src/content/getting-started.js @@ -10,7 +10,7 @@ export function render() {
npm install -g @opencoven/coven-code
- This installs the coven-code CLI (with coven and coven-cave aliases). Run coven-code with no arguments for the interactive UI.
This installs the coven-code CLI (with a coven-cave alias). Run coven-code with no arguments for the interactive UI. The bare coven command belongs to the Coven daemon CLI (@opencoven/cli).
git clone https://github.com/OpenCoven/coven-code
diff --git a/docs/src/content/installation.js b/docs/src/content/installation.js
index e795021..041899a 100644
--- a/docs/src/content/installation.js
+++ b/docs/src/content/installation.js
@@ -24,7 +24,7 @@ export function render() {
# or
bun install -g @opencoven/coven-code
- 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.
The installed command is coven-code; coven-cave is installed as an alias for the same CLI. The bare coven command is owned by the Coven daemon CLI (@opencoven/cli) and is not installed by this package. 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-code
bunx @opencoven/coven-code
@@ -115,13 +115,13 @@ sudo pacman -S base-devel pkgconf openssl
Coven does not currently ship a dedicated completions subcommand. All flags can be discovered via coven --help. If you want basic tab completion in bash or zsh, use the generic completion helper built into your shell:
Coven does not currently ship a dedicated completions subcommand. All flags can be discovered via coven-code --help. If you want basic tab completion in bash or zsh, use the generic completion helper built into your shell:
# bash — add to ~/.bashrc
-complete -C coven coven
+complete -C coven-code coven-code
# zsh — add to ~/.zshrc (requires compinit)
-compdef _gnu_generic coven
+compdef _gnu_generic coven-code