You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: lead Onboarding with single-paste flow; mark scripts Shipping
Reflects the reality on the ground after PRs #29/#30/#31 land the
v2 scripts:
onboarding.mdx:
- Promotes 'irm https://kun.databayt.org/install | iex' to the
recommended path (one paste, one UAC, three OAuth sign-ins)
- Demotes Cowork-driven flow to "Alternative" — still works for
Pro/Max users who want narration over a bare paste
- Manual fallback updated to use databayt/kun raw URL (the codebase
one is now tombstoned in databayt/codebase#2)
- Adds 'doctor' to Daily entry points and 'maintain -Install' to
the manual fallback chain
- "What you end up with" mentions the scheduled task
onboarding-reference.mdx:
- Scripts contract table flipped: bootstrap, doctor, maintain are
now Shipping (no longer 'Planned v2'); health.ps1 marked Deprecated;
finish.ps1 reduced to 'Planned (alias for bootstrap)'
- Source-of-truth URL changed from databayt/codebase to databayt/kun
- Migration order section refreshed — 4 of 6 items checked off,
fresh-VM test + team comms remaining
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: content/docs/onboarding-reference.mdx
+15-16Lines changed: 15 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,20 +56,18 @@ Pre-authorizes the common tool set so even default `claude` doesn't prompt for r
56
56
57
57
## Scripts contract
58
58
59
-
The executable layer lives at `~/.claude/scripts/`. Today's scripts are authoritative — Cowork and Claude Code only invoke them. The v2 column documents the bootstrap layer that will land in `databayt/codebase` to collapse the cold-start paste further.
59
+
The executable layer lives at `~/.claude/scripts/`. All scripts are authoritative — Cowork and Claude Code only invoke them. Source of truth is [databayt/kun/.claude/scripts](https://github.com/databayt/kun/tree/main/.claude/scripts). Any PR that changes a script must touch the matching row below.
60
60
61
61
| Script | Status | Purpose |
62
62
|---|---|---|
63
-
|`install.ps1`| Shipping | Installs Claude Code CLI if missing, copies kun config to `~/.claude/`, clones `databayt/codebase` to `~/codebase`. Role-aware (`engineer`, `business`, `content`, `ops`). |
|`install.ps1`| Shipping | Installs Claude Code CLI if missing, copies kun config to `~/.claude/`, clones `databayt/codebase` to `~/codebase`. Role-aware. Copies `lib/` recursively. |
64
65
|`secrets.ps1`| Shipping | Pulls `.env` from the team Gist into `~/.claude/.env`. Idempotent. |
65
-
|`sync-repos.ps1`| Shipping | Clones all active org repos: `codebase` to `~/codebase`, others to `~/oss/<name>`. `--status` prints branch/commit per repo. |
|`bootstrap.ps1`| Planned (v2) | Single-paste cold start: ExecutionPolicy fix, winget bundle, install, secrets, sync-repos, WebStorm via Toolbox, plugin pre-drop, scheduled task. Exits with codes documented in `databayt/codebase`. |
68
-
|`finish.ps1`| Planned (v2) | Idempotent re-runner — same shape as bootstrap but skips installs if tools are already on PATH. Used to repair interrupted runs. |
69
-
|`doctor.ps1`| Planned (v2) | Rename of `health.ps1` with extra org-specific checks: `.env` freshness, repo layout, scheduled task armed, plugin loaded in WebStorm. |
70
-
|`maintain.ps1`| Planned (v2) | Daily scheduled task: sync-repos, self-update `~/.claude/`, run doctor, notify Slack on red. |
71
-
72
-
Each shipping script lives in [databayt/codebase/.claude/scripts](https://github.com/databayt/codebase/tree/main/.claude/scripts). Any PR that changes a script must touch the matching row above.
66
+
|`sync-repos.ps1`| Shipping | Clones all active org repos. Reads `~/.claude/memory/repositories.json` as source of truth (with a hardcoded fallback for cold-bootstrap). |
|`maintain.ps1`| Shipping | Daily Windows scheduled task. Composes `sync-repos → self-update → doctor → notify → log`. Silent on green; toast on warnings/updates; toast + Slack on errors. `-Install` / `-Uninstall` / `-Status` / `-Run` / `-DryRun`. |
69
+
|`health.ps1`| Deprecated | 5-line back-compat shim → `doctor.ps1`. Removed in a follow-up after a 2-week co-existence window. |
70
+
|`finish.ps1`| Planned | Alias for `bootstrap.ps1` (every step is already idempotent). Ships as a one-line wrapper. |
73
71
74
72
## `.claude` layout
75
73
@@ -154,13 +152,14 @@ Anything else can be automated, and probably should be.
154
152
155
153
## Migration order
156
154
157
-
For the person rolling out the v2 scripts:
155
+
The v2 rollout, mostly done. Remaining items are flagged.
158
156
159
-
1. Land scripts in `databayt/codebase/.claude/scripts/` (`bootstrap`, `finish`, `doctor`, `maintain`). They work standalone — the current doc keeps functioning while these exist alongside it.
160
-
2. Cut a redirect at `kun.databayt.org/install` → `raw.githubusercontent.com/databayt/codebase/main/.claude/scripts/bootstrap.ps1`. Same for `/finish`.
161
-
3. Collapse the [Onboarding](/docs/onboarding) paste block to the single-line `irm https://kun.databayt.org/install | iex`. Keep Manual fallback as the existing chain for Team/Enterprise plans.
162
-
4. Update the team channel topic and joiner doc to point at the new flow.
163
-
5.**Run the new bootstrap on one volunteer's fresh VM** before any new hire sees it. The current doc shipped without this step — that's how we ended up with the lessons below.
157
+
1. ✅ Land scripts in `databayt/kun/.claude/scripts/` — `bootstrap`, `doctor`, `maintain`, `install`, `secrets`, `sync-repos`, plus 9 lib modules. All idempotent, syntax-checked, smoke-tested.
158
+
2. ✅ Redirect set in `next.config.ts`: `kun.databayt.org/install` → `raw.githubusercontent.com/databayt/kun/main/.claude/scripts/bootstrap.ps1`. Same for `/doctor` and `/finish`.
4. ✅ [Onboarding](/docs/onboarding) collapsed to single-paste, with Cowork-driven and Manual as alternatives.
161
+
5. ⏳ **Run on one volunteer's fresh Windows 11 VM** before pointing new hires at it. Validates: direct `winget install JetBrains.WebStorm` ships intact JBR (vs. needing Toolbox fallback), Marketplace plugin pre-drop loads on first IDE launch, OAuth batch survives the actual sign-in screens.
162
+
6. ⏳ Update team channel topic + joiner doc to cite the new flow.
Copy file name to clipboardExpand all lines: content/docs/onboarding.mdx
+70-95Lines changed: 70 additions & 95 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,130 +1,82 @@
1
1
---
2
2
title: Onboarding
3
-
description: Three actions, ~90 minutes to your first PR
3
+
description: One paste, one UAC, three sign-ins
4
4
---
5
5
6
6
# Onboarding
7
7
8
-
> Three actions. Cowork drives the rest.
8
+
> One paste. One UAC. Three sign-ins. ~90 minutes wall-clock, ~10 minutes of your attention.
9
9
10
-
The fastest path from a fresh Windows laptop to a databayt PR: install Claude Desktop, paste the team prompt into the Code tab, stay near the keyboard while it sets your machine up. Wall-clock ~90 minutes, mostly downloads. Human time ~10.
10
+
The canonical path from fresh Windows laptop to a databayt PR. Paste a single line, click Yes on one UAC prompt, walk away. Come back at the OAuth batch at the end, sign in to GitHub + Claude + JetBrains, done.
11
11
12
12
## What you end up with
13
13
14
14
- Claude Code CLI on `PATH`
15
-
- Full `~/.claude/` config — every agent, command, MCP server, rule, hook, memory file
- The `c` function — `claude --dangerously-skip-permissions` in one keystroke
17
-
- WebStorm with the Claude Code [Beta] plugin
18
-
-`databayt/codebase`cloned to `~\codebase`
19
-
-Every other active org repo cloned under `~\oss\<name>`
20
-
-`claude doctor` green
17
+
- WebStorm with the Claude Code [Beta] plugin pre-installed
18
+
-`databayt/codebase`at `~\codebase` + every other active org repo under `~\oss\<name>`
19
+
-Daily `kun-maintain` scheduled task armed for 09:00 — auto sync, doctor, notify
20
+
-`doctor` exits green
21
21
22
22
## Before you start
23
23
24
24
| Requirement | Why |
25
25
|---|---|
26
-
|**Pro or Max plan**|Computer use isn't on Team or Enterprise. Without it, jump to [Manual fallback](#manual-fallback).|
27
-
| Windows 11, admin rights |`winget` installs and `$PROFILE` edits need them.|
28
-
|~3 GB free disk | Claude Desktop + Node + WebStorm + org repos.|
26
+
|**Pro or Max plan**|The CLI needs a paid account; Cowork (if you use the alternative path below) needs computer use, which is Pro/Max only|
27
+
| Windows 11, admin rights |`winget` installs and `$PROFILE` edits need elevation|
28
+
|~3 GB free disk | Claude Desktop + Node + WebStorm + org repos |
29
29
30
-
If any row is missing, sort it before pasting — Cowork can't fix a Team plan.
30
+
## Recommended: single-paste
31
31
32
-
## The three actions
32
+
Open PowerShell and paste:
33
33
34
-
### 1. Install Claude Desktop and turn on computer use
35
-
36
-
Download and run the [Windows x64 installer](https://claude.ai/api/desktop/win32/x64/setup/latest/redirect) (or [ARM64](https://claude.ai/api/desktop/win32/arm64/setup/latest/redirect)).
37
-
38
-
Launch it. Sign in with your Anthropic account. Confirm the bottom-left badge says **Pro** or **Max** — if it says Team or Enterprise, the rest of this flow won't work; use [Manual fallback](#manual-fallback).
34
+
```powershell
35
+
irm https://kun.databayt.org/install | iex
36
+
```
39
37
40
-
Settings → General → scroll to **Desktop app** → toggle **Allow Claude to use your computer**. The first time Claude controls the screen, Windows prompts for accessibility access. Grant it. Reference: [Anthropic — computer use in Desktop](https://code.claude.com/docs/en/desktop#let-claude-use-your-computer).
38
+
That's the whole flow. The script:
41
39
42
-
### 2. Open the Code tab and paste the team prompt
When done, run `claude doctor`, screenshot the result, and list anything
91
-
still pending or anything I owe (OAuth completions, plan upgrades, etc.).
92
-
```
55
+
## Alternative: Cowork-driven
93
56
94
-
### 3. Stay near the keyboard
57
+
If you'd rather have an agent narrate every step (and you're on Pro/Max), use Claude Desktop's Code tab and paste the prompt below.
95
58
96
-
Cowork drives the installs. Your job is the irreducible human bits:
59
+
Download [Claude Desktop](https://claude.ai/api/desktop/win32/x64/setup/latest/redirect), sign in, turn on **Settings → General → Allow Claude to use your computer**. Open the **Code** tab, start a new session, paste:
97
60
98
-
-**One UAC prompt** when `winget` first elevates — click Yes.
99
-
-**OAuth sign-ins.** Cowork pauses on browser screens for GitHub (`gh auth login` device code), Claude (`claude` sign-in), and JetBrains (WebStorm first launch). Type the codes, click Authorize, return to Code, tell it to continue.
100
-
-**Plugin trust** if WebStorm prompts to trust the Claude Code [Beta] plugin.
61
+
```text
62
+
Set up this fresh Windows laptop for databayt.
101
63
102
-
Total human time: ~10 minutes spread over ~30–45 minutes of installs. Press **Esc** anywhere on screen to abort — Claude releases control and unhides your apps.
64
+
End state: everything in https://kun.databayt.org/docs/onboarding "What you end up with".
103
65
104
-
## When you're done
66
+
Use the kun bootstrap as your reference, run as much from PowerShell as
67
+
possible. Open browser tabs for OAuth and pause for me to sign in.
When done, run `doctor` and report any non-green rows.
114
73
```
115
74
116
-
If every line returns a non-empty result and `claude doctor` is green, you're done. Open WebStorm in any cloned repo and press `Ctrl+Esc` to start a Claude session in the IDE.
117
-
118
-
## If something fails
119
-
120
-
-**Esc aborts computer use** at any time. Apps unhide, control returns to you.
121
-
-**`claude doctor` is the single source of truth.** Re-run it after any fix; the output names what's missing.
122
-
-**Secrets out of date or missing?** Re-run `& "$env:USERPROFILE\.claude\scripts\secrets.ps1" -GistId 68453b25fa9d28c94426c55c179b3838` — it's idempotent.
123
-
-**Deeper failures?**[Onboarding reference](/docs/onboarding-reference) covers the orchestration model, the scripts contract, and the lessons from the first real run.
75
+
The Cowork path costs more tokens than the bare PowerShell paste (Cowork narrates each step) but gives you live commentary, the ability to interrupt with "stop, do X first," and a record of decisions in the chat history.
124
76
125
77
## Manual fallback
126
78
127
-
For Team or Enterprise plans (no computer use), or when you'd rather type. Run these in PowerShell.
79
+
For Team or Enterprise plans (no computer use), or when you'd rather drive every command yourself. Paste these in PowerShell:
128
80
129
81
```powershell
130
82
# Side-tools
@@ -152,7 +104,7 @@ if (Test-Path "$env:USERPROFILE\.claude\.env") {
If `doctor` is green, open WebStorm in any cloned repo and press `Ctrl+Esc` to start a Claude session in the IDE.
137
+
138
+
## If something fails
139
+
140
+
-**Re-run the same paste.** Every step is idempotent — second run skips what's done.
141
+
-**`doctor` is the single source of truth.** Output names exactly what's missing and how to fix it.
142
+
-**`doctor -Fix`** repairs the trivially-fixable: missing `c` function in `$PROFILE`, `~/.claude/bin` not on PATH.
143
+
-**OAuth aborted?** Re-paste; the script resumes at the OAuth step.
144
+
-**Deeper failures?**[Onboarding reference](/docs/onboarding-reference) covers the orchestration model, the scripts contract, and the lessons from the first real run.
145
+
172
146
## Daily entry points
173
147
174
148
| Action | How |
@@ -181,6 +155,7 @@ For hogwarts and other private secrets, your team contact shares the `.env` out-
181
155
| Send a note to the team |`c "/dispatch <message>"`|
0 commit comments