Skip to content

Commit ec3ecf9

Browse files
author
codejunkie99
committed
docs: harden getting started install flow
1 parent 3d252b6 commit ec3ecf9

3 files changed

Lines changed: 68 additions & 12 deletions

File tree

docs/getting-started.md

Lines changed: 55 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,38 +2,51 @@
22

33
## 1. Install agentic-stack
44

5-
### macOS / Linux (recommended)
5+
### macOS / Linux with Homebrew (recommended)
66

77
```bash
88
brew tap codejunkie99/agentic-stack https://github.com/codejunkie99/agentic-stack
99
brew install agentic-stack
1010
```
1111

12-
### Windows (PowerShell)
12+
This installs the `agentic-stack` command.
1313

14-
```powershell
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
1520
git clone https://github.com/codejunkie99/agentic-stack.git
1621
cd agentic-stack
17-
.\install.ps1 claude-code C:\path\to\your-project
22+
./install.sh claude-code /path/to/your-project
1823
```
1924

20-
### Clone install (any platform)
25+
This path does not install a global `agentic-stack` command. Keep the clone
26+
around and run future management commands through `./install.sh`.
2127

22-
If you prefer not to use Homebrew:
28+
### Windows (PowerShell)
2329

24-
```bash
30+
```powershell
2531
git clone https://github.com/codejunkie99/agentic-stack.git
26-
cd agentic-stack && ./install.sh claude-code
32+
cd agentic-stack
33+
.\install.ps1 claude-code C:\path\to\your-project
2734
```
2835

2936
## 2. Pick your harness
3037

38+
If you installed with Homebrew, run the CLI from your project root:
39+
3140
```bash
3241
cd your-project
3342
agentic-stack claude-code
3443
# or: cursor | windsurf | opencode | openclaw | hermes | pi | codex | standalone-python | antigravity
3544
```
3645

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+
3750
The onboarding wizard runs automatically, populating
3851
`.agent/memory/personal/PREFERENCES.md` and `.agent/memory/.features.json`.
3952

@@ -62,7 +75,8 @@ failures with reflection, and (if you let it) proposing skill rewrites.
6275

6376
## Managing your project
6477

65-
After the initial setup, use verb-style subcommands:
78+
After the initial setup, Homebrew users can run verb-style subcommands from
79+
the project root:
6680

6781
```bash
6882
agentic-stack dashboard # TUI dashboard: health, verify, memory, team, skills
@@ -73,14 +87,35 @@ agentic-stack upgrade --yes # apply latest harness/memory/tools + new skil
7387
agentic-stack sync-manifest # rebuild .agent/skills/_manifest.jsonl from SKILL.md
7488
```
7589

76-
Adding or removing adapters:
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:
77104

78105
```bash
79106
agentic-stack add cursor # add a second adapter alongside Claude Code
80107
agentic-stack remove cursor # confirm prompt + delete
81108
agentic-stack manage # interactive TUI for add/remove/audit
82109
```
83110

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+
84119
## Optional: add a visual system with `DESIGN.md`
85120

86121
If your project has UI, drop a Google Stitch-style `DESIGN.md` file in the
@@ -100,7 +135,16 @@ npx @google/design.md lint DESIGN.md
100135
brew update && brew upgrade agentic-stack
101136
cd your-project
102137
agentic-stack upgrade --dry-run # preview changes
103-
agentic-stack upgrade --yes # apply (safe — won't overwrite your memory or config)
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
104148
```
105149

106150
The upgrade command refreshes skeleton-owned `.agent` infrastructure

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)