Development
The Arkos.js CLI covers the full lifecycle of running your application — from hot-reload development to optimized production deployments.
arkos dev
Starts a development server with hot-reload. The server restarts automatically whenever source files, configuration files, or .env files change.
arkos dev [options]| Option | Description |
|---|---|
-p, --port <number> | Custom port number |
-h, --host <host> | Host to bind to |
# Start on the default port
arkos dev
# Start on a custom port and host
arkos dev --port 4000 --host 0.0.0.0The server prints startup info and logs each restart with a timestamp:
Arkos.js 1.6.0
- Local: http://localhost:8000
- Environments: .env, .env.local
12:34:56 Restarting: src/modules/post/post.controller.ts changedTypeScript projects are run with tsx-strict for type-checked execution. JavaScript projects use the same runner without the type-check step.
arkos build
Compiles your application into an optimized production build.
arkos buildTypeScript projects are compiled to JavaScript using a temporary tsconfig. JavaScript projects are copied and processed directly. The output is written to .build/.
Arkos.js 1.6.0
- Environments: .env
Creating an optimized production build...
Build complete!
Next step:
Run it using npm run startarkos start
Runs the production build generated by arkos build. Always build first — arkos start looks for the compiled output at .build/src/app.js.
arkos start [options]| Option | Description |
|---|---|
-p, --port <number> | Custom port number |
-h, --host <host> | Host to bind to |
arkos start
arkos start --port 3000 --host 0.0.0.0Recommended package.json Scripts
When you create a project with create-arkos, these scripts are added automatically. If you set up manually, add them yourself:
{
"scripts": {
"dev": "arkos dev",
"build": "arkos build",
"start": "arkos start",
"arkos": "arkos"
}
}CI/CD
npm install
arkos build
arkos start --port $PORT