-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy pathinstallation.js
More file actions
139 lines (95 loc) · 5.97 KB
/
Copy pathinstallation.js
File metadata and controls
139 lines (95 loc) · 5.97 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
export const meta = { title: 'Installation' };
export function render() {
return `
<h1>Installation</h1>
<p class="lead">Install the Coven CLI with npm or bun, then run <code>coven</code> or <code>coven tui</code> to open the interactive Coven Code UI.</p>
<h2>System Requirements</h2>
<table>
<thead><tr><th>Platform</th><th>Architecture</th><th>Minimum OS</th></tr></thead>
<tbody>
<tr><td>Windows</td><td>x86_64</td><td>Windows 10 / Server 2019</td></tr>
<tr><td>Linux</td><td>x86_64</td><td>glibc 2.17+ (2014+ distros)</td></tr>
<tr><td>Linux</td><td>aarch64</td><td>glibc 2.17+ (Raspberry Pi 4, AWS Graviton)</td></tr>
<tr><td>macOS</td><td>x86_64</td><td>macOS 11 Big Sur</td></tr>
<tr><td>macOS</td><td>aarch64</td><td>macOS 11 Big Sur (M1/M2/M3)</td></tr>
</tbody>
</table>
<h2>Quick Install</h2>
<pre><code data-lang="bash">npm install -g @opencoven/coven-code
# or
bun install -g @opencoven/coven-code</code></pre>
<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>
<pre><code data-lang="bash">npx @opencoven/coven-code
bunx @opencoven/coven-code</code></pre>
<h2>Standalone Coven Code Binary</h2>
<h3>Linux / macOS</h3>
<pre><code data-lang="bash">curl -fsSL https://github.com/OpenCoven/coven-code/releases/latest/download/install.sh | bash</code></pre>
<h3>Windows (PowerShell)</h3>
<pre><code data-lang="bash">irm https://github.com/OpenCoven/coven-code/releases/latest/download/install.ps1 | iex</code></pre>
<p>Both installers detect platform/arch, download the matching archive, drop <code>coven-code</code> into <code>~/.coven-code/bin/</code>, and add that directory to your <code>PATH</code>. On macOS, they also strip the Gatekeeper quarantine attribute so the unsigned binary runs without a manual override.</p>
<h3>Installer Flags</h3>
<table>
<thead><tr><th>Flag (sh)</th><th>Flag (ps1)</th><th>Effect</th></tr></thead>
<tbody>
<tr><td><code>--version 0.1.0</code></td><td><code>-Version 0.1.0</code></td><td>Install a specific version</td></tr>
<tr><td><code>--binary <path></code></td><td><code>-Binary <path></code></td><td>Install from a local file (skip download)</td></tr>
<tr><td><code>--install-dir <path></code></td><td><code>-InstallDir <path></code></td><td>Override install directory</td></tr>
<tr><td><code>--no-modify-path</code></td><td><code>-NoModifyPath</code></td><td>Don't touch shell config / PATH</td></tr>
</tbody>
</table>
<h2>Coven Daemon (Optional)</h2>
<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/cli
coven daemon start</code></pre>
<h2>Upgrading</h2>
<pre><code data-lang="bash">npm install -g @opencoven/coven-code@latest
# or
bun install -g @opencoven/coven-code@latest</code></pre>
<p>Settings under <code>~/.coven/</code> and <code>~/.coven-code/</code> are preserved.</p>
<h2>Manual Install</h2>
<p>Grab archives from <a href="https://github.com/OpenCoven/coven-code/releases" target="_blank" rel="noopener">GitHub Releases</a>:</p>
<table>
<thead><tr><th>Archive</th><th>Platform</th></tr></thead>
<tbody>
<tr><td><code>coven-code-windows-x86_64.zip</code></td><td>Windows 64-bit</td></tr>
<tr><td><code>coven-code-linux-x86_64.tar.gz</code></td><td>Linux x86_64</td></tr>
<tr><td><code>coven-code-linux-aarch64.tar.gz</code></td><td>Linux ARM64</td></tr>
<tr><td><code>coven-code-macos-x86_64.tar.gz</code></td><td>macOS Intel</td></tr>
<tr><td><code>coven-code-macos-aarch64.tar.gz</code></td><td>macOS Apple Silicon</td></tr>
</tbody>
</table>
<h2>From Source</h2>
<h3>From a Clone</h3>
<pre><code data-lang="bash">git clone https://github.com/OpenCoven/coven-code
cd coven-code/src-rust
cargo install --path crates/cli --locked</code></pre>
<h3>Clone and Build</h3>
<pre><code data-lang="bash">git clone https://github.com/OpenCoven/coven-code
cd coven-code/src-rust
# Debug build (fast to compile, larger binary)
cargo build --package claurst
# Release build (optimised, smaller, for everyday use)
cargo build --release --package claurst</code></pre>
<h3>Linux System Dependencies</h3>
<pre><code data-lang="bash"># Debian / Ubuntu
sudo apt install build-essential pkg-config libssl-dev
# Fedora / RHEL
sudo dnf install gcc pkgconfig openssl-devel
# Arch
sudo pacman -S base-devel pkgconf openssl</code></pre>
<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>
<pre><code data-lang="bash"># bash — add to ~/.bashrc
complete -C coven coven
# zsh — add to ~/.zshrc (requires compinit)
compdef _gnu_generic coven</code></pre>
<h2>Uninstalling</h2>
<pre><code data-lang="bash">npm uninstall -g @opencoven/coven-code
# or
bun remove -g @opencoven/coven-code
rm -rf ~/.coven ~/.coven-code # Linux / macOS
# Windows (PowerShell):
Remove-Item -Recurse -Force $env:USERPROFILE\\.coven, $env:USERPROFILE\\.coven-code</code></pre>
<p>See <a href="https://github.com/OpenCoven/coven-code/blob/main/docs/installation.md" target="_blank" rel="noopener">the full installation reference</a> for cross-compiling to Linux aarch64, optional cargo features, and user-local installs without sudo.</p>
`;
}