Skip to content

Commit 106db3a

Browse files
authored
Merge pull request #49 from kagura-agent/docs/update-getting-started
docs: update getting-started to reflect brew install + CLI workflow
2 parents 7085dfa + ec3ecf9 commit 106db3a

3 files changed

Lines changed: 123 additions & 12 deletions

File tree

docs/getting-started.md

Lines changed: 110 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,63 @@
11
# Getting Started
22

3-
## 1. Clone or drop `.agent/` into your project
3+
## 1. Install agentic-stack
4+
5+
### macOS / Linux with Homebrew (recommended)
46

57
```bash
6-
# new project
7-
git clone https://github.com/<you>/agentic-stack.git my-project
8-
cd my-project
8+
brew tap codejunkie99/agentic-stack https://github.com/codejunkie99/agentic-stack
9+
brew install agentic-stack
10+
```
11+
12+
This installs the `agentic-stack` command.
913

10-
# or add to an existing project
11-
cp -R /path/to/agentic-stack/.agent ./
12-
cp /path/to/agentic-stack/install.sh ./
14+
### Source checkout (no Homebrew)
15+
16+
If you prefer not to use Homebrew, clone the repo and run `install.sh`
17+
against the project you want to wire:
18+
19+
```bash
20+
git clone https://github.com/codejunkie99/agentic-stack.git
21+
cd agentic-stack
22+
./install.sh claude-code /path/to/your-project
23+
```
24+
25+
This path does not install a global `agentic-stack` command. Keep the clone
26+
around and run future management commands through `./install.sh`.
27+
28+
### Windows (PowerShell)
29+
30+
```powershell
31+
git clone https://github.com/codejunkie99/agentic-stack.git
32+
cd agentic-stack
33+
.\install.ps1 claude-code C:\path\to\your-project
1334
```
1435

1536
## 2. Pick your harness
1637

38+
If you installed with Homebrew, run the CLI from your project root:
39+
1740
```bash
18-
./install.sh claude-code # or cursor, windsurf, opencode,
19-
# openclaw, hermes, pi, codex,
20-
# standalone-python, antigravity
41+
cd your-project
42+
agentic-stack claude-code
43+
# or: cursor | windsurf | opencode | openclaw | hermes | pi | codex | standalone-python | antigravity
2144
```
2245

46+
If you are using a source checkout, the install command above already picked
47+
the harness. To add another adapter later, run
48+
`./install.sh add <adapter> /path/to/your-project` from the clone.
49+
50+
The onboarding wizard runs automatically, populating
51+
`.agent/memory/personal/PREFERENCES.md` and `.agent/memory/.features.json`.
52+
2353
Each adapter has its own `README.md` under `adapters/<name>/`.
2454

2555
## 3. Customize `PREFERENCES.md`
2656

2757
Open `.agent/memory/personal/PREFERENCES.md` and fill in 5–10 lines about
2858
your code style, workflow, and constraints. This is the one file every
29-
user should customize on day one.
59+
user should customize on day one. The onboarding wizard pre-populates it,
60+
but you can always edit it later.
3061

3162
## 4. Run the dream cycle on a schedule
3263

@@ -42,6 +73,49 @@ Open your harness and ask it anything. The first few days it will feel
4273
stateless. After ~2 weeks you'll notice it checking past lessons, logging
4374
failures with reflection, and (if you let it) proposing skill rewrites.
4475

76+
## Managing your project
77+
78+
After the initial setup, Homebrew users can run verb-style subcommands from
79+
the project root:
80+
81+
```bash
82+
agentic-stack dashboard # TUI dashboard: health, verify, memory, team, skills
83+
agentic-stack status # one-screen view: which adapters, brain stats
84+
agentic-stack doctor # read-only audit; green / yellow / red per adapter
85+
agentic-stack upgrade --dry-run # preview safe .agent infrastructure refresh
86+
agentic-stack upgrade --yes # apply latest harness/memory/tools + new skills
87+
agentic-stack sync-manifest # rebuild .agent/skills/_manifest.jsonl from SKILL.md
88+
```
89+
90+
Source checkout users can run the same verbs through the clone:
91+
92+
```bash
93+
./install.sh dashboard /path/to/your-project
94+
./install.sh status /path/to/your-project
95+
./install.sh doctor /path/to/your-project
96+
./install.sh upgrade /path/to/your-project --dry-run
97+
./install.sh upgrade /path/to/your-project --yes
98+
./install.sh sync-manifest /path/to/your-project
99+
```
100+
101+
PowerShell users can run the same verbs through `.\install.ps1`.
102+
103+
Adding or removing adapters with Homebrew:
104+
105+
```bash
106+
agentic-stack add cursor # add a second adapter alongside Claude Code
107+
agentic-stack remove cursor # confirm prompt + delete
108+
agentic-stack manage # interactive TUI for add/remove/audit
109+
```
110+
111+
Source checkout equivalents:
112+
113+
```bash
114+
./install.sh add cursor /path/to/your-project
115+
./install.sh remove cursor /path/to/your-project
116+
./install.sh manage /path/to/your-project
117+
```
118+
45119
## Optional: add a visual system with `DESIGN.md`
46120

47121
If your project has UI, drop a Google Stitch-style `DESIGN.md` file in the
@@ -55,7 +129,32 @@ When Node tooling is available, agents can validate the file with:
55129
npx @google/design.md lint DESIGN.md
56130
```
57131

132+
## Keeping up to date
133+
134+
```bash
135+
brew update && brew upgrade agentic-stack
136+
cd your-project
137+
agentic-stack upgrade --dry-run # preview changes
138+
agentic-stack upgrade --yes # apply; won't overwrite your memory or config
139+
```
140+
141+
Source checkout users should update the clone first:
142+
143+
```bash
144+
cd /path/to/agentic-stack
145+
git pull --ff-only
146+
./install.sh upgrade /path/to/your-project --dry-run
147+
./install.sh upgrade /path/to/your-project --yes
148+
```
149+
150+
The upgrade command refreshes skeleton-owned `.agent` infrastructure
151+
(harness scripts, top-level memory/tools Python files, skill index, and new
152+
skill directories) but never overwrites `CLAUDE.md`, `.claude/settings.json`,
153+
personal/semantic/episodic/working memory, candidates, or existing skill
154+
directories.
155+
58156
## Verify the wiring
157+
59158
```bash
60159
python3 .agent/tools/budget_tracker.py "commit and push"
61160
# tokens_used, chars, budget, headroom

onboard_ui.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
"""ANSI palette, block-char banner, and clack-style layout atoms (stdlib only)."""
22
import sys, os, shutil
33

4+
try:
5+
from harness_manager import __version__ as _AGENTIC_STACK_VERSION
6+
except Exception:
7+
_AGENTIC_STACK_VERSION = "unknown"
8+
49
_WIN = sys.platform == "win32"
510
if _WIN:
611
import msvcrt
@@ -25,7 +30,7 @@ def _hex(h, bg=False):
2530
# 2-row pixel font spells "AGENTIC STACK"
2631
_L1 = " ▄▀█ █▀▀ █▀▀ █▄░█ ▀█▀ █ █▀▀ █▀ ▀█▀ ▄▀█ █▀▀ █▄▀ "
2732
_L2 = " █▀█ █▄█ ██▄ █░▀█ ░█░ █ █▄▄ ▄█ ░█░ █▀█ █▄▄ █░█ "
28-
_T = " your portable brain · harness-agnostic AI memory · v0.8.0"
33+
_T = f" your portable brain · harness-agnostic AI memory · v{_AGENTIC_STACK_VERSION}"
2934

3035
def _cc(c):
3136
if c == "█": return f"{PURPLE}{B}{c}{R}"

test_onboard_ui.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
from harness_manager import __version__
2+
import onboard_ui
3+
4+
5+
def test_onboarding_banner_uses_package_version():
6+
assert f"v{__version__}" in onboard_ui._T
7+
assert "v0.8.0" not in onboard_ui._T

0 commit comments

Comments
 (0)