Skip to content

docs: replace box CLI commands with wheels CLI throughout guides #2541

Description

@bpamiri

Background

Now that LuCLI is the canonical CLI for Wheels 4.0 (wheels …), the documentation still has many call-sites that use the legacy CommandBox form (box wheels …, box install, box reload, box server start, etc.). These need to be converted to the wheels … equivalents so a reader following the guides isn't asked to install CommandBox unnecessarily.

Scope

A scan of web/sites/guides/ and docs/ turned up ~105 matches across 33 files. Breakdown:

Priority 1 — v4-0-0-snapshot/ (active docs)

Only 2 files in the active docs tree:

Priority 2 — v3-0-0/ (older versioned docs)

~25 files, mostly under command-line-tools/ and working-with-wheels/. Highest-density:

  • v3-0-0/introduction/readme/boxlang-support.md (17)
  • v3-0-0/working-with-wheels/using-the-test-environment.md (13)
  • v3-0-0/command-line-tools/commands/core/deps.md (7)

Out of scope

  • docs/superpowers/plans/*.md — point-in-time implementation plans, leave as historical record.
  • web/sites/guides/src/content/docs/v2-5-0/ — frozen archive snapshot, optional.
  • Legitimate prose uses of "box" ("out of the box", "Windows box", "shared dev box", "sandbox") — must NOT be touched. The grep used \bbox\s+(install|server|run|wheels|version|exec|task|reload|cfpm)\b to scope this.

Important nuances

  1. Don't blindly replace. Some box server start cfengine=adobe@2025 examples in cfml-engines.mdx are intentional — Adobe CF and BoxLang users still need CommandBox because LuCLI's wheels start assumes the bundled Lucee Express. The fix is to clarify the surrounding prose, not to rewrite the command.
  2. Mapping cheat-sheet for the easy cases:
    Legacy (box …) Modern (wheels …)
    box install wheels-cli brew install wheels (or platform equivalent — link to installation guide)
    box wheels generate app … wheels new …
    box wheels test app wheels test run
    box wheels browser:install wheels browser setup
    box reload wheels reload
    box server start (Lucee) wheels start
    box server stop (Lucee) wheels stop
    box server start cfengine=adobe@… leave as-is — Adobe CF path
  3. Verify each change against the current CLI surface before committing — wheels --help and cli/lucli/Module.cfc are the source of truth.

Acceptance criteria

  • Both v4-0-0-snapshot/ files updated; commands tested by following the guide on a clean machine (or via tools/test-onboarding.sh).
  • v3-0-0/ files updated where the doc is still relevant in the v3 context (some v3 commands genuinely never had a wheels equivalent — flag those).
  • Adobe CF / BoxLang sections retain their box server … examples with clarifying prose.
  • No legitimate English prose touched.
  • commitlint scope: use docs (no scope) per CLAUDE.md § Commit Message Conventions, one PR per major doc tree (v4 first, v3 second).

Reproduction commands

# Find all CLI-shaped box references across the guides
rg -n '\bbox\s+(install|server|run|wheels|version|exec|task|reload|cfpm)\b' \
  web/sites/guides/src/content/docs/

# Spot-check the active docs only
rg -n '\bbox\s+' web/sites/guides/src/content/docs/v4-0-0-snapshot/

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions