CLI Reference
Cheat Sheet
Quick reference for every AntelopeJS CLI command, option, and common workflow.
Installation
| Package Manager | Command |
|---|---|
| npm | npm install -g @antelopejs/core |
| yarn | yarn global add @antelopejs/core |
| pnpm | pnpm add -g @antelopejs/core |
Project Commands
| Command | Description |
|---|---|
ajs project init <project> | Create a new project with the interactive wizard |
ajs project dev [options] | Run the project in development mode |
ajs project run [options] | Alias for ajs project dev |
ajs project build [options] | Build production artifacts (build.json) |
ajs project start [options] | Start from pre-built artifacts |
ajs project modules add <modules...> | Add one or more modules |
ajs project modules remove <modules...> | Remove modules (alias: rm) |
ajs project modules list | List installed modules (alias: ls) |
ajs project modules update [modules...] | Update npm modules to latest versions |
ajs project modules install | Auto-install modules for unresolved interfaces |
ajs project logging show | Display logging configuration (alias: ls) |
ajs project logging set | Configure logging settings |
Module Commands
| Command | Description |
|---|---|
ajs module init <path> | Scaffold a new module from a template |
ajs module test [path] | Run the test suite for a module |
Config Commands
| Command | Description |
|---|---|
ajs config show | Display all CLI settings |
ajs config get <key> | Get a specific setting value |
ajs config set <key> <value> | Set a configuration value |
ajs config reset | Reset all settings to defaults |
General Options
| Option | Description |
|---|---|
--help | Show help for any command |
-v, --version | Display the CLI version |
--verbose | Enable verbose logging (repeatable for more detail) |
Common Dev Options
These options are shared across ajs project dev, ajs project run, ajs project build, and ajs project start:
| Option | Available In | Description |
|---|---|---|
-p, --project <path> | dev, build, start | Path to the project folder |
-e, --env <environment> | dev, build, start | Environment name |
-c, --concurrency <number> | dev, start | Number of parallel module loads |
-w, --watch | dev | Enable Hot Module Reloading (HMR) |
--inspect [host:port] | dev | Enable the Node.js debugger |
-i, --interactive | dev | Enable REPL mode |
Quick Workflows
New Project
Scaffold a project and start developing with HMR:
ajs project init my-project
cd my-project
ajs project dev --watch
Build and Deploy
Generate production artifacts and start the application:
ajs project build -e production
ajs project start -e production
Add Modules
Install modules from npm, local paths, or auto-detect from interface imports:
# Add from npm (default mode)
ajs project modules add @antelopejs/api
# Add a local module
ajs project modules add ./modules/auth --mode local
# Auto-install from interface imports
ajs project modules install
Create and Test a Module
Scaffold a module from a template and run its test suite:
ajs module init ./modules/my-module
ajs module test ./modules/my-module
Update Modules
Check for available updates and apply them:
# Preview updates
ajs project modules update --dry-run
# Apply updates
ajs project modules update
Configure Logging
Enable logging and inspect the current configuration:
# Enable debug-level logging
ajs project logging set --enable --level debug
# Check current logging config
ajs project logging show --json