@arkhera30/cli 0.8.4 → 0.8.6

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.
@@ -1,94 +0,0 @@
1
- ---
2
- title: Getting Started with Horus
3
- description: Install the Horus CLI, run first setup, and connect Claude — typically under ten minutes.
4
- slug: getting-started
5
- tags: [onboarding, cli, install, setup]
6
- schema_version: 1
7
- keywords: [start, begin, first, time, first-time, install, setup, set, up, connect, configure, fresh, new, quickstart, onboarding, initialize]
8
- related_commands: [horus setup, horus status, horus connect, horus doctor]
9
- sidebar_position: 1
10
- ---
11
-
12
- # Getting Started with Horus
13
-
14
- Horus is a local-first AI development environment. It runs Anvil (notes), Vault (knowledge), and Forge (workspaces) as containers on your machine, and connects Claude to them so your sessions have durable memory and structured workflows.
15
-
16
- This guide takes you from "nothing installed" to "asking Claude questions about your data" in about ten minutes.
17
-
18
- ## Prerequisites
19
-
20
- - **Docker 24+** or **Podman 4+** with the Compose plugin
21
- - **Node.js 18+** (for installing the CLI via `npm`)
22
- - **Claude Desktop**, **Claude Code**, or **Cursor** installed
23
- - **Git repositories to store your data.** You'll need URLs for:
24
- - One repository for Anvil notes (e.g. `horus-notes`)
25
- - One repository per Vault knowledge base (e.g. `my-vault`)
26
- - One repository for the Forge registry (e.g. `forge-registry`)
27
-
28
- Empty repos are fine — Horus clones them on first boot. Use HTTPS URLs, not SSH, because containers don't have your SSH keys. A GitHub token is required for private repositories.
29
-
30
- ## 1. Install the CLI
31
-
32
- ```bash
33
- npm install -g @arkhera30/cli
34
- horus --version
35
- ```
36
-
37
- The CLI is published to npm as `@arkhera30/cli` and installs a single binary named `horus`.
38
-
39
- ## 2. Run setup
40
-
41
- ```bash
42
- horus setup
43
- ```
44
-
45
- The setup wizard walks you through everything. Expect prompts for:
46
-
47
- - **Container runtime** — Docker or Podman, whichever is installed
48
- - **Data directory** — where Horus stores notes, knowledge, and workspaces. Default: `~/Horus/data`
49
- - **Host repos path** — the directory containing your local Git repositories. Forge indexes this read-only so you can ask Claude about your codebases
50
- - **Repository URLs** — your Anvil notes repo, one or more Vault knowledge repos, and the Forge registry
51
- - **GitHub tokens** — one per Git server hostname (only needed for private repos)
52
-
53
- Setup then:
54
-
55
- 1. Writes config to `~/Horus/config.yaml` and `~/Horus/.env`
56
- 2. Installs a generated `~/Horus/docker-compose.yml`
57
- 3. Clones your repositories into the data directory
58
- 4. Pulls container images and starts the stack
59
- 5. Waits for every service to report healthy
60
- 6. Automatically runs `horus connect` for any detected AI clients
61
-
62
- When setup finishes you'll see a summary with service URLs and your configured vault instances.
63
-
64
- ## 3. Verify the stack is healthy
65
-
66
- ```bash
67
- horus status
68
- ```
69
-
70
- You should see every service reporting `healthy`, with the Anvil, Vault Router, Vault MCP, Forge, Neo4j, Typesense, and Horus UI containers running. If any service is unhealthy, run `horus doctor` for diagnostics.
71
-
72
- ## 4. Open the Horus UI (optional)
73
-
74
- Horus ships with a web UI at **`http://localhost:8400`** that you can use to browse notes, knowledge pages, and workspaces without going through Claude. Useful for a quick visual check that things are working.
75
-
76
- ## 5. Ask Claude something
77
-
78
- Restart Claude Desktop, Claude Code, or Cursor so it picks up the new MCP servers that `horus connect` configured. Then try these prompts:
79
-
80
- - **Anvil** — `"What's pending?"` — Claude routes this to Anvil, which searches your notes for open tasks.
81
- - **Anvil** — `"Create a project called My App"` — Anvil creates a typed project note.
82
- - **Vault** — `"How does the auth module work?"` — Claude routes to Vault's semantic search over your knowledge base.
83
- - **Forge** — `"List my workspaces"` — Forge returns workspace records (empty on first run — that's expected).
84
-
85
- Your Anvil and Vault repositories are empty on first install, so queries return nothing until you start creating notes and writing knowledge pages. That is normal and expected for a fresh install.
86
-
87
- ## What to read next
88
-
89
- - **`horus guide core-concepts`** — the mental model for Anvil, Vault, Forge, and the supporting services
90
- - **`horus guide first-workspace`** — how to set up an isolated context for working on a project
91
- - **`horus guide first-session`** — how to start an isolated code session tied to a work item
92
- - **`horus guide first-note`** — how Anvil's dynamic type system works and how to create your first note
93
-
94
- If anything goes wrong during setup, `horus doctor` runs a full diagnostic and tells you exactly what to fix.