Installation
Install AxilJS 0.3.6: requirements (Node.js 20+), run the CLI with npx or install it globally, verify the version and create your first project.
On this page6
AxilJS is a set of @axiljs/* npm packages plus the axil command-line tool from @axiljs/cli. The current release is 0.3.6; all packages move in lockstep on the same version line.
Requirements
| Requirement | Version |
|---|---|
| Node.js | 20 or newer (AxilJS is developed on Node.js 24) |
| npm | the version bundled with your Node.js |
| TypeScript | installed per project: every project generated by axil create has its own typescript devDependency |
Note
You do not need a global TypeScript install. Every project generated by axil create ships typescript, @types/node, @axiljs/cli, @axiljs/testing and @axiljs/studio as devDependencies.
Option 1: run the CLI with npx
No install needed. npx downloads the CLI and starts the interactive create flow:
On a terminal the project name is optional: the CLI asks for it as step 1. You can also pass it directly:
Tip
If npx runs an older CLI than you expect, ask for the latest release explicitly: npx @axiljs/cli@latest create. See Troubleshooting.
Option 2: install the CLI globally
This puts two equivalent binaries on your PATH: axil and axiljs.
Verify the installation:
@axiljs/cli v0.3.6Show every command:
Update the CLI
Inside a generated project @axiljs/cli is also a devDependency, so npm run dev (which runs axil run) and npm test (which runs axil test) use the project's own copy even without a global install.
Add packages to an existing project
Each package can be installed on its own:
or through the CLI, which adds the packages to package.json and then runs npm install:
The database drivers are optional peer dependencies of @axiljs/orm; install only the one you use: pg, mysql2 or better-sqlite3.
Next steps
- Quick Start: create and run your first project
- Templates: the 10 ready-made starter apps
- CLI Overview: every
axilcommand
Was this page helpful?