Skip to content

Commit 5efb5bf

Browse files
fullstackjamclaude
andcommitted
docs: update CLI install docs for alias-first resolution
Document that `openboot install <word>` resolves aliases first before falling back to username/default. Update cli-reference, config-options, and custom-configs docs. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 133424c commit 5efb5bf

File tree

3 files changed

+28
-8
lines changed

3 files changed

+28
-8
lines changed

src/docs/cli-reference.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,27 @@ openboot --preset developer
2929

3030
You can still customize in the TUI. To skip the TUI entirely, add `--silent`.
3131

32-
### `openboot install <username>/<slug>`
32+
### `openboot install <alias>` or `openboot install <username>/<slug>`
3333

34-
Install from a custom config hosted on openboot.dev.
34+
Install from a config hosted on openboot.dev.
35+
36+
If you set an alias for your config in the dashboard, use it directly:
37+
38+
```
39+
openboot install myalias
40+
```
41+
42+
Or use the full username/slug format:
3543

3644
```
3745
openboot install sarah/frontend-team
3846
```
3947

40-
Alternatively, use the `--user` flag: `openboot --user sarah/frontend-team` (same effect).
48+
**Resolution order** for a single word (no `/`):
49+
1. Try as a config alias (set in the dashboard)
50+
2. Fall back to `username/default` config
51+
52+
Alternatively, use the `--user` flag: `openboot --user myalias` (same effect).
4153

4254
For private configs, run `openboot login` first — the CLI sends your auth token automatically.
4355

@@ -46,7 +58,7 @@ For private configs, run `openboot login` first — the CLI sends your auth toke
4658
| Flag | Description |
4759
|------|-------------|
4860
| `-p, --preset <name>` | Use a preset: `minimal`, `developer`, `full` |
49-
| `-u, --user <username/slug>` | Install from a config hosted on openboot.dev |
61+
| `-u, --user <alias or username/slug>` | Install from a config hosted on openboot.dev |
5062
| `-s, --silent` | Non-interactive mode — no TUI, no prompts |
5163
| `--dry-run` | Preview what would be installed without installing |
5264
| `--packages-only` | Install packages only, skip shell/macOS/dotfiles config |

src/docs/config-options.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,9 @@ 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 with a shorter command — for example, `openboot install my-setup` instead of `openboot install username/slug`.
106+
Short URL alias for easy sharing. If set, this alias becomes the primary way to install the config — for example, `openboot install my-setup` instead of `openboot install username/slug`. The alias also works as a short URL: `openboot.dev/my-setup`.
107+
108+
When a user runs `openboot install <word>`, the CLI checks aliases first before falling back to `username/default`.
107109

108110
- **Type:** string
109111
- **Required:** no

src/docs/custom-configs.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,12 +115,18 @@ openboot login
115115
openboot install yourname/my-setup
116116
```
117117

118-
## Short URLs
118+
## Aliases & Short URLs
119119

120-
Config slugs are auto-generated, but you can edit them in the dashboard. Keep them short:
120+
Set an alias in the dashboard to get a short install command and URL:
121+
122+
- `openboot install myalias` instead of `openboot install yourname/my-long-slug`
123+
- `openboot.dev/myalias` instead of `openboot.dev/yourname/my-long-slug`
124+
125+
Aliases must be unique across all configs. When a user runs `openboot install <word>`, the CLI resolves aliases first.
126+
127+
You can also shorten your config slugs in the dashboard:
121128

122129
- `openboot.dev/yourname/ios` instead of `openboot.dev/yourname/ios-development-team-2024`
123-
- `openboot.dev/yourname/ml` instead of `openboot.dev/yourname/machine-learning-setup`
124130

125131
## Install Tracking
126132

0 commit comments

Comments
 (0)