CovenDocs
CLI ReferenceInstall

Install

Installation reference for Coven CLI through npm, Cargo installs from a source checkout, and full source builds.

1 min read

Coven is published as @opencoven/cli. The package namespace is OpenCoven, but the command you run is always coven.

Published-Platform Guidance

The published npm wrapper is the current reference path for these targets, read from Coven's release metadata:

PlatformOS/CPUNative package
macOS (Apple Silicon)darwin-arm64@opencoven/cli-macos
macOS (Intel)darwin-x64@opencoven/cli-macos-x64
Linux (x64)linux-x64@opencoven/cli-linux-x64
Windows (x64)win32-x64@opencoven/cli-windows

Linux means glibc, including WSL2 distros that match the published Linux target. On Windows, install from PowerShell or Windows Terminal. Do not assume other architectures are published. In WSL2, use the Linux wrapper path only when the distro and architecture match the published Linux target; otherwise use the source-checkout path inside the distro. Keep repositories and COVEN_HOME on the Linux filesystem and avoid /mnt/c for daemon-heavy work. For Raspberry Pi, Alpine/musl, or any other unverified platform package, use the source-checkout path and then verify with coven --version plus coven doctor.

Install From npm

Use npx or pnpm dlx for a one-off check:

npx @opencoven/cli doctor
pnpm dlx @opencoven/cli doctor

Install the wrapper globally when you want coven available repeatedly:

npm install -g @opencoven/cli
coven --version
coven doctor

Install From A Source Checkout With Cargo

git clone https://github.com/OpenCoven/coven.git
cd coven
cargo install --path crates/coven-cli
coven --version
coven doctor

This installs the built binary onto your Cargo bin path. Make sure ~/.cargo/bin is on PATH.

Build From A Source Checkout For Active Development

Use the workspace build when you are editing Coven or validating unreleased changes from the repo:

git clone https://github.com/OpenCoven/coven.git
cd coven
cargo build --workspace
cargo run -p coven-cli -- doctor

First Verification

After install, run:

coven --version
coven doctor

doctor reports local store state, project detection, daemon/socket status, and supported harness availability. See Doctor for how to read the output.

If doctor reports a missing harness, install or authenticate that harness in the same environment, then re-run coven doctor.

Was this page helpful?No

Last updated on

On this page