Local Commands

BatteryBee does not ship a standalone CLI. Day-to-day command-line workflows are repository scripts for running, testing, and opening the web designer.

Run the app

  • npm run web:dev starts the Next.js app from the repository root.
  • cd web && npm run dev runs the web app directly.
  • cd backend && uvicorn app.main:app --reload starts the FastAPI planning/export backend.
  • npm run open:designer opens the designer in Chrome with a local project flow helper.

Exercise common flows

  • npm run flow:designer:create drives the create-project flow.
  • npm run flow:designer:add-keepout exercises keep-out creation.
  • npm run flow:designer:drag-keepout checks keep-out drag behavior.
  • npm run flow:designer:delete-keepout checks keep-out deletion.
  • npm run ss:capture-home captures the maintained documentation screenshots.

Test and inspect

  • cd web && npm run test runs Vitest tests for the web app.
  • cd web && npm run build validates the Next.js production build.
  • cd backend && pytest runs backend tests when pytest is installed in the active environment.
  • cd backend && uvicorn app.main:app --reload runs the internal planning and export service locally.