Skip to content

Commit 3d252b6

Browse files
committed
docs: update getting-started to reflect brew install + CLI workflow
The getting-started guide still referenced the old git-clone + cp -R workflow and ./install.sh directly. Update it to match the current README quickstart: - Lead with brew tap/install as the recommended path - Use 'agentic-stack <harness>' CLI commands instead of ./install.sh - Add 'Managing your project' section with dashboard, doctor, upgrade, sync-manifest, add/remove subcommands - Add 'Keeping up to date' section covering brew upgrade + safe project upgrade flow - Note that onboarding wizard pre-populates PREFERENCES.md - Keep clone-based install as an alternative for non-Homebrew users - Keep Windows PowerShell instructions unchanged
1 parent 7085dfa commit 3d252b6

1 file changed

Lines changed: 66 additions & 11 deletions

File tree

docs/getting-started.md

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

3-
## 1. Clone or drop `.agent/` into your project
3+
## 1. Install agentic-stack
4+
5+
### macOS / Linux (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+
### Windows (PowerShell)
13+
14+
```powershell
15+
git clone https://github.com/codejunkie99/agentic-stack.git
16+
cd agentic-stack
17+
.\install.ps1 claude-code C:\path\to\your-project
18+
```
19+
20+
### Clone install (any platform)
921

10-
# or add to an existing project
11-
cp -R /path/to/agentic-stack/.agent ./
12-
cp /path/to/agentic-stack/install.sh ./
22+
If you prefer not to use Homebrew:
23+
24+
```bash
25+
git clone https://github.com/codejunkie99/agentic-stack.git
26+
cd agentic-stack && ./install.sh claude-code
1327
```
1428

1529
## 2. Pick your harness
1630

1731
```bash
18-
./install.sh claude-code # or cursor, windsurf, opencode,
19-
# openclaw, hermes, pi, codex,
20-
# standalone-python, antigravity
32+
cd your-project
33+
agentic-stack claude-code
34+
# or: cursor | windsurf | opencode | openclaw | hermes | pi | codex | standalone-python | antigravity
2135
```
2236

37+
The onboarding wizard runs automatically, populating
38+
`.agent/memory/personal/PREFERENCES.md` and `.agent/memory/.features.json`.
39+
2340
Each adapter has its own `README.md` under `adapters/<name>/`.
2441

2542
## 3. Customize `PREFERENCES.md`
2643

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

3149
## 4. Run the dream cycle on a schedule
3250

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

63+
## Managing your project
64+
65+
After the initial setup, use verb-style subcommands:
66+
67+
```bash
68+
agentic-stack dashboard # TUI dashboard: health, verify, memory, team, skills
69+
agentic-stack status # one-screen view: which adapters, brain stats
70+
agentic-stack doctor # read-only audit; green / yellow / red per adapter
71+
agentic-stack upgrade --dry-run # preview safe .agent infrastructure refresh
72+
agentic-stack upgrade --yes # apply latest harness/memory/tools + new skills
73+
agentic-stack sync-manifest # rebuild .agent/skills/_manifest.jsonl from SKILL.md
74+
```
75+
76+
Adding or removing adapters:
77+
78+
```bash
79+
agentic-stack add cursor # add a second adapter alongside Claude Code
80+
agentic-stack remove cursor # confirm prompt + delete
81+
agentic-stack manage # interactive TUI for add/remove/audit
82+
```
83+
4584
## Optional: add a visual system with `DESIGN.md`
4685

4786
If your project has UI, drop a Google Stitch-style `DESIGN.md` file in the
@@ -55,7 +94,23 @@ When Node tooling is available, agents can validate the file with:
5594
npx @google/design.md lint DESIGN.md
5695
```
5796

97+
## Keeping up to date
98+
99+
```bash
100+
brew update && brew upgrade agentic-stack
101+
cd your-project
102+
agentic-stack upgrade --dry-run # preview changes
103+
agentic-stack upgrade --yes # apply (safe — won't overwrite your memory or config)
104+
```
105+
106+
The upgrade command refreshes skeleton-owned `.agent` infrastructure
107+
(harness scripts, top-level memory/tools Python files, skill index, and new
108+
skill directories) but never overwrites `CLAUDE.md`, `.claude/settings.json`,
109+
personal/semantic/episodic/working memory, candidates, or existing skill
110+
directories.
111+
58112
## Verify the wiring
113+
59114
```bash
60115
python3 .agent/tools/budget_tracker.py "commit and push"
61116
# tokens_used, chars, budget, headroom

0 commit comments

Comments
 (0)