Skip to content

Simplify CLI reference for v1.0: remove deprecated commands#2

Merged
fullstackjam merged 1 commit intomainfrom
claude/update-openboot-docs-3QQGA
Apr 19, 2026
Merged

Simplify CLI reference for v1.0: remove deprecated commands#2
fullstackjam merged 1 commit intomainfrom
claude/update-openboot-docs-3QQGA

Conversation

@fullstackjam
Copy link
Copy Markdown
Contributor

Summary

Major documentation update reflecting OpenBoot v1.0's simplified command set. The CLI has been reduced to two core verbs (install and snapshot) plus authentication and version commands. All deprecated commands (pull, push, sync, diff, log, restore, init, list, edit, delete, clean, doctor, update) have been removed from documentation.

Key Changes

  • Removed entire sections for deprecated commands: pull, push, sync, diff, log, restore, init, setup-agent, doctor, update, list, edit, delete, clean
  • Removed .openboot.yml reference (src/docs/openboot-yml.md) — project-level config is no longer supported
  • Restructured CLI reference to focus on two core commands:
    • openboot install [source] — add packages to your Mac (add-only, never uninstalls)
    • openboot snapshot — capture your environment and optionally publish
  • Updated install behavior to clarify resume logic: if a machine has a saved sync source, it resumes; otherwise interactive TUI launches
  • Clarified snapshot destinations with explicit flag behavior (--local, --publish, --json, --import)
  • Added migration note pointing users to the CHANGELOG for v1.0 migration guidance
  • Updated all CLI examples throughout docs to use new command syntax (e.g., openboot install -p minimal instead of openboot --preset minimal)
  • Simplified environment variables section — removed many CLI vars no longer used in v1.0
  • Updated FAQ and quick-start to reflect simplified feature set and new Homebrew tap name (openbootdotdev/tap/openboot)

Notable Details

  • install is now explicitly add-only — users are directed to brew uninstall for removal
  • snapshot --publish now overwrites existing configs in place (no revision history)
  • Config management moved entirely to the dashboard (no CLI-based edit, list, delete)
  • Install script still handles Xcode CLT and Homebrew bootstrap, but OpenBoot itself is installed via Homebrew

https://claude.ai/code/session_01WkokhHbNczZSrU1QAXJz5B

OpenBoot v1.0 narrowed the CLI to install + snapshot and removed 13
commands (pull, push, diff, clean, log, restore, init, setup-agent,
doctor, update, list, edit, delete). This aligns the docs with the new
surface:

- Rewrite cli-reference.md around install/snapshot/login/version;
  document positional source resolution, add-only install, sync-source
  resume, and snapshot --publish/--slug.
- Rewrite env-vars.md: drop OPENBOOT_DOTFILES, OPENBOOT_API_URL,
  OPENBOOT_DISABLE_AUTOUPDATE, OPENBOOT_INSTALL_DIR,
  OPENBOOT_SKIP_CHECKSUM, and stale file-location paths.
- Rewrite snapshot.md: document --publish, --slug, TTY/pipe behavior,
  and that shell capture now actually populates.
- Rewrite quick-start.md and faq.md: drop openboot update --self, add
  the "running again" sync flow, clarify that install is add-only.
- Delete openboot-yml.md (openboot init was removed with no replacement).
- Switch openboot --preset/--shell/--dotfiles/--macos examples to the
  openboot install -p/--shell/... forms in presets.md and
  dotfiles-shell.md.
- Update llms.txt/llms-full.txt to match.
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@fullstackjam fullstackjam merged commit 0229700 into main Apr 19, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants