-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy pathgetting-started.js
More file actions
95 lines (70 loc) · 4.51 KB
/
Copy pathgetting-started.js
File metadata and controls
95 lines (70 loc) · 4.51 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
export const meta = { title: 'Getting Started' };
export function render() {
return `
<h1>Getting Started</h1>
<p class="lead">Install, authenticate, and run your first session in under a minute.</p>
<h2>1. Install</h2>
<h3>npm</h3>
<pre><code data-lang="bash">npm install -g @opencoven/coven-code</code></pre>
<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>
<h3>From Source</h3>
<pre><code data-lang="bash">git clone https://github.com/OpenCoven/coven-code
cd coven-code/src-rust
cargo install --path crates/cli</code></pre>
<h2>2. Connect a Provider</h2>
<pre><code data-lang="bash">export ANTHROPIC_API_KEY=sk-ant-...</code></pre>
<p>Or launch <code>coven</code> with no credentials. The first-run prompt lets you press <kbd>1</kbd> for Claude setup, <kbd>2</kbd> for Codex browser login, or <kbd>Enter</kbd> for the full <code>/connect</code> picker. If you already use Claude Code or <code>ant</code>, the picker prioritizes local credential import.</p>
<pre><code data-lang="bash">coven-code codex login</code></pre>
<p>Claude.ai OAuth requires <code>COVEN_CODE_ANTHROPIC_OAUTH_CLIENT_ID</code>; without that first-party client, use an API key or Claude CLI import. Multiple named accounts can coexist; switch in the TUI with <code>/login switch <id></code>.</p>
<h2>3. Run Interactively</h2>
<pre><code data-lang="bash">coven</code></pre>
<p>This drops you into the TUI. The first screen is the <a href="#welcome-screen">welcome screen</a>, which surfaces the active model, provider, daemon status, and familiar.</p>
<p>Or launch a direct harness session:</p>
<pre><code data-lang="bash">coven run codex "explain the auth module"</code></pre>
<h2>Interactive vs Headless</h2>
<div class="demo">
<div class="demo-header">
<span>five run modes · pick the one that fits the situation</span>
</div>
<div class="demo-body">
<div class="compare compare-5">
<div class="compare-card">
<div class="compare-card-name">interactive</div>
<span class="compare-card-tag">day-to-day</span>
<div class="compare-card-desc">Full ratatui TUI with streaming, slash commands, permission dialogs, session history. The default when you launch with no args.</div>
<div class="compare-card-cmd">coven</div>
</div>
<div class="compare-card">
<div class="compare-card-name">direct harness</div>
<span class="compare-card-tag">one-shot</span>
<div class="compare-card-desc">Run one named harness against a task from the Coven CLI.</div>
<div class="compare-card-cmd">coven run codex "task"</div>
</div>
<div class="compare-card">
<div class="compare-card-name">claude harness</div>
<span class="compare-card-tag">alternate</span>
<div class="compare-card-desc">Use Claude Code through the same Coven harness runner.</div>
<div class="compare-card-cmd">coven run claude "task"</div>
</div>
<div class="compare-card">
<div class="compare-card-name">sessions json</div>
<span class="compare-card-tag">machine</span>
<div class="compare-card-desc">List known Coven sessions as JSON for scripts, dashboards, or local workflow tooling.</div>
<div class="compare-card-cmd">coven sessions --json</div>
</div>
<div class="compare-card">
<div class="compare-card-name">stream-json</div>
<span class="compare-card-tag">real-time</span>
<div class="compare-card-desc">Newline-delimited JSON events as they happen — useful for streaming progress into another process or live UI.</div>
<div class="compare-card-cmd">coven run codex "task" --stream-json</div>
</div>
</div>
</div>
</div>
<h2>Coven Daemon (Optional)</h2>
<p>Coven Code connects natively to the Coven daemon when it's running on your machine. With the daemon active, familiars appear as agents, daemon-registered skills become awareness context, and the welcome panel animates with your familiar's glyph.</p>
<pre><code data-lang="bash">npm install -g @opencoven/cli
coven daemon start</code></pre>
<p>Coven Code is fully standalone without the daemon — install it separately to unlock the Coven ecosystem features.</p>
`;
}