CLI Commands

All commands for the openboot CLI, organized by what you’re trying to do.

Set Up an Environment

`openboot`

Launch the interactive TUI installer. Browse packages, toggle what you want, and install.

openboot

`openboot --preset <name>`

Start with a preset’s packages pre-selected. Available: minimal, developer, full.

openboot --preset developer

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

`openboot install <username>/<slug>`

Install from a custom config hosted on openboot.dev.

openboot install sarah/frontend-team

Alternatively, use the --user flag: openboot --user sarah/frontend-team (same effect).

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

Install Flags

Flag	Description
`-p, --preset <name>`	Use a preset: `minimal`, `developer`, `full`
`-u, --user <username/slug>`	Install from a config hosted on openboot.dev
`-s, --silent`	Non-interactive mode — no TUI, no prompts
`--dry-run`	Preview what would be installed without installing
`--resume`	Resume an interrupted installation
`--packages-only`	Install packages only, skip shell/macOS/dotfiles config
`--shell <mode>`	`install` or `skip`
`--macos <mode>`	`configure` or `skip`
`--dotfiles <mode>`	`clone`, `link`, or `skip`
`--update`	Update Homebrew before installing
`--rollback`	Restore backed-up config files

Capture Your Environment

`openboot snapshot`

Scan your Mac’s current setup — packages, preferences, shell config, git settings — and upload or save it.

openboot snapshot

`openboot snapshot --local`

Save the snapshot to ~/.openboot/snapshot.json instead of uploading.

openboot snapshot --local

`openboot snapshot --json`

Output the snapshot as JSON to stdout. Useful for piping to jq or other tools.

openboot snapshot --json
openboot snapshot --json | jq '.packages.formulae'

`openboot snapshot --import <path>`

Restore an environment from a snapshot file or URL.

openboot snapshot --import my-setup.json
openboot snapshot --import https://example.com/snapshot.json

Snapshot Flags

Flag	Description
`--local`	Save to `~/.openboot/snapshot.json`
`--json`	Output as JSON to stdout
`--dry-run`	Preview without saving or uploading
`--import <path>`	Restore from a local file or URL

Authentication

`openboot login`

Authenticate with openboot.dev via browser. Required for installing private configs and uploading snapshots.

openboot login

Opens your browser to approve the login. After approval, a token is saved at ~/.openboot/auth.json.

`openboot logout`

Remove the stored authentication token from this machine.

openboot logout

Maintain Your Environment

`openboot doctor`

Run diagnostic checks — network, disk space, Homebrew health, Git config, shell setup.

openboot doctor

✓ Network connectivity
✓ Disk space (48 GB free)
✓ Homebrew installed
✓ Homebrew health
✓ Outdated packages (5 updates available)
✓ Git installed
✓ Git identity
✓ Oh-My-Zsh installed
✓ .zshrc exists

Suggested fixes:
  Run 'openboot update' to upgrade outdated packages

All checks passed! Your environment is healthy.

`openboot update`

Update Homebrew and upgrade all installed packages.

openboot update
openboot update --dry-run

`openboot update --self`

Update the OpenBoot binary to the latest version.

openboot update --self

Update Flags

Flag	Description
`--dry-run`	Preview what packages would be updated without upgrading
`--self`	Update the OpenBoot binary itself to the latest version

`openboot version`

Print the current OpenBoot version.

openboot version

See also: Config Options for the full config schema, and Environment Variables for all env vars that control the install script and CLI.