Skip to content

README.md

Latest commit

 

History

History
79 lines (50 loc) · 1.35 KB

README.md

File metadata and controls

79 lines (50 loc) · 1.35 KB

@burns/cli

CLI distribution package for running Burns without the web dev server workflow.

Prerequisites

  • Bun 1.2.x
  • Repository checkout containing apps/daemon and apps/web

Commands

Run from repository root:

bun run apps/cli/src/bin.ts --help

or from the package directory:

cd apps/cli
bun run src/bin.ts --help

burns start

Starts daemon and (when available) serves prebuilt web assets from dist/web.

burns start

Options:

  • --open: open a web URL in your browser after daemon startup
  • --web-url <url>: URL opened by --open (default: http://127.0.0.1:4173)

burns daemon

Starts daemon only.

burns daemon

burns web

Serves static web assets from dist/web.

burns web

Options:

  • --host <host>: bind host (default: 127.0.0.1)
  • --port <port>: bind port (default: 4173)
  • --open: open served URL in your browser

If dist/web is missing, the CLI prints guidance to run:

bun run build:web

Notes

  • The CLI reuses daemon startup by importing apps/daemon/src/bootstrap/daemon-lifecycle.ts.
  • Default daemon API URL is http://localhost:7332.

Packaging helper

Build a CLI artifact tarball for release collection:

bun run build:artifact

This writes an archive into dist/cli via scripts/release/build-cli-artifact.sh.