Overview
ajs dms has seven commands. ajs dms --help lists them:
$ ajs dms --help
ajs dms 0.6.1 - DMS frontend for AntelopeJS (Vue 3, Vite, Inertia)
Usage: ajs dms [options] [command]
Options:
-v, --version Print the version
--no-color Disable colors (also NO_COLOR=1)
--verbose [=channels] Show full output and stack traces (also
ANTELOPEJS_VERBOSE); any channels turn all of it on
-q, --quiet Print only results, warnings and errors (also
ANTELOPEJS_QUIET=1)
--no-update-check Skip the daily update check (also NO_UPDATE_NOTIFIER=1)
-h, --help Show help for a command
Commands:
dev Run the dev server against a local backend, with hot
reload
build Build the production frontend
start Serve the production build
prepare Generate the workspace and module types
(postinstall-safe)
workspaces List generated workspaces
clean Remove generated workspaces
verify-source Build and type-check unpublished frontend sources
help [command] Show help for a command
Examples:
# Inside a project started with ajs project dev
$ ajs dms dev
# Build for production, then serve the build
$ ajs dms build -b https://dms.example.com
# Serve it on another port
$ ajs dms start -b https://dms.example.com -p 3001
Run ajs dms <command> --help for its options and examples, and
ajs dms help environment for the variables read from the environment.
| Command | What it does | Backend URL |
|---|---|---|
dev | Serves the dashboard with hot reload, reading the modules from the backend's own directories | Discovered from .antelope/dev.json, or -b |
build | Builds the production frontend into the workspace's dist directory | Required |
start | Serves the build build made for the same backend | Required |
prepare | Generates the workspace, the module registry and the types, without failing an install | Optional |
workspaces | Lists the generated workspaces, their size and last use | None |
clean | Removes generated workspaces | -b or --all, never the environment |
verify-source | Builds and type-checks unpublished frontend modules | None |
--help, --version, workspaces and clean run from any directory; verify-source runs in a project that installs @antelopejs/dms.
Options every command accepts
The global options can come before or after the command name: ajs dms build -q and ajs dms -q build are the same run. ajs --no-color dms …, ajs --verbose dms … and ajs -q dms … set the matching variables for the plugin too.
| Option | Variable | Effect |
|---|---|---|
--no-color | NO_COLOR=1 | Turns colors off. Terminals that cannot draw Unicode, such as TERM=dumb, also get ASCII symbols. |
--verbose, --verbose=<channels> | ANTELOPEJS_VERBOSE | Streams the full pnpm and Vite output, each line behind the name of its step, and adds the stack trace of the underlying error to a failure. Any channel list turns all of it on. |
-q, --quiet | ANTELOPEJS_QUIET=1 | Prints only results, warnings and errors: no command header, progress, summary or update notice. A ready dev or start server prints only its Local URL. |
--no-update-check | NO_UPDATE_NOTIFIER=1 | Skips the daily update check. |
Output and exit codes
The CLI follows the output contract of ajs. Only the help, the version and the list workspaces prints go to stdout; progress, warnings and errors go to stderr. The dependency install and each step of a production build run as one progress line each: their output is kept, and its last lines are shown when the step fails, with paths into the generated workspace rewritten to point at the frontend module's own sources.
| Exit code | Meaning |
|---|---|
0 | Success |
1 | Failure |
2 | Usage error: an unknown command or option, a missing or invalid argument, a missing configuration value |
130 | Stopped with Ctrl+C |
A usage error names the fix:
$ ajs dms build
✖ Backend URL is required
→ Pass -b <url> or set DMS_API_BASE_URL
Update check
Once a day at most, the CLI asks npm for a newer release and prints a one-line notice on stderr, only to a terminal: as the last line of a command that succeeded, or under the ready block of dev and start. The help, --version, --json, failed commands, pipes and TERM=dumb never show it. The lookup never delays the command's exit, and a lookup that comes back empty is retried an hour later. Its stamp lives in ~/.antelopejs/dms-frontend/update-check.json.
--no-update-check, NO_UPDATE_NOTIFIER=1 or a CI variable turns the check off.
The environment topic
ajs dms help environment lists every variable the CLI and the generated server read. The Configuration page holds the same list, generated from the same source.