CLI
CLI Cheat Sheet
Quick reference for the most common Antelopejs CLI commands you'll use in your daily workflow.
Installation
npm install -g @antelopejs/core # Install globally with npm
yarn global add @antelopejs/core # Or with yarn
pnpm add -g @antelopejs/core # Or with pnpm
Project Commands
| Command | Description |
|---|---|
ajs project init my-app | Create a new project |
ajs project run | Run your project |
ajs project run --watch | Run with auto-reload when files change |
ajs project modules add @ajs/api | Add a module to your project |
ajs project modules remove @ajs/api | Remove a module from your project |
ajs project modules update | Update all modules |
ajs project modules fix | Fix missing dependencies |
ajs project modules list | List all installed modules |
ajs project logging show | Show logging configuration |
ajs project logging set | Configure logging settings |
Module Commands
| Command | Description |
|---|---|
ajs module init my-module | Create a new module |
ajs module test my-module | Run module tests |
ajs module imports list | List all imported interfaces |
ajs module imports add database@1 | Add interface to module |
ajs module imports add database@1 --optional | Add optional interface to module |
ajs module imports add database@1 --skip-install | Add interface without installing files |
ajs module imports remove database@1 | Remove interface from module |
ajs module imports update | Update all imported interfaces |
ajs module imports update --skip-install | Update interfaces without installing files |
ajs module imports install | Install all imported interfaces |
ajs module exports set src/interfaces | Set interfaces export path |
ajs module exports generate | Generate module exports |
Configuration
| Command | Description |
|---|---|
ajs config show | Show all current settings |
ajs config get git | Get a specific setting |
ajs config set git <url> | Change a setting |
ajs config set packageManager pnpm | Set package manager |
ajs config reset | Reset to default settings |
General Options
Many commands support these common options:
| Option | Description |
|---|---|
--help | Show help for a command |
--project or -p | Specify project directory |
--env or -e | Specify environment |
-v, --version | Show version number |
Quick Examples
Create and run a new project
ajs project init my-app
cd my-app
ajs project run --watch
Add modules to your project
ajs project modules add @ajs/api @ajs/auth-jwt
Create a new module
ajs module init my-module
ajs module imports add database@1
You can run any command with
--help to see all available options and examples.