AxilJS CLI Overview
The axil CLI in AxilJS 0.3.6: every command, the rail-style output, help screens, colour handling and how create, run, capacity and deploy fit together.
On this page8
@axiljs/cli provides the axil command (also installed as axiljs). It creates projects from templates, runs the dev server with hot reload and Studio, generates code, runs migrations and tests, plans capacity, writes deployment files and inspects the semantic decorator catalog. The current release is 0.3.6.
Commands
axil --help groups the commands by workflow:
| Group | Command | What it does |
|---|---|---|
| Project | axil create [name] | Create a new project: template picker or custom stack |
| Project | axil generate <kind> <name> (alias g) | Generate a module, controller, service, entity or migration |
| Project | axil install [packages…] (alias i) | Add packages to package.json and run npm install |
| Develop | axil run | Development server with hot reload + Studio |
| Develop | axil test [pattern] | Compile and run *.test.ts / *.spec.ts with @axiljs/testing |
| Develop | axil doctor | Diagnose the project |
| Database | axil migrate [up|down|status] | Run @axiljs/orm migrations |
| Ship | axil build | Type-check and compile TypeScript for production |
| Ship | axil capacity (alias cap) | Check whether this machine / deployment can carry the scaling target |
| Ship | axil deploy | Generate a Dockerfile, Kubernetes manifests and .dockerignore |
| Inspect | axil decorator <sub> (alias dec) | List, search, inspect and check semantic decorators |
| Inspect | axil verify [pattern] | Check which decorators the runtime enforces, flag unwired classes and run the tests with intent checks in enforce mode (new in 0.3.5) |
Global options: -h, --help and -v, --version. A mistyped command or flag gets a suggestion, for example Unknown command 'crate' — did you mean 'create'?.
Details: Project Commands, Capacity, Decorator Commands, Verify.
Help
Every command accepts --help / -h. Command help lists each flag with its accepted values, and axil create --help also lists all templates by category.
The output style
All CLI output shares one look in the AxilJS brand colours: the orange-to-red gradient of the logo (#FD8702 to #ED1010). Help screens open with a gradient ▲ AXIL banner and a version badge. Command flows are drawn on a rail:
┌ axil deploy Generate Docker + Kubernetes files
│
◇ Using axil.scaling.json instances 3–10, 4 CPU / 8 GB pods
◇ Deployment files generated deploy/
│
└ Next steps
npm run build
docker build -f deploy/Dockerfile -t my-api .
docker run -p 3009:3009 my-api| Symbol | Meaning |
|---|---|
┌ | A command starts (its name and a one-line summary) |
◇ | A step succeeded |
● | Information |
▲ | Warning |
■ | Error |
◆ | A section heading or the final result |
└ | The flow ends: next steps, a failure, or the closing line |
Results such as the create summary, the axil capacity Plan and the axil doctor Diagnostics are shown as cards on the rail. Long-running steps (npm install, compilation, load tests) show a spinner on interactive terminals and a single line in CI logs.
Terminal compatibility
- Colours follow
NO_COLOR,FORCE_COLOR,TERM=dumband whether stdout is a TTY. Without truecolor support, the brand colour falls back to yellow. - On legacy Windows consoles the Unicode symbols fall back to ASCII (
+,|,*,o,!,x). Windows Terminal, VS Code, JetBrains terminals and most Unix terminals get the Unicode set. - Links are clickable in terminals that support OSC 8 (Windows Terminal, VS Code, iTerm2, WezTerm, ghostty).
axil decorator graphprints pure JSON andaxil --versionprints only@axiljs/cli vX.Y.Z, so both are safe to pipe.
Interactive vs non-interactive
On a terminal, axil create asks for anything you did not pass (name, template, database, features, confirmation). Without a TTY (CI, pipes) or with --yes, every prompt takes its default and a project name is required. Ctrl+C (or esc outside a search) cancels a prompt and exits with code 130.
A typical workflow
Run the CLI from a project
Generated projects list @axiljs/cli as a devDependency, so inside a project npx axil <command> uses the project's copy and the npm scripts (npm run dev, npm test, npm run migrate) work without a global install.
Next steps
Was this page helpful?