Skip to content

Commit 232bad7

Browse files
author
codejunkie99
committed
docs: add onboarding wizard section and update quickstart
1 parent f0521ad commit 232bad7

1 file changed

Lines changed: 34 additions & 5 deletions

File tree

README.md

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,21 +47,45 @@ nightly dream cycle, and adapters for seven harnesses.
4747
brew tap codejunkie99/agentic-stack https://github.com/codejunkie99/agentic-stack
4848
brew install agentic-stack
4949

50-
# drop the brain into any project
50+
# drop the brain into any project — the onboarding wizard runs automatically
5151
cd your-project
5252
agentic-stack claude-code
5353
# or: cursor | windsurf | opencode | openclient | hermes | standalone-python
5454
```
5555

56-
Then customize `.agent/memory/personal/PREFERENCES.md` with your own
57-
conventions — that's the one file every user should edit on day one.
58-
5956
> **Clone instead?**
6057
> ```bash
6158
> git clone https://github.com/codejunkie99/agentic-stack.git
6259
> cd agentic-stack && ./install.sh claude-code
6360
> ```
6461
62+
## Onboarding wizard
63+
64+
After the adapter is installed, a colorful terminal wizard runs automatically
65+
and populates `.agent/memory/personal/PREFERENCES.md` — the **first file your
66+
AI reads at the start of every session**.
67+
68+
It asks six questions with arrow-key selection, each skippable with Enter:
69+
70+
| Question | Default |
71+
|---|---|
72+
| What should I call you? | *(skip)* |
73+
| Primary language(s)? | `unspecified` |
74+
| Explanation style? | `concise` |
75+
| Test strategy? | `test-after` |
76+
| Commit message style? | `conventional commits` |
77+
| Code review depth? | `critical issues only` |
78+
79+
**Flags:**
80+
81+
```bash
82+
agentic-stack claude-code --yes # accept all defaults silently (CI / scripted)
83+
agentic-stack claude-code --reconfigure # re-run the wizard on an existing project
84+
```
85+
86+
Edit `.agent/memory/personal/PREFERENCES.md` any time to add or refine your
87+
conventions — the agent re-reads it fresh every session.
88+
6589
## Repo layout
6690

6791
```
@@ -84,7 +108,12 @@ adapters/ # one small shim per harness
84108
85109
docs/ # architecture, getting-started, per-harness
86110
examples/ # minimal first_run.py
87-
install.sh # one-command adapter install
111+
install.sh # one-command adapter install + wizard trigger
112+
onboard.py # onboarding wizard entry point
113+
onboard_ui.py # ANSI palette, banner, clack-style layout
114+
onboard_widgets.py # arrow-key prompts (text, select, confirm)
115+
onboard_render.py # answers → PREFERENCES.md content
116+
onboard_write.py # atomic file write with backup
88117
```
89118

90119
## Supported harnesses

0 commit comments

Comments
 (0)