@viloris/vela

Developer CLI for Vela: instant dogfood and desktop static packaging.

Install

Requires Bun ≥ 1.1 (CLI process runtime).

npm registry (when published)

bun add -g @viloris/vela
# or project-local
bun add -d @viloris/vela
bunx vela --help

npm install -g @viloris/vela works the same.

GitHub Release / local tarball

Packages are packed as dist-npm/viloris-vela-*.tgz and attached to Releases under npm/:

# from a downloaded release asset or monorepo dist-npm/
bun add -g ./viloris-vela-0.0.1.tgz

# rebuild tarballs in a clone
bun install && bun run npm:packages
bun add -g ./dist-npm/viloris-vela-0.0.1.tgz

Standalone installs need a composition Shell for native windows: pass --shell <path>, set VELA_SHELL, or use --browser / build --no-shell. See the root README.

Commands

vela dev              # nearest vela.json (or monorepo pick)
vela dev --browser    # content server only (mock window.vela)
vela dev --dir .      # explicit App package root
vela build            # desktop static package (App + Shell)
vela build --no-shell # content tree only
vela build --archive  # + release archive (clock-linux-0.0.1.tar.gz)
vela run              # launch last build (dist/desktop/<platform>)
vela run --out <dir>  # launch an explicit package tree
vela --version
vela --help

vela build details

• Bundles the App web content (entry HTML + TS bundle + statics) into resources/app. Relative HTML references are rewritten to the content root (subdir entry.web like dist/index.html still works), referenced files are copied, and a missing ./main.js module script is injected automatically.
• Extra static files/dirs, TS entry, minify/sourcemap defaults, and an icon are configurable per package under vela.json build.* (see app-package-layout.md).
• Rebuilds the output dir clean by default (--no-clean to keep files), records sha256 integrity hashes in vela-build.json, verifies the tree, and can emit a tar.gz/zip/tar release archive (--archive [format]).

See run modes.

Shell binary (native)

vela dev / vela build without --browser / --no-shell need a composition Shell:

| Context | How Shell is resolved | |---------|------------------------| | Vela monorepo checkout | Auto-build hosts/* when missing | | Standalone install | --shell <path>, or VELA_SHELL, or --browser / --no-shell |

Optional: VELA_ROOT points at a monorepo checkout so auto-build still works outside the tree.

Monorepo development

# from repo root
bun run vela -- dev --dir example/clock
bun packages/cli/src/main.ts --help