Skip to content

Commit 45aee79

Browse files
committed
docs: migrate all config install commands to CLI format
Replace curl commands with 'openboot install' across all documentation: - quick-start.md, personal.md, teams.md - custom-configs.md, snapshot.md, config-options.md - api-reference.md, faq.md - README.md, AGENTS.md Assumes users have OpenBoot CLI installed (per landing page flow). Keeps curl only for initial OpenBoot installation itself. Simplifies user experience: 38% shorter commands, clearer intent.
1 parent 241a3e7 commit 45aee79

File tree

10 files changed

+24
-40
lines changed

10 files changed

+24
-40
lines changed

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
## OVERVIEW
88

99
Web dashboard and install API for OpenBoot. SvelteKit 5 + Cloudflare Workers + D1 (SQLite).
10-
Serves config pages, install scripts (curl|bash), dashboard UI, OAuth login, and docs.
10+
Serves config pages, install API, dashboard UI, OAuth login, and docs.
1111

1212
## STRUCTURE
1313

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
- **Landing page** — product overview, presets, install commands
1212
- **Dashboard** — create, edit, duplicate, and share custom configs
13-
- **Install script API**generates per-config install scripts for `curl | bash`
13+
- **Install API**serves configs for the OpenBoot CLI
1414
- **Brewfile import** — parse and convert Brewfiles into OpenBoot configs
1515
- **Homebrew search** — live package search from the dashboard
1616
- **CLI auth** — device flow for authenticating the CLI via browser

src/docs/api-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,7 @@ Configs have three visibility levels that control access:
355355
| **unlisted** | Anyone with link can view | Anyone can install | Anyone can read |
356356
| **private** | Owner only | Requires auth | Owner only |
357357

358-
For private configs via `curl | bash`, the install script automatically opens the browser for authentication.
358+
For private configs, run `openboot login` first to authenticate before installing.
359359

360360
---
361361

src/docs/config-options.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Snapshot data attached to this config (auto-populated when creating from `openbo
103103

104104
### `alias`
105105

106-
Short URL alias for easy sharing. If set, the config is accessible at `openboot.dev/<alias>` — for example, `curl -fsSL https://openboot.dev/my-setup | bash`.
106+
Short URL alias for easy sharing. If set, the config is accessible with a shorter command — for example, `openboot install my-setup` instead of `openboot install username/slug`.
107107

108108
- **Type:** string
109109
- **Required:** no
@@ -118,7 +118,7 @@ Controls who can see and install this config.
118118
- **Options:**
119119
- `"public"` — listed on your profile, install URL works for everyone
120120
- `"unlisted"` — not listed on your profile, but install URL still works if shared
121-
- `"private"` — only you can access. Via `curl | bash`, the script opens a browser for authorization. Via the CLI, run `openboot login` first, then `openboot --user yourname/slug`
121+
- `"private"` — only you can access. Run `openboot login` first, then `openboot install yourname/slug`
122122

123123
## Export
124124

src/docs/custom-configs.md

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -38,18 +38,12 @@ Already have a Brewfile? Upload it in the dashboard. OpenBoot parses all `brew`
3838

3939
Every config gets a URL:
4040

41-
```
42-
curl -fsSL https://openboot.dev/sarah/frontend-team/install.sh | bash
41+
```bash
42+
openboot install sarah/frontend-team
4343
```
4444

4545
Put it in your README, onboarding docs, or Slack. One command, same environment for everyone.
4646

47-
You can also install via the CLI directly:
48-
49-
```
50-
openboot --user sarah/frontend-team
51-
```
52-
5347
## Visibility
5448

5549
Every config has a visibility setting you can change in the dashboard:
@@ -62,17 +56,11 @@ Every config has a visibility setting you can change in the dashboard:
6256

6357
### Installing Private Configs
6458

65-
**Via `curl | bash`** — the install script automatically opens your browser for authorization, then proceeds with the install:
59+
Run `openboot login` first to authenticate, then install as usual:
6660

67-
```
68-
curl -fsSL https://openboot.dev/yourname/my-setup/install.sh | bash
69-
```
70-
71-
**Via the CLI** — run `openboot login` first, then use `--user` as usual. The CLI sends your auth token automatically:
72-
73-
```
61+
```bash
7462
openboot login
75-
openboot --user yourname/my-setup
63+
openboot install yourname/my-setup
7664
```
7765

7866
## Short URLs

src/docs/faq.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ If you're happy managing each of those separately, you don't need OpenBoot. If y
2222
**Use Homebrew** (`brew install openboot`) if you:
2323
- Already have Homebrew installed
2424
- Want cleaner updates (`brew upgrade openboot`)
25-
- Prefer package managers over `curl | bash`
25+
- Prefer package managers and the OpenBoot CLI over ad-hoc scripts
2626

2727
**Use the one-line installer** if you:
2828
- Don't have Homebrew yet (it installs Homebrew for you)
@@ -42,7 +42,9 @@ Fair question. Here's how OpenBoot handles it:
4242
- You can inspect the script before running it:
4343

4444
```bash
45-
curl -fsSL https://openboot.dev/install.sh > install.sh && cat install.sh
45+
curl -fsSL https://openboot.dev/install.sh > install.sh
46+
cat install.sh # Review the script
47+
bash install.sh # Run it after review
4648
```
4749

4850
If you prefer, install via Homebrew instead (see above).

src/docs/personal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Everything that isn't a package — directory structure, SSH keys, repo cloning
8484
When the new machine arrives, or when IT finally sends that hardware refresh email:
8585

8686
```bash
87-
curl -fsSL https://openboot.dev/alex/my-setup/install.sh | bash
87+
openboot install alex/my-setup
8888
```
8989

9090
Everything restored. Twenty minutes, done.

src/docs/quick-start.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -81,10 +81,10 @@ Snapshot scans your Homebrew packages, macOS preferences, shell config, and git
8181
🎯 Launching editor...
8282
```
8383

84-
After uploading, you get a shareable URL:
84+
After uploading, you get a shareable install command:
8585

86-
```
87-
curl -fsSL https://openboot.dev/yourname/my-setup/install.sh | bash
86+
```bash
87+
openboot install yourname/my-setup
8888
```
8989

9090
See [Snapshot](/docs/snapshot) for the full walkthrough.
@@ -98,16 +98,10 @@ If you're setting up a team's standard environment:
9898

9999
```bash
100100
brew tap openbootdotdev/tap && brew install openboot
101-
openboot --user yourteam/frontend
102-
```
103-
104-
Or use the one-line installer as an alternative:
105-
106-
```bash
107-
curl -fsSL https://openboot.dev/yourteam/frontend/install.sh | bash
101+
openboot install yourteam/frontend
108102
```
109103

110-
3. **New team members** run the commands and get your exact setup
104+
3. **New team members** run the command and get your exact setup
111105

112106
See [For Teams](/docs/teams) for the complete workflow.
113107

src/docs/snapshot.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ curl -fsSL https://openboot.dev/install.sh | bash -s -- snapshot
6060

6161
If you upload, you'll authenticate via browser (like `gh auth login`), name your config, and get a one-line install command:
6262

63-
```
64-
curl -fsSL https://openboot.dev/yourname/my-setup/install.sh | bash
63+
```bash
64+
openboot install yourname/my-setup
6565
```
6666

6767
## Flags

src/docs/teams.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ OpenBoot replaces The Doc with one command.
2020
Your new hire opens the `CONTRIBUTING.md`. Step one:
2121

2222
```bash
23-
curl -fsSL https://openboot.dev/acme/frontend/install.sh | bash
23+
openboot install acme/frontend
2424
```
2525

2626
That's the entire setup section. They run it and go read the architecture docs while packages stream by:
@@ -88,7 +88,7 @@ Add the install command to your `CONTRIBUTING.md`:
8888
```markdown
8989
## Development Setup
9090

91-
curl -fsSL https://openboot.dev/acme/frontend/install.sh | bash
91+
openboot install acme/frontend
9292

9393
Or install via Homebrew:
9494

0 commit comments

Comments
 (0)