|
1 | 1 | --- |
2 | 2 | title: CLI Commands |
3 | | -description: Complete reference for all openboot commands — install, snapshot, login, doctor, update, and their flags. |
| 3 | +description: Complete reference for all openboot commands — install, snapshot, sync, push, pull, log, restore, list, edit, login, doctor, update, and their flags. |
4 | 4 | group: Reference |
5 | 5 | order: 9 |
6 | 6 | --- |
@@ -146,6 +146,211 @@ A review editor appears before any changes are made, letting you deselect items |
146 | 146 | | `--dry-run` | Preview without saving, uploading, or installing | |
147 | 147 | | `--import <path>` | Restore from a local file or URL | |
148 | 148 |
|
| 149 | +--- |
| 150 | + |
| 151 | +## Manage Your Remote Config |
| 152 | + |
| 153 | +These commands work with configs stored on openboot.dev. They follow a git-style mental model: `push` saves your state, `pull` applies the remote to your system, `log` shows history, `restore` rolls back. |
| 154 | + |
| 155 | +### `openboot push` |
| 156 | + |
| 157 | +Capture your current system state and upload it to openboot.dev. If a sync source is configured (from a previous `openboot install`), it updates that config silently. Otherwise, an interactive picker lets you choose an existing config to update or create a new one. |
| 158 | + |
| 159 | +``` |
| 160 | +openboot push |
| 161 | +``` |
| 162 | + |
| 163 | +Attach a message to the revision (shown in `openboot log`): |
| 164 | + |
| 165 | +``` |
| 166 | +openboot push -m "before upgrading to Node 22" |
| 167 | +``` |
| 168 | + |
| 169 | +Target a specific config by slug: |
| 170 | + |
| 171 | +``` |
| 172 | +openboot push --slug my-config |
| 173 | +``` |
| 174 | + |
| 175 | +#### Push Flags |
| 176 | + |
| 177 | +| Flag | Description | |
| 178 | +|------|-------------| |
| 179 | +| `--slug <slug>` | Push to a specific existing config | |
| 180 | +| `-m, --message <text>` | Revision message saved in history | |
| 181 | + |
| 182 | +--- |
| 183 | + |
| 184 | +### `openboot pull` |
| 185 | + |
| 186 | +Fetch the latest version of your remote config and apply it to your local system. Equivalent to `git pull` — syncs the remote state down to your machine. |
| 187 | + |
| 188 | +``` |
| 189 | +openboot pull |
| 190 | +``` |
| 191 | + |
| 192 | +#### Pull Flags |
| 193 | + |
| 194 | +| Flag | Description | |
| 195 | +|------|-------------| |
| 196 | +| `--slug <slug>` | Pull from a specific config | |
| 197 | +| `--dry-run` | Preview changes without applying them | |
| 198 | +| `-y, --yes` | Auto-confirm all prompts | |
| 199 | + |
| 200 | +--- |
| 201 | + |
| 202 | +### `openboot sync` |
| 203 | + |
| 204 | +Fetch the remote config and show what differs from your local system, then let you selectively apply changes. More granular than `pull` — you choose which packages to install or remove. |
| 205 | + |
| 206 | +``` |
| 207 | +openboot sync |
| 208 | +``` |
| 209 | + |
| 210 | +``` |
| 211 | +openboot sync --yes # apply all changes without prompting |
| 212 | +openboot sync --dry-run # preview only |
| 213 | +``` |
| 214 | + |
| 215 | +#### Sync Flags |
| 216 | + |
| 217 | +| Flag | Description | |
| 218 | +|------|-------------| |
| 219 | +| `--source <username/slug>` | Sync from a specific config | |
| 220 | +| `--dry-run` | Preview without applying | |
| 221 | +| `-y, --yes` | Auto-confirm all changes | |
| 222 | +| `--install-only` | Only install missing packages, never remove extras | |
| 223 | + |
| 224 | +--- |
| 225 | + |
| 226 | +### `openboot diff` |
| 227 | + |
| 228 | +Show what differs between your local system and your remote config, without applying any changes. |
| 229 | + |
| 230 | +``` |
| 231 | +openboot diff |
| 232 | +``` |
| 233 | + |
| 234 | +--- |
| 235 | + |
| 236 | +### `openboot list` |
| 237 | + |
| 238 | +Show all configs in your openboot.dev account. The config currently linked to this machine is marked with `→`. |
| 239 | + |
| 240 | +``` |
| 241 | +openboot list |
| 242 | +``` |
| 243 | + |
| 244 | +``` |
| 245 | +=== Configs for fullstackjam === |
| 246 | +
|
| 247 | +→ jam-s-packages Jam's packages [public] |
| 248 | + work-mac Work Machine |
| 249 | + minimal |
| 250 | +
|
| 251 | +Install: openboot -u fullstackjam/<slug> • Edit: openboot edit --slug <slug> • Delete: openboot delete <slug> |
| 252 | +``` |
| 253 | + |
| 254 | +--- |
| 255 | + |
| 256 | +### `openboot edit` |
| 257 | + |
| 258 | +Pick a config from your account and open it in the browser for editing. Shows an interactive list of your configs — select one to open the edit page on openboot.dev. |
| 259 | + |
| 260 | +``` |
| 261 | +openboot edit |
| 262 | +``` |
| 263 | + |
| 264 | +Skip the picker and open a specific config directly: |
| 265 | + |
| 266 | +``` |
| 267 | +openboot edit --slug my-config |
| 268 | +``` |
| 269 | + |
| 270 | +#### Edit Flags |
| 271 | + |
| 272 | +| Flag | Description | |
| 273 | +|------|-------------| |
| 274 | +| `--slug <slug>` | Open a specific config (skips the picker) | |
| 275 | + |
| 276 | +--- |
| 277 | + |
| 278 | +### `openboot log` |
| 279 | + |
| 280 | +Show the revision history for your config. Every `push` automatically saves the previous version as a revision. |
| 281 | + |
| 282 | +``` |
| 283 | +openboot log |
| 284 | +``` |
| 285 | + |
| 286 | +``` |
| 287 | +=== Revision history: jam-s-packages === |
| 288 | +
|
| 289 | + rev_abc123 2026-04-10 14:32 26 pkgs before upgrading to Node 22 |
| 290 | + rev_def456 2026-04-08 09:15 24 pkgs |
| 291 | + rev_ghi789 2026-04-01 11:00 20 pkgs |
| 292 | +
|
| 293 | +Use 'openboot restore <revision-id>' to roll back to a previous state. |
| 294 | +``` |
| 295 | + |
| 296 | +Up to 10 revisions are kept per config. Oldest are pruned automatically. |
| 297 | + |
| 298 | +#### Log Flags |
| 299 | + |
| 300 | +| Flag | Description | |
| 301 | +|------|-------------| |
| 302 | +| `--slug <slug>` | Show history for a specific config | |
| 303 | + |
| 304 | +--- |
| 305 | + |
| 306 | +### `openboot restore <revision-id>` |
| 307 | + |
| 308 | +Roll back your config to a previous revision. The current config is automatically saved as a new revision first (so you can always undo). After updating the server config, the changes are applied to your local system via sync. |
| 309 | + |
| 310 | +``` |
| 311 | +openboot restore rev_abc123 |
| 312 | +``` |
| 313 | + |
| 314 | +Preview what would change without applying: |
| 315 | + |
| 316 | +``` |
| 317 | +openboot restore rev_abc123 --dry-run |
| 318 | +``` |
| 319 | + |
| 320 | +Get revision IDs from `openboot log`. |
| 321 | + |
| 322 | +#### Restore Flags |
| 323 | + |
| 324 | +| Flag | Description | |
| 325 | +|------|-------------| |
| 326 | +| `--slug <slug>` | Restore a specific config | |
| 327 | +| `--dry-run` | Preview changes without applying them | |
| 328 | +| `-y, --yes` | Auto-confirm all prompts | |
| 329 | + |
| 330 | +--- |
| 331 | + |
| 332 | +### `openboot delete <slug>` |
| 333 | + |
| 334 | +Delete a config from your openboot.dev account. |
| 335 | + |
| 336 | +``` |
| 337 | +openboot delete my-config |
| 338 | +``` |
| 339 | + |
| 340 | +Skip the confirmation prompt: |
| 341 | + |
| 342 | +``` |
| 343 | +openboot delete my-config --force |
| 344 | +``` |
| 345 | + |
| 346 | +#### Delete Flags |
| 347 | + |
| 348 | +| Flag | Description | |
| 349 | +|------|-------------| |
| 350 | +| `-f, --force` | Skip the confirmation prompt | |
| 351 | + |
| 352 | +--- |
| 353 | + |
149 | 354 | ## Authentication |
150 | 355 |
|
151 | 356 | ### `openboot login` |
|
0 commit comments