Skip to content

2026-03-11 docs CLI UI polish plan

Background

robot-map-docs previously printed a single plain startup line. The command worked, but the startup UX was minimal and lacked optional browser auto-open.

Goal and scope

  • Improve startup presentation while keeping command behavior lightweight.
  • Add optional browser auto-open without changing default safety.
  • Keep implementation limited to the docs server bin script.

Chosen approach

  • Add a compact colorized startup banner with key runtime details.
  • Introduce CLI flags:
    • --open / -o
    • --no-open
    • --quiet / -q
  • Support environment-based open toggle:
    • ROBOT_MAP_DOCS_OPEN=1|true
  • Add structured log helpers and better startup error hints (including EADDRINUSE guidance).
  • Keep request handling and file serving logic unchanged.

Impacted files or modules

  • bin/docs-server.js
  • docs/records/plans/2026-03-11-docs-cli-ui-polish-plan.md

Verification checklist

  • [x] npm run lint
  • [x] npx tsc --noEmit
  • [x] node bin/docs-server.js --help shows the new flags

最后更新于: