CLI

voxal is the developer CLI for building and deploying voxal apps. It scaffolds projects, runs them locally with live reload, bundles and validates them, and ships them to the platform.

Install

The CLI ships as the npm package voxalsh and requires Node.js 20 or newer.

npm install -g voxalsh

pnpm add -g voxalsh

yarn global add voxalsh

bun add -g voxalsh

It installs two binaries, voxal and voxalsh, that run the same program. This documentation uses voxal throughout. Run voxal with no arguments, or voxal --help, to print usage at any time.

A typical session

voxal init myapp          # scaffold an app and link a project
cd myapp && npm install
voxal dev                 # iterate locally with live reload
voxal deploy              # ship it
ssh myapp@voxal.sh        # anyone can connect

Commands

Create and run

Ship

Account and projects

Command conventions

A few rules hold across every command.

• Positional arguments come without a dash. voxal init myapp and voxal deploy ./dir pass the name and directory positionally.
• Flags accept either --key value or --key=value. A value flag with no value is a usage error.
• Most commands need no flags. The everyday flags are documented on each command's page: --name for deploy, --out for build, and --no-browser for login.

An unknown command exits with a non-zero status and points you at voxal --help.