Skip to content

Commit 2ec61f4

Browse files
committed
docs: update CLI reference, visibility, env vars, and FAQ for login/logout and private configs
1 parent e505ee7 commit 2ec61f4

5 files changed

Lines changed: 54 additions & 7 deletions

File tree

src/docs/cli-reference.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ Install from a custom config hosted on openboot.dev.
3636
openboot --user sarah/frontend-team
3737
```
3838

39+
For private configs, run `openboot login` first — the CLI sends your auth token automatically.
40+
3941
### Install Flags
4042

4143
| Flag | Description |
@@ -97,6 +99,26 @@ openboot snapshot --import https://example.com/snapshot.json
9799
| `--dry-run` | Preview without saving or uploading |
98100
| `--import <path>` | Restore from a local file or URL |
99101

102+
## Authentication
103+
104+
### `openboot login`
105+
106+
Authenticate with openboot.dev via browser. Required for installing private configs and uploading snapshots.
107+
108+
```
109+
openboot login
110+
```
111+
112+
Opens your browser to approve the login. After approval, a token is saved at `~/.openboot/auth.json`.
113+
114+
### `openboot logout`
115+
116+
Remove the stored authentication token from this machine.
117+
118+
```
119+
openboot logout
120+
```
121+
100122
## Maintain Your Environment
101123

102124
### `openboot doctor`

src/docs/config-options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ Controls who can see and install this config.
114114
- **Options:**
115115
- `"public"` — listed on your profile, install URL works for everyone
116116
- `"unlisted"` — not listed on your profile, but install URL still works if shared
117-
- `"private"` — only you can access. Installing via `curl | bash` will open a browser for authorization, then proceed automatically
117+
- `"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`
118118

119119
## Export
120120

src/docs/custom-configs.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,30 @@ You can also install via the CLI directly:
4949
openboot --user sarah/frontend-team
5050
```
5151

52-
## Public vs Private
52+
## Visibility
5353

54-
- **Public** (default) — anyone can view the config page and install
55-
- **Private** — hidden from your profile, but the install URL still works if shared
54+
Every config has a visibility setting you can change in the dashboard:
55+
56+
| Visibility | Listed on Profile | Install URL | Config Page |
57+
|------------|:-:|:-:|:-:|
58+
| **Public** | Yes | Works for everyone | Viewable by anyone |
59+
| **Unlisted** (default) | No | Works for everyone | Viewable with direct link |
60+
| **Private** | No | Requires auth | Owner only |
61+
62+
### Installing Private Configs
63+
64+
**Via `curl | bash`** — the install script automatically opens your browser for authorization, then proceeds with the install:
65+
66+
```
67+
curl -fsSL https://openboot.dev/yourname/my-setup/install.sh | bash
68+
```
69+
70+
**Via the CLI** — run `openboot login` first, then use `--user` as usual. The CLI sends your auth token automatically:
71+
72+
```
73+
openboot login
74+
openboot --user yourname/my-setup
75+
```
5676

5777
## Short URLs
5878

src/docs/env-vars.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ These are used by the `openboot` binary at runtime.
5050
| `OPENBOOT_PRESET` | Default preset to use (overridden by `--preset` flag) |
5151
| `OPENBOOT_USER` | Default remote config to use (overridden by `--user` flag) |
5252
| `OPENBOOT_DOTFILES` | Dotfiles repository URL (overridden by config's `dotfiles_repo`) |
53+
| `OPENBOOT_API_URL` | Override the API base URL (default: `https://openboot.dev`) |
54+
| `OPENBOOT_DISABLE_AUTOUPDATE` | Set to `1` to disable auto-update checks |
5355

5456
### Examples
5557

@@ -74,6 +76,6 @@ These aren't environment variables, but useful to know:
7476
| Path | What's There |
7577
|------|-------------|
7678
| `~/.openboot/bin/openboot` | The OpenBoot binary |
77-
| `~/.openboot/auth.json` | Auth token (after `openboot snapshot` upload) |
79+
| `~/.openboot/auth.json` | Auth token (after `openboot login` or snapshot upload) |
7880
| `~/.openboot/snapshot.json` | Local snapshot (when using `--local`) |
7981
| `~/.dotfiles/` | Cloned dotfiles repo (when configured) |

src/docs/faq.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,10 @@ Yes. No account needed for:
4242
- Using the interactive TUI
4343
- Running `openboot snapshot --local` or `--json`
4444

45-
An account (GitHub OAuth) is only needed to upload configs to openboot.dev and share them via URL.
45+
An account (GitHub or Google OAuth) is needed to:
46+
47+
- Upload configs to openboot.dev and share them via URL
48+
- Install private configs (run `openboot login` first)
4649

4750
## How do I update OpenBoot?
4851

@@ -61,7 +64,7 @@ Or re-run the install script — it downloads the latest binary and replaces the
6164
| Local snapshots | `~/.openboot/snapshot.json` (local) |
6265
| OpenBoot binary | `~/.openboot/bin/openboot` (local) |
6366

64-
Configs are public by default. You can mark them private in the dashboard — they'll be hidden from your profile but the install URL still works if shared.
67+
Configs are **unlisted** by default — not listed on your profile, but the install URL works if shared. You can set them to **public** (listed on profile) or **private** (requires authentication to install). See [Custom Configs — Visibility](/docs/custom-configs#visibility) for details.
6568

6669
## What shell does OpenBoot set up?
6770

0 commit comments

Comments
 (0)