@oldboydev/sheldon-darwin-arm64 0.2.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/SHA256SUMS +69 -18
- package/inventory.json +291 -36
- package/node_modules/@sheldon/cli/dist/commands/agents.js +85 -69
- package/node_modules/@sheldon/cli/dist/commands/mcp.js +1 -1
- package/node_modules/@sheldon/cli/dist/help/fonts/NunitoSans-VariableFont_YTLC_opsz_wdth_wght.ttf +0 -0
- package/node_modules/@sheldon/cli/dist/help/index.html +97 -0
- package/node_modules/@sheldon/cli/dist/help/manifest.json +121 -0
- package/node_modules/@sheldon/cli/dist/help/pages/agent.html +101 -0
- package/node_modules/@sheldon/cli/dist/help/pages/answer.html +110 -0
- package/node_modules/@sheldon/cli/dist/help/pages/bundle.html +124 -0
- package/node_modules/@sheldon/cli/dist/help/pages/compile.html +120 -0
- package/node_modules/@sheldon/cli/dist/help/pages/doctor.html +102 -0
- package/node_modules/@sheldon/cli/dist/help/pages/flow-compile-review.html +125 -0
- package/node_modules/@sheldon/cli/dist/help/pages/flow-end-to-end.html +147 -0
- package/node_modules/@sheldon/cli/dist/help/pages/flow-first-vault.html +100 -0
- package/node_modules/@sheldon/cli/dist/help/pages/image.html +107 -0
- package/node_modules/@sheldon/cli/dist/help/pages/ingest.html +156 -0
- package/node_modules/@sheldon/cli/dist/help/pages/init.html +98 -0
- package/node_modules/@sheldon/cli/dist/help/pages/mcp.html +135 -0
- package/node_modules/@sheldon/cli/dist/help/pages/migrate-state.html +100 -0
- package/node_modules/@sheldon/cli/dist/help/pages/plugin.html +120 -0
- package/node_modules/@sheldon/cli/dist/help/pages/project.html +110 -0
- package/node_modules/@sheldon/cli/dist/help/pages/query.html +110 -0
- package/node_modules/@sheldon/cli/dist/help/pages/review.html +114 -0
- package/node_modules/@sheldon/cli/dist/help/pages/search.html +103 -0
- package/node_modules/@sheldon/cli/dist/help/pages/topic.html +112 -0
- package/node_modules/@sheldon/cli/dist/help/pages/web.html +102 -0
- package/node_modules/@sheldon/cli/dist/help/styles.css +368 -0
- package/node_modules/@sheldon/cli/dist/help.js +84 -0
- package/node_modules/@sheldon/cli/dist/main.js +38 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/agent-runtime/dist/command-executor.js +1 -1
- package/node_modules/@sheldon/cli/node_modules/@sheldon/agent-runtime/dist/index.js +1 -1
- package/node_modules/@sheldon/cli/node_modules/@sheldon/agent-runtime/dist/profiles.js +1 -5
- package/node_modules/@sheldon/cli/node_modules/@sheldon/plugin-host/dist/official-catalog.js +4 -3
- package/node_modules/@sheldon/cli/node_modules/@sheldon/plugin-source-image/node_modules/@sheldon/plugin-host/dist/official-catalog.js +4 -3
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/dist/client/assets/index-B8MAXTxb.js +13 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/dist/client/assets/{index-BB6UWWie.css → index-DZRX97IO.css} +1 -1
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/dist/client/index.html +2 -2
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/dist/contract.js +18 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/dist/server.js +26 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/dist/wiki-markdown.js +75 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/dist/wiki.js +175 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@fastify/static/node_modules/glob/node_modules/path-scurry/node_modules/lru-cache/dist/commonjs/react-native/diagnostics-channel-react-native.d.ts.map +1 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@fastify/static/node_modules/glob/node_modules/path-scurry/node_modules/lru-cache/dist/commonjs/react-native/diagnostics-channel-react-native.js.map +1 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@fastify/static/node_modules/glob/node_modules/path-scurry/node_modules/lru-cache/dist/commonjs/react-native/diagnostics-channel.d.ts +5 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@fastify/static/node_modules/glob/node_modules/path-scurry/node_modules/lru-cache/dist/commonjs/react-native/diagnostics-channel.js +7 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@fastify/static/node_modules/glob/node_modules/path-scurry/node_modules/lru-cache/dist/commonjs/react-native/index.d.ts +1400 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@fastify/static/node_modules/glob/node_modules/path-scurry/node_modules/lru-cache/dist/commonjs/react-native/index.d.ts.map +1 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@fastify/static/node_modules/glob/node_modules/path-scurry/node_modules/lru-cache/dist/commonjs/react-native/index.js +1733 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@fastify/static/node_modules/glob/node_modules/path-scurry/node_modules/lru-cache/dist/commonjs/react-native/index.js.map +1 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@fastify/static/node_modules/glob/node_modules/path-scurry/node_modules/lru-cache/dist/commonjs/react-native/perf.d.ts +12 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@fastify/static/node_modules/glob/node_modules/path-scurry/node_modules/lru-cache/dist/commonjs/react-native/perf.d.ts.map +1 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@fastify/static/node_modules/glob/node_modules/path-scurry/node_modules/lru-cache/dist/commonjs/react-native/perf.js +10 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@fastify/static/node_modules/glob/node_modules/path-scurry/node_modules/lru-cache/dist/commonjs/react-native/perf.js.map +1 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@fastify/static/node_modules/glob/node_modules/path-scurry/node_modules/lru-cache/dist/esm/react-native/diagnostics-channel-react-native.d.ts.map +1 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@fastify/static/node_modules/glob/node_modules/path-scurry/node_modules/lru-cache/dist/esm/react-native/diagnostics-channel-react-native.js.map +1 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@fastify/static/node_modules/glob/node_modules/path-scurry/node_modules/lru-cache/dist/esm/react-native/diagnostics-channel.d.ts +5 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@fastify/static/node_modules/glob/node_modules/path-scurry/node_modules/lru-cache/dist/esm/react-native/diagnostics-channel.js +4 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@fastify/static/node_modules/glob/node_modules/path-scurry/node_modules/lru-cache/dist/esm/react-native/index.d.ts +1400 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@fastify/static/node_modules/glob/node_modules/path-scurry/node_modules/lru-cache/dist/esm/react-native/index.d.ts.map +1 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@fastify/static/node_modules/glob/node_modules/path-scurry/node_modules/lru-cache/dist/esm/react-native/index.js +1729 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@fastify/static/node_modules/glob/node_modules/path-scurry/node_modules/lru-cache/dist/esm/react-native/index.js.map +1 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@fastify/static/node_modules/glob/node_modules/path-scurry/node_modules/lru-cache/dist/esm/react-native/perf.d.ts +12 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@fastify/static/node_modules/glob/node_modules/path-scurry/node_modules/lru-cache/dist/esm/react-native/perf.d.ts.map +1 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@fastify/static/node_modules/glob/node_modules/path-scurry/node_modules/lru-cache/dist/esm/react-native/perf.js +7 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@fastify/static/node_modules/glob/node_modules/path-scurry/node_modules/lru-cache/dist/esm/react-native/perf.js.map +1 -0
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@fastify/static/node_modules/glob/node_modules/path-scurry/node_modules/lru-cache/package.json +17 -1
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@sheldon/agent-runtime/dist/command-executor.js +1 -1
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@sheldon/agent-runtime/dist/index.js +1 -1
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/node_modules/@sheldon/agent-runtime/dist/profiles.js +1 -5
- package/package.json +1 -1
- package/sbom.spdx.json +1 -1
- package/node_modules/@sheldon/cli/node_modules/@sheldon/web/dist/client/assets/index-FrWwJl0U.js +0 -9
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
6
|
+
<title>compile</title>
|
|
7
|
+
<link rel="stylesheet" href="../styles.css">
|
|
8
|
+
</head>
|
|
9
|
+
<body>
|
|
10
|
+
<div class="win">
|
|
11
|
+
<header class="titlebar">
|
|
12
|
+
<div class="titlebar__brand">
|
|
13
|
+
<svg class="eq-logo" viewBox="0 0 28 18" width="28" height="18" aria-hidden="true">
|
|
14
|
+
<rect x="0" y="6" width="3.2" height="12" rx="1.6" fill="var(--eq-1)"/>
|
|
15
|
+
<rect x="6" y="2" width="3.2" height="16" rx="1.6" fill="var(--eq-2)"/>
|
|
16
|
+
<rect x="12" y="4" width="3.2" height="14" rx="1.6" fill="var(--eq-3)"/>
|
|
17
|
+
<rect x="18" y="0" width="3.2" height="18" rx="1.6" fill="var(--eq-4)"/>
|
|
18
|
+
<rect x="24" y="7" width="3.2" height="11" rx="1.6" fill="var(--eq-5)"/>
|
|
19
|
+
</svg>
|
|
20
|
+
<span class="titlebar__title">sheldon</span>
|
|
21
|
+
</div>
|
|
22
|
+
<span class="titlebar__sep"></span>
|
|
23
|
+
<span class="titlebar__meta">Ajuda offline</span>
|
|
24
|
+
</header>
|
|
25
|
+
<div class="appbody">
|
|
26
|
+
<aside class="sidebar">
|
|
27
|
+
<p class="sidebar__label">Início</p>
|
|
28
|
+
<nav class="sidebar__nav">
|
|
29
|
+
<a class="navitem" href="../index.html">Ajuda</a>
|
|
30
|
+
</nav>
|
|
31
|
+
<p class="sidebar__label">Fluxos</p>
|
|
32
|
+
<nav class="sidebar__nav">
|
|
33
|
+
<a class="navitem" href="flow-first-vault.html">First vault</a>
|
|
34
|
+
<a class="navitem" href="flow-compile-review.html">Compile then review</a>
|
|
35
|
+
<a class="navitem" href="flow-end-to-end.html">End-to-end</a>
|
|
36
|
+
</nav>
|
|
37
|
+
<p class="sidebar__label">Comandos</p>
|
|
38
|
+
<nav class="sidebar__nav">
|
|
39
|
+
<a class="navitem" href="init.html">init</a>
|
|
40
|
+
<a class="navitem" href="doctor.html">doctor</a>
|
|
41
|
+
<a class="navitem" href="migrate-state.html">migrate-state</a>
|
|
42
|
+
<a class="navitem" href="web.html">web</a>
|
|
43
|
+
<a class="navitem" href="topic.html">topic</a>
|
|
44
|
+
<a class="navitem" href="project.html">project</a>
|
|
45
|
+
<a class="navitem" href="ingest.html">ingest</a>
|
|
46
|
+
<a class="navitem is-active" href="compile.html" aria-current="page">compile</a>
|
|
47
|
+
<a class="navitem" href="review.html">review</a>
|
|
48
|
+
<a class="navitem" href="bundle.html">bundle</a>
|
|
49
|
+
<a class="navitem" href="search.html">search</a>
|
|
50
|
+
<a class="navitem" href="query.html">query</a>
|
|
51
|
+
<a class="navitem" href="answer.html">answer</a>
|
|
52
|
+
<a class="navitem" href="agent.html">agent</a>
|
|
53
|
+
<a class="navitem" href="mcp.html">mcp</a>
|
|
54
|
+
<a class="navitem" href="plugin.html">plugin</a>
|
|
55
|
+
<a class="navitem" href="image.html">image</a>
|
|
56
|
+
</nav>
|
|
57
|
+
</aside>
|
|
58
|
+
<div class="content">
|
|
59
|
+
<div class="content__inner">
|
|
60
|
+
<article class="card card__pad prose">
|
|
61
|
+
<h1>compile</h1>
|
|
62
|
+
<p>Ask a locally installed agent (Codex, Claude, or Grok) to turn captured raws into a reviewable proposal. Compilation writes proposal output only — it does not change the approved wiki until you approve paths with <code>review</code>.</p>
|
|
63
|
+
<h2>Synopsis</h2>
|
|
64
|
+
<pre><code class="language-text">sheldon compile <kind> <slug> <proposal-id> --agent <agent> --prompt <text> --raw <path...> [--vault <path>]
|
|
65
|
+
sheldon compile-retry <kind> <slug> <proposal-id> --from <proposal-id> --agent <agent> --prompt <text> --raw <path...> [--vault <path>]
|
|
66
|
+
</code></pre>
|
|
67
|
+
<p><code>kind</code> is <code>topic</code> or <code>project</code>. Agents: <code>codex</code>, <code>claude</code>, or <code>grok</code>.</p>
|
|
68
|
+
<h2>Important flags / arguments</h2>
|
|
69
|
+
<ul>
|
|
70
|
+
<li><code>proposal-id</code> — id for the new proposal attempt (must be a valid proposal id).</li>
|
|
71
|
+
<li><code>--agent <agent></code> — which installed CLI agent should produce the proposal.</li>
|
|
72
|
+
<li><code>--prompt <text></code> — task instructions for the agent.</li>
|
|
73
|
+
<li><code>--raw <path...></code> — one or more raw source paths relative to the entity (for example <code>raw/<source-id>/content.md</code>).</li>
|
|
74
|
+
<li><code>--from <proposal-id></code> — (<code>compile-retry</code> only) prior proposal this attempt continues from; the new id must differ.</li>
|
|
75
|
+
<li><code>--vault <path></code> — explicit vault path when needed.</li>
|
|
76
|
+
</ul>
|
|
77
|
+
<h2>Examples</h2>
|
|
78
|
+
<p>PowerShell:</p>
|
|
79
|
+
<pre><code class="language-powershell">sheldon compile topic learning proposal-article `
|
|
80
|
+
--agent codex `
|
|
81
|
+
--prompt "Extract practical ideas and write concise notes with sources." `
|
|
82
|
+
--raw raw/<source-id>/content.md `
|
|
83
|
+
--vault C:\knowledge\sheldon
|
|
84
|
+
</code></pre>
|
|
85
|
+
<p>Unix:</p>
|
|
86
|
+
<pre><code class="language-sh">sheldon compile topic learning proposal-article \
|
|
87
|
+
--agent codex \
|
|
88
|
+
--prompt "Extract practical ideas and write concise notes with sources." \
|
|
89
|
+
--raw raw/<source-id>/content.md \
|
|
90
|
+
--vault ~/knowledge/sheldon
|
|
91
|
+
</code></pre>
|
|
92
|
+
<p>Retry after a weak first attempt (portable):</p>
|
|
93
|
+
<pre><code class="language-sh">sheldon compile-retry topic learning proposal-article-2 \
|
|
94
|
+
--from proposal-article \
|
|
95
|
+
--agent claude \
|
|
96
|
+
--prompt "Tighten the notes; keep citations to the same raws." \
|
|
97
|
+
--raw raw/<source-id>/content.md
|
|
98
|
+
</code></pre>
|
|
99
|
+
<p>Check agent readiness anytime with <code>sheldon agent doctor</code>.</p>
|
|
100
|
+
<h2>Expected outputs / artifacts</h2>
|
|
101
|
+
<ul>
|
|
102
|
+
<li>Prints JSON for the agent run / stored proposal.</li>
|
|
103
|
+
<li>Writes under the entity: <code>outputs/proposals/<proposal-id>/</code>.</li>
|
|
104
|
+
<li>Leaves <code>wiki/</code> unchanged until <code>sheldon review approve</code>.</li>
|
|
105
|
+
</ul>
|
|
106
|
+
<h2>Common failures</h2>
|
|
107
|
+
<ul>
|
|
108
|
+
<li>Agent not installed or not logged in — run <code>sheldon agent doctor</code> and complete the agent’s own login/auth flow.</li>
|
|
109
|
+
<li>Raw path missing or outside <code>raw/</code> — ingest first, then pass paths relative to the entity (for example <code>raw/<source-id>/content.md</code>).</li>
|
|
110
|
+
<li>No configured vault — pass <code>--vault <path></code> or run <code>sheldon init</code>.</li>
|
|
111
|
+
<li>Invalid or duplicate retry id — choose a new <code>proposal-id</code> different from <code>--from</code>.</li>
|
|
112
|
+
</ul>
|
|
113
|
+
<p>Next: <a href="review.html">review</a> or the <a href="flow-compile-review.html">Compile then review</a> flow.</p>
|
|
114
|
+
</article>
|
|
115
|
+
</div>
|
|
116
|
+
</div>
|
|
117
|
+
</div>
|
|
118
|
+
</div>
|
|
119
|
+
</body>
|
|
120
|
+
</html>
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
6
|
+
<title>doctor</title>
|
|
7
|
+
<link rel="stylesheet" href="../styles.css">
|
|
8
|
+
</head>
|
|
9
|
+
<body>
|
|
10
|
+
<div class="win">
|
|
11
|
+
<header class="titlebar">
|
|
12
|
+
<div class="titlebar__brand">
|
|
13
|
+
<svg class="eq-logo" viewBox="0 0 28 18" width="28" height="18" aria-hidden="true">
|
|
14
|
+
<rect x="0" y="6" width="3.2" height="12" rx="1.6" fill="var(--eq-1)"/>
|
|
15
|
+
<rect x="6" y="2" width="3.2" height="16" rx="1.6" fill="var(--eq-2)"/>
|
|
16
|
+
<rect x="12" y="4" width="3.2" height="14" rx="1.6" fill="var(--eq-3)"/>
|
|
17
|
+
<rect x="18" y="0" width="3.2" height="18" rx="1.6" fill="var(--eq-4)"/>
|
|
18
|
+
<rect x="24" y="7" width="3.2" height="11" rx="1.6" fill="var(--eq-5)"/>
|
|
19
|
+
</svg>
|
|
20
|
+
<span class="titlebar__title">sheldon</span>
|
|
21
|
+
</div>
|
|
22
|
+
<span class="titlebar__sep"></span>
|
|
23
|
+
<span class="titlebar__meta">Ajuda offline</span>
|
|
24
|
+
</header>
|
|
25
|
+
<div class="appbody">
|
|
26
|
+
<aside class="sidebar">
|
|
27
|
+
<p class="sidebar__label">Início</p>
|
|
28
|
+
<nav class="sidebar__nav">
|
|
29
|
+
<a class="navitem" href="../index.html">Ajuda</a>
|
|
30
|
+
</nav>
|
|
31
|
+
<p class="sidebar__label">Fluxos</p>
|
|
32
|
+
<nav class="sidebar__nav">
|
|
33
|
+
<a class="navitem" href="flow-first-vault.html">First vault</a>
|
|
34
|
+
<a class="navitem" href="flow-compile-review.html">Compile then review</a>
|
|
35
|
+
<a class="navitem" href="flow-end-to-end.html">End-to-end</a>
|
|
36
|
+
</nav>
|
|
37
|
+
<p class="sidebar__label">Comandos</p>
|
|
38
|
+
<nav class="sidebar__nav">
|
|
39
|
+
<a class="navitem" href="init.html">init</a>
|
|
40
|
+
<a class="navitem is-active" href="doctor.html" aria-current="page">doctor</a>
|
|
41
|
+
<a class="navitem" href="migrate-state.html">migrate-state</a>
|
|
42
|
+
<a class="navitem" href="web.html">web</a>
|
|
43
|
+
<a class="navitem" href="topic.html">topic</a>
|
|
44
|
+
<a class="navitem" href="project.html">project</a>
|
|
45
|
+
<a class="navitem" href="ingest.html">ingest</a>
|
|
46
|
+
<a class="navitem" href="compile.html">compile</a>
|
|
47
|
+
<a class="navitem" href="review.html">review</a>
|
|
48
|
+
<a class="navitem" href="bundle.html">bundle</a>
|
|
49
|
+
<a class="navitem" href="search.html">search</a>
|
|
50
|
+
<a class="navitem" href="query.html">query</a>
|
|
51
|
+
<a class="navitem" href="answer.html">answer</a>
|
|
52
|
+
<a class="navitem" href="agent.html">agent</a>
|
|
53
|
+
<a class="navitem" href="mcp.html">mcp</a>
|
|
54
|
+
<a class="navitem" href="plugin.html">plugin</a>
|
|
55
|
+
<a class="navitem" href="image.html">image</a>
|
|
56
|
+
</nav>
|
|
57
|
+
</aside>
|
|
58
|
+
<div class="content">
|
|
59
|
+
<div class="content__inner">
|
|
60
|
+
<article class="card card__pad prose">
|
|
61
|
+
<h1>doctor</h1>
|
|
62
|
+
<p>Check vault layout, operational SQLite, and whether Codex, Claude, and Grok CLIs are on <code>PATH</code>. Doctor is a read-only health report; it does not repair or migrate state. Plugin health is <code>sheldon plugin doctor</code>; agent login detail is <code>sheldon agent doctor</code>.</p>
|
|
63
|
+
<h2>Synopsis</h2>
|
|
64
|
+
<pre><code class="language-text">sheldon doctor [--vault <path>]
|
|
65
|
+
</code></pre>
|
|
66
|
+
<h2>Important flags / arguments</h2>
|
|
67
|
+
<ul>
|
|
68
|
+
<li><code>--vault <path></code> — explicit vault path when the saved default is wrong or missing.</li>
|
|
69
|
+
</ul>
|
|
70
|
+
<h2>Examples</h2>
|
|
71
|
+
<p>PowerShell:</p>
|
|
72
|
+
<pre><code class="language-powershell">sheldon doctor --vault C:\knowledge\sheldon
|
|
73
|
+
</code></pre>
|
|
74
|
+
<p>Unix:</p>
|
|
75
|
+
<pre><code class="language-sh">sheldon doctor --vault ~/knowledge/sheldon
|
|
76
|
+
</code></pre>
|
|
77
|
+
<p>Using the saved default from <code>init</code> (portable):</p>
|
|
78
|
+
<pre><code class="language-sh">sheldon doctor
|
|
79
|
+
</code></pre>
|
|
80
|
+
<h2>Expected outputs / artifacts</h2>
|
|
81
|
+
<ul>
|
|
82
|
+
<li>Prints Node.js version, <code>Vault: healthy</code>, SQLite healthy or missing (rebuildable without losing vault files), and Codex/Claude/Grok available or <code>not found (warning)</code>.</li>
|
|
83
|
+
<li>Does not print the vault path or any plugin inventory.</li>
|
|
84
|
+
<li>Exit status is non-zero when required checks fail (vault discovery or unreadable operational SQLite). Missing agent CLIs are warnings, not failures.</li>
|
|
85
|
+
<li>Does not modify vault files or install missing tools.</li>
|
|
86
|
+
</ul>
|
|
87
|
+
<h2>Common failures</h2>
|
|
88
|
+
<ul>
|
|
89
|
+
<li>No configured vault — pass <code>--vault <path></code> or run <code>sheldon init</code>. Sheldon does <strong>not</strong> list vaults.</li>
|
|
90
|
+
<li>Unreadable operational SQLite — follow the printed recovery; vault knowledge files are preserved.</li>
|
|
91
|
+
<li>Agent CLI missing or not logged in — <code>sheldon doctor</code> only warns about <code>PATH</code>; run <code>sheldon agent doctor</code> for install/auth detail.</li>
|
|
92
|
+
<li>Plugin issues — use <code>sheldon plugin doctor <id></code> / <code>sheldon plugin install <id></code>; they are not part of this report.</li>
|
|
93
|
+
<li>Corrupt or incomplete vault layout — re-init into a clean directory or restore from backup; do not invent a vault list.</li>
|
|
94
|
+
</ul>
|
|
95
|
+
<p>Related: <a href="agent.html">agent</a>, <a href="plugin.html">plugin</a>, <a href="migrate-state.html">migrate-state</a>.</p>
|
|
96
|
+
</article>
|
|
97
|
+
</div>
|
|
98
|
+
</div>
|
|
99
|
+
</div>
|
|
100
|
+
</div>
|
|
101
|
+
</body>
|
|
102
|
+
</html>
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
6
|
+
<title>Compile then review</title>
|
|
7
|
+
<link rel="stylesheet" href="../styles.css">
|
|
8
|
+
</head>
|
|
9
|
+
<body>
|
|
10
|
+
<div class="win">
|
|
11
|
+
<header class="titlebar">
|
|
12
|
+
<div class="titlebar__brand">
|
|
13
|
+
<svg class="eq-logo" viewBox="0 0 28 18" width="28" height="18" aria-hidden="true">
|
|
14
|
+
<rect x="0" y="6" width="3.2" height="12" rx="1.6" fill="var(--eq-1)"/>
|
|
15
|
+
<rect x="6" y="2" width="3.2" height="16" rx="1.6" fill="var(--eq-2)"/>
|
|
16
|
+
<rect x="12" y="4" width="3.2" height="14" rx="1.6" fill="var(--eq-3)"/>
|
|
17
|
+
<rect x="18" y="0" width="3.2" height="18" rx="1.6" fill="var(--eq-4)"/>
|
|
18
|
+
<rect x="24" y="7" width="3.2" height="11" rx="1.6" fill="var(--eq-5)"/>
|
|
19
|
+
</svg>
|
|
20
|
+
<span class="titlebar__title">sheldon</span>
|
|
21
|
+
</div>
|
|
22
|
+
<span class="titlebar__sep"></span>
|
|
23
|
+
<span class="titlebar__meta">Ajuda offline</span>
|
|
24
|
+
</header>
|
|
25
|
+
<div class="appbody">
|
|
26
|
+
<aside class="sidebar">
|
|
27
|
+
<p class="sidebar__label">Início</p>
|
|
28
|
+
<nav class="sidebar__nav">
|
|
29
|
+
<a class="navitem" href="../index.html">Ajuda</a>
|
|
30
|
+
</nav>
|
|
31
|
+
<p class="sidebar__label">Fluxos</p>
|
|
32
|
+
<nav class="sidebar__nav">
|
|
33
|
+
<a class="navitem" href="flow-first-vault.html">First vault</a>
|
|
34
|
+
<a class="navitem is-active" href="flow-compile-review.html" aria-current="page">Compile then review</a>
|
|
35
|
+
<a class="navitem" href="flow-end-to-end.html">End-to-end</a>
|
|
36
|
+
</nav>
|
|
37
|
+
<p class="sidebar__label">Comandos</p>
|
|
38
|
+
<nav class="sidebar__nav">
|
|
39
|
+
<a class="navitem" href="init.html">init</a>
|
|
40
|
+
<a class="navitem" href="doctor.html">doctor</a>
|
|
41
|
+
<a class="navitem" href="migrate-state.html">migrate-state</a>
|
|
42
|
+
<a class="navitem" href="web.html">web</a>
|
|
43
|
+
<a class="navitem" href="topic.html">topic</a>
|
|
44
|
+
<a class="navitem" href="project.html">project</a>
|
|
45
|
+
<a class="navitem" href="ingest.html">ingest</a>
|
|
46
|
+
<a class="navitem" href="compile.html">compile</a>
|
|
47
|
+
<a class="navitem" href="review.html">review</a>
|
|
48
|
+
<a class="navitem" href="bundle.html">bundle</a>
|
|
49
|
+
<a class="navitem" href="search.html">search</a>
|
|
50
|
+
<a class="navitem" href="query.html">query</a>
|
|
51
|
+
<a class="navitem" href="answer.html">answer</a>
|
|
52
|
+
<a class="navitem" href="agent.html">agent</a>
|
|
53
|
+
<a class="navitem" href="mcp.html">mcp</a>
|
|
54
|
+
<a class="navitem" href="plugin.html">plugin</a>
|
|
55
|
+
<a class="navitem" href="image.html">image</a>
|
|
56
|
+
</nav>
|
|
57
|
+
</aside>
|
|
58
|
+
<div class="content">
|
|
59
|
+
<div class="content__inner">
|
|
60
|
+
<article class="card card__pad prose">
|
|
61
|
+
<h1>Compile then review</h1>
|
|
62
|
+
<p>End-to-end path from an immutable raw capture to approved wiki notes: ingest → compile → preview → approve.</p>
|
|
63
|
+
<h2>Steps</h2>
|
|
64
|
+
<ol>
|
|
65
|
+
<li>Capture a source into <code>raw/<source-id>/</code> (file, url, crawl, or repository).</li>
|
|
66
|
+
<li>Ask an agent to compile selected raws into a proposal.</li>
|
|
67
|
+
<li>Preview the proposal without writing wiki.</li>
|
|
68
|
+
<li>Approve only the paths you want applied.</li>
|
|
69
|
+
</ol>
|
|
70
|
+
<h2>Capture a raw</h2>
|
|
71
|
+
<p>Install a connector if needed, then ingest.</p>
|
|
72
|
+
<p>PowerShell:</p>
|
|
73
|
+
<pre><code class="language-powershell">sheldon plugin install source.file
|
|
74
|
+
sheldon ingest file topic learning C:\inbox\article.pdf --vault C:\knowledge\sheldon
|
|
75
|
+
</code></pre>
|
|
76
|
+
<p>Unix:</p>
|
|
77
|
+
<pre><code class="language-sh">sheldon plugin install source.file
|
|
78
|
+
sheldon ingest file topic learning ~/inbox/article.pdf --vault ~/knowledge/sheldon
|
|
79
|
+
</code></pre>
|
|
80
|
+
<p>Note the source id and normalized path from the JSON output (typically <code>raw/<source-id>/content.md</code>).</p>
|
|
81
|
+
<h2>Compile a proposal</h2>
|
|
82
|
+
<p>PowerShell:</p>
|
|
83
|
+
<pre><code class="language-powershell">sheldon compile topic learning proposal-article `
|
|
84
|
+
--agent codex `
|
|
85
|
+
--prompt "Extract practical ideas and create concise notes with sources." `
|
|
86
|
+
--raw raw/<source-id>/content.md `
|
|
87
|
+
--vault C:\knowledge\sheldon
|
|
88
|
+
</code></pre>
|
|
89
|
+
<p>Unix:</p>
|
|
90
|
+
<pre><code class="language-sh">sheldon compile topic learning proposal-article \
|
|
91
|
+
--agent codex \
|
|
92
|
+
--prompt "Extract practical ideas and create concise notes with sources." \
|
|
93
|
+
--raw raw/<source-id>/content.md \
|
|
94
|
+
--vault ~/knowledge/sheldon
|
|
95
|
+
</code></pre>
|
|
96
|
+
<p>Use <code>sheldon agent doctor</code> if the agent is missing or not logged in. For another attempt linked to the first, use <code>compile-retry</code> with a new proposal id and <code>--from</code>.</p>
|
|
97
|
+
<h2>Preview</h2>
|
|
98
|
+
<pre><code class="language-powershell">sheldon review preview topic learning proposal-article --vault C:\knowledge\sheldon
|
|
99
|
+
</code></pre>
|
|
100
|
+
<pre><code class="language-sh">sheldon review preview topic learning proposal-article --vault ~/knowledge/sheldon
|
|
101
|
+
</code></pre>
|
|
102
|
+
<p>Inspect the listed file paths before applying anything.</p>
|
|
103
|
+
<h2>Approve selected paths</h2>
|
|
104
|
+
<p>PowerShell:</p>
|
|
105
|
+
<pre><code class="language-powershell">sheldon review approve topic learning proposal-article wiki/practical-ideas.md `
|
|
106
|
+
--vault C:\knowledge\sheldon
|
|
107
|
+
</code></pre>
|
|
108
|
+
<p>Unix:</p>
|
|
109
|
+
<pre><code class="language-sh">sheldon review approve topic learning proposal-article wiki/practical-ideas.md \
|
|
110
|
+
--vault ~/knowledge/sheldon
|
|
111
|
+
</code></pre>
|
|
112
|
+
<p>Only the paths you pass are written into <code>wiki/</code>. Reject with <code>sheldon review reject … --reason</code> if the proposal should not land.</p>
|
|
113
|
+
<h2>Next</h2>
|
|
114
|
+
<ul>
|
|
115
|
+
<li>Command details: <a href="ingest.html">ingest</a>, <a href="compile.html">compile</a>, <a href="review.html">review</a></li>
|
|
116
|
+
<li>After approval, try <a href="search.html">search</a> or <a href="query.html">query</a></li>
|
|
117
|
+
<li>Back to <a href="../index.html">Sheldon help</a></li>
|
|
118
|
+
</ul>
|
|
119
|
+
</article>
|
|
120
|
+
</div>
|
|
121
|
+
</div>
|
|
122
|
+
</div>
|
|
123
|
+
</div>
|
|
124
|
+
</body>
|
|
125
|
+
</html>
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
6
|
+
<title>End-to-end</title>
|
|
7
|
+
<link rel="stylesheet" href="../styles.css">
|
|
8
|
+
</head>
|
|
9
|
+
<body>
|
|
10
|
+
<div class="win">
|
|
11
|
+
<header class="titlebar">
|
|
12
|
+
<div class="titlebar__brand">
|
|
13
|
+
<svg class="eq-logo" viewBox="0 0 28 18" width="28" height="18" aria-hidden="true">
|
|
14
|
+
<rect x="0" y="6" width="3.2" height="12" rx="1.6" fill="var(--eq-1)"/>
|
|
15
|
+
<rect x="6" y="2" width="3.2" height="16" rx="1.6" fill="var(--eq-2)"/>
|
|
16
|
+
<rect x="12" y="4" width="3.2" height="14" rx="1.6" fill="var(--eq-3)"/>
|
|
17
|
+
<rect x="18" y="0" width="3.2" height="18" rx="1.6" fill="var(--eq-4)"/>
|
|
18
|
+
<rect x="24" y="7" width="3.2" height="11" rx="1.6" fill="var(--eq-5)"/>
|
|
19
|
+
</svg>
|
|
20
|
+
<span class="titlebar__title">sheldon</span>
|
|
21
|
+
</div>
|
|
22
|
+
<span class="titlebar__sep"></span>
|
|
23
|
+
<span class="titlebar__meta">Ajuda offline</span>
|
|
24
|
+
</header>
|
|
25
|
+
<div class="appbody">
|
|
26
|
+
<aside class="sidebar">
|
|
27
|
+
<p class="sidebar__label">Início</p>
|
|
28
|
+
<nav class="sidebar__nav">
|
|
29
|
+
<a class="navitem" href="../index.html">Ajuda</a>
|
|
30
|
+
</nav>
|
|
31
|
+
<p class="sidebar__label">Fluxos</p>
|
|
32
|
+
<nav class="sidebar__nav">
|
|
33
|
+
<a class="navitem" href="flow-first-vault.html">First vault</a>
|
|
34
|
+
<a class="navitem" href="flow-compile-review.html">Compile then review</a>
|
|
35
|
+
<a class="navitem is-active" href="flow-end-to-end.html" aria-current="page">End-to-end</a>
|
|
36
|
+
</nav>
|
|
37
|
+
<p class="sidebar__label">Comandos</p>
|
|
38
|
+
<nav class="sidebar__nav">
|
|
39
|
+
<a class="navitem" href="init.html">init</a>
|
|
40
|
+
<a class="navitem" href="doctor.html">doctor</a>
|
|
41
|
+
<a class="navitem" href="migrate-state.html">migrate-state</a>
|
|
42
|
+
<a class="navitem" href="web.html">web</a>
|
|
43
|
+
<a class="navitem" href="topic.html">topic</a>
|
|
44
|
+
<a class="navitem" href="project.html">project</a>
|
|
45
|
+
<a class="navitem" href="ingest.html">ingest</a>
|
|
46
|
+
<a class="navitem" href="compile.html">compile</a>
|
|
47
|
+
<a class="navitem" href="review.html">review</a>
|
|
48
|
+
<a class="navitem" href="bundle.html">bundle</a>
|
|
49
|
+
<a class="navitem" href="search.html">search</a>
|
|
50
|
+
<a class="navitem" href="query.html">query</a>
|
|
51
|
+
<a class="navitem" href="answer.html">answer</a>
|
|
52
|
+
<a class="navitem" href="agent.html">agent</a>
|
|
53
|
+
<a class="navitem" href="mcp.html">mcp</a>
|
|
54
|
+
<a class="navitem" href="plugin.html">plugin</a>
|
|
55
|
+
<a class="navitem" href="image.html">image</a>
|
|
56
|
+
</nav>
|
|
57
|
+
</aside>
|
|
58
|
+
<div class="content">
|
|
59
|
+
<div class="content__inner">
|
|
60
|
+
<article class="card card__pad prose">
|
|
61
|
+
<h1>End-to-end flow</h1>
|
|
62
|
+
<p>Happy path from an empty machine to searchable, queryable wiki notes: <code>init</code> → ingest → compile → review → <code>search</code> / <code>query</code>.</p>
|
|
63
|
+
<p>Sheldon does <strong>not</strong> list vaults. After <code>init</code>, rely on the saved default or pass <code>--vault</code> on each command.</p>
|
|
64
|
+
<h2>Steps</h2>
|
|
65
|
+
<ol>
|
|
66
|
+
<li>Initialize a vault and create a topic.</li>
|
|
67
|
+
<li>Install a connector and ingest one source.</li>
|
|
68
|
+
<li>Compile a proposal with a local agent.</li>
|
|
69
|
+
<li>Preview and approve selected wiki paths.</li>
|
|
70
|
+
<li>Search the index and sketch a cited query.</li>
|
|
71
|
+
</ol>
|
|
72
|
+
<h2>Initialize and create a topic</h2>
|
|
73
|
+
<p>PowerShell:</p>
|
|
74
|
+
<pre><code class="language-powershell">sheldon init C:\knowledge\sheldon
|
|
75
|
+
sheldon topic create "Learning" --vault C:\knowledge\sheldon
|
|
76
|
+
</code></pre>
|
|
77
|
+
<p>Unix:</p>
|
|
78
|
+
<pre><code class="language-sh">sheldon init ~/knowledge/sheldon
|
|
79
|
+
sheldon topic create "Learning" --vault ~/knowledge/sheldon
|
|
80
|
+
</code></pre>
|
|
81
|
+
<h2>Ingest one source</h2>
|
|
82
|
+
<p>PowerShell:</p>
|
|
83
|
+
<pre><code class="language-powershell">sheldon plugin install source.file
|
|
84
|
+
sheldon ingest file topic learning C:\inbox\article.pdf --vault C:\knowledge\sheldon
|
|
85
|
+
</code></pre>
|
|
86
|
+
<p>Unix:</p>
|
|
87
|
+
<pre><code class="language-sh">sheldon plugin install source.file
|
|
88
|
+
sheldon ingest file topic learning ~/inbox/article.pdf --vault ~/knowledge/sheldon
|
|
89
|
+
</code></pre>
|
|
90
|
+
<p>Note the source id and normalized path from the JSON output (typically <code>raw/<source-id>/content.md</code>). URL ingest works the same way with <code>sheldon ingest url …</code>.</p>
|
|
91
|
+
<h2>Compile with an agent</h2>
|
|
92
|
+
<p>Confirm the agent first, then compile.</p>
|
|
93
|
+
<pre><code class="language-sh">sheldon agent doctor
|
|
94
|
+
</code></pre>
|
|
95
|
+
<p>PowerShell:</p>
|
|
96
|
+
<pre><code class="language-powershell">sheldon compile topic learning proposal-article `
|
|
97
|
+
--agent codex `
|
|
98
|
+
--prompt "Extract practical ideas and create concise notes with sources." `
|
|
99
|
+
--raw raw/<source-id>/content.md `
|
|
100
|
+
--vault C:\knowledge\sheldon
|
|
101
|
+
</code></pre>
|
|
102
|
+
<p>Unix:</p>
|
|
103
|
+
<pre><code class="language-sh">sheldon compile topic learning proposal-article \
|
|
104
|
+
--agent codex \
|
|
105
|
+
--prompt "Extract practical ideas and create concise notes with sources." \
|
|
106
|
+
--raw raw/<source-id>/content.md \
|
|
107
|
+
--vault ~/knowledge/sheldon
|
|
108
|
+
</code></pre>
|
|
109
|
+
<h2>Preview and approve</h2>
|
|
110
|
+
<p>PowerShell:</p>
|
|
111
|
+
<pre><code class="language-powershell">sheldon review preview topic learning proposal-article --vault C:\knowledge\sheldon
|
|
112
|
+
sheldon review approve topic learning proposal-article wiki/practical-ideas.md `
|
|
113
|
+
--vault C:\knowledge\sheldon
|
|
114
|
+
</code></pre>
|
|
115
|
+
<p>Unix:</p>
|
|
116
|
+
<pre><code class="language-sh">sheldon review preview topic learning proposal-article --vault ~/knowledge/sheldon
|
|
117
|
+
sheldon review approve topic learning proposal-article wiki/practical-ideas.md \
|
|
118
|
+
--vault ~/knowledge/sheldon
|
|
119
|
+
</code></pre>
|
|
120
|
+
<h2>Search and query</h2>
|
|
121
|
+
<p>PowerShell:</p>
|
|
122
|
+
<pre><code class="language-powershell">sheldon search "retrieval practice" --topic learning --vault C:\knowledge\sheldon
|
|
123
|
+
sheldon query topic learning answer-retrieval `
|
|
124
|
+
--question "What does this vault say about retrieval practice?" `
|
|
125
|
+
--agent codex `
|
|
126
|
+
--vault C:\knowledge\sheldon
|
|
127
|
+
</code></pre>
|
|
128
|
+
<p>Unix:</p>
|
|
129
|
+
<pre><code class="language-sh">sheldon search "retrieval practice" --topic learning --vault ~/knowledge/sheldon
|
|
130
|
+
sheldon query topic learning answer-retrieval \
|
|
131
|
+
--question "What does this vault say about retrieval practice?" \
|
|
132
|
+
--agent codex \
|
|
133
|
+
--vault ~/knowledge/sheldon
|
|
134
|
+
</code></pre>
|
|
135
|
+
<h2>Next</h2>
|
|
136
|
+
<ul>
|
|
137
|
+
<li>Shorter compile path: <a href="flow-compile-review.html">Compile then review</a></li>
|
|
138
|
+
<li>Command details: <a href="init.html">init</a>, <a href="ingest.html">ingest</a>, <a href="compile.html">compile</a>, <a href="review.html">review</a>, <a href="search.html">search</a>, <a href="query.html">query</a></li>
|
|
139
|
+
<li>Back to <a href="../index.html">Sheldon help</a></li>
|
|
140
|
+
</ul>
|
|
141
|
+
</article>
|
|
142
|
+
</div>
|
|
143
|
+
</div>
|
|
144
|
+
</div>
|
|
145
|
+
</div>
|
|
146
|
+
</body>
|
|
147
|
+
</html>
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
6
|
+
<title>First vault</title>
|
|
7
|
+
<link rel="stylesheet" href="../styles.css">
|
|
8
|
+
</head>
|
|
9
|
+
<body>
|
|
10
|
+
<div class="win">
|
|
11
|
+
<header class="titlebar">
|
|
12
|
+
<div class="titlebar__brand">
|
|
13
|
+
<svg class="eq-logo" viewBox="0 0 28 18" width="28" height="18" aria-hidden="true">
|
|
14
|
+
<rect x="0" y="6" width="3.2" height="12" rx="1.6" fill="var(--eq-1)"/>
|
|
15
|
+
<rect x="6" y="2" width="3.2" height="16" rx="1.6" fill="var(--eq-2)"/>
|
|
16
|
+
<rect x="12" y="4" width="3.2" height="14" rx="1.6" fill="var(--eq-3)"/>
|
|
17
|
+
<rect x="18" y="0" width="3.2" height="18" rx="1.6" fill="var(--eq-4)"/>
|
|
18
|
+
<rect x="24" y="7" width="3.2" height="11" rx="1.6" fill="var(--eq-5)"/>
|
|
19
|
+
</svg>
|
|
20
|
+
<span class="titlebar__title">sheldon</span>
|
|
21
|
+
</div>
|
|
22
|
+
<span class="titlebar__sep"></span>
|
|
23
|
+
<span class="titlebar__meta">Ajuda offline</span>
|
|
24
|
+
</header>
|
|
25
|
+
<div class="appbody">
|
|
26
|
+
<aside class="sidebar">
|
|
27
|
+
<p class="sidebar__label">Início</p>
|
|
28
|
+
<nav class="sidebar__nav">
|
|
29
|
+
<a class="navitem" href="../index.html">Ajuda</a>
|
|
30
|
+
</nav>
|
|
31
|
+
<p class="sidebar__label">Fluxos</p>
|
|
32
|
+
<nav class="sidebar__nav">
|
|
33
|
+
<a class="navitem is-active" href="flow-first-vault.html" aria-current="page">First vault</a>
|
|
34
|
+
<a class="navitem" href="flow-compile-review.html">Compile then review</a>
|
|
35
|
+
<a class="navitem" href="flow-end-to-end.html">End-to-end</a>
|
|
36
|
+
</nav>
|
|
37
|
+
<p class="sidebar__label">Comandos</p>
|
|
38
|
+
<nav class="sidebar__nav">
|
|
39
|
+
<a class="navitem" href="init.html">init</a>
|
|
40
|
+
<a class="navitem" href="doctor.html">doctor</a>
|
|
41
|
+
<a class="navitem" href="migrate-state.html">migrate-state</a>
|
|
42
|
+
<a class="navitem" href="web.html">web</a>
|
|
43
|
+
<a class="navitem" href="topic.html">topic</a>
|
|
44
|
+
<a class="navitem" href="project.html">project</a>
|
|
45
|
+
<a class="navitem" href="ingest.html">ingest</a>
|
|
46
|
+
<a class="navitem" href="compile.html">compile</a>
|
|
47
|
+
<a class="navitem" href="review.html">review</a>
|
|
48
|
+
<a class="navitem" href="bundle.html">bundle</a>
|
|
49
|
+
<a class="navitem" href="search.html">search</a>
|
|
50
|
+
<a class="navitem" href="query.html">query</a>
|
|
51
|
+
<a class="navitem" href="answer.html">answer</a>
|
|
52
|
+
<a class="navitem" href="agent.html">agent</a>
|
|
53
|
+
<a class="navitem" href="mcp.html">mcp</a>
|
|
54
|
+
<a class="navitem" href="plugin.html">plugin</a>
|
|
55
|
+
<a class="navitem" href="image.html">image</a>
|
|
56
|
+
</nav>
|
|
57
|
+
</aside>
|
|
58
|
+
<div class="content">
|
|
59
|
+
<div class="content__inner">
|
|
60
|
+
<article class="card card__pad prose">
|
|
61
|
+
<h1>First vault</h1>
|
|
62
|
+
<p>Create your first Sheldon vault and confirm later commands can find it.</p>
|
|
63
|
+
<h2>Steps</h2>
|
|
64
|
+
<ol>
|
|
65
|
+
<li>Initialize a vault at an explicit path (recommended) or accept the default under <code>Documents/Sheldon</code>.</li>
|
|
66
|
+
<li>Create a topic so you have a place to ingest knowledge.</li>
|
|
67
|
+
<li>Optionally open the local web UI.</li>
|
|
68
|
+
</ol>
|
|
69
|
+
<h2>Initialize</h2>
|
|
70
|
+
<p>PowerShell:</p>
|
|
71
|
+
<pre><code class="language-powershell">sheldon init C:\knowledge\sheldon
|
|
72
|
+
</code></pre>
|
|
73
|
+
<p>Unix:</p>
|
|
74
|
+
<pre><code class="language-sh">sheldon init ~/knowledge/sheldon
|
|
75
|
+
</code></pre>
|
|
76
|
+
<p><code>init</code> saves that path as the local default. Sheldon does <strong>not</strong> list vaults — use the saved default or pass <code>--vault</code>.</p>
|
|
77
|
+
<h2>Create a topic</h2>
|
|
78
|
+
<p>PowerShell:</p>
|
|
79
|
+
<pre><code class="language-powershell">sheldon topic create "Learning" --vault C:\knowledge\sheldon
|
|
80
|
+
</code></pre>
|
|
81
|
+
<p>Unix:</p>
|
|
82
|
+
<pre><code class="language-sh">sheldon topic create "Learning" --vault ~/knowledge/sheldon
|
|
83
|
+
</code></pre>
|
|
84
|
+
<p>If you rely on the default from <code>init</code>, you can omit <code>--vault</code>.</p>
|
|
85
|
+
<h2>Open the web UI</h2>
|
|
86
|
+
<pre><code class="language-powershell">sheldon web
|
|
87
|
+
</code></pre>
|
|
88
|
+
<p>The UI listens on <code>http://127.0.0.1:<port></code> and only accepts local connections.</p>
|
|
89
|
+
<h2>Next</h2>
|
|
90
|
+
<ul>
|
|
91
|
+
<li>Command details: <a href="init.html">init</a></li>
|
|
92
|
+
<li>Back to <a href="../index.html">Sheldon help</a></li>
|
|
93
|
+
</ul>
|
|
94
|
+
</article>
|
|
95
|
+
</div>
|
|
96
|
+
</div>
|
|
97
|
+
</div>
|
|
98
|
+
</div>
|
|
99
|
+
</body>
|
|
100
|
+
</html>
|