Introduction

Overview

The AntelopeJS CLI (ajs) provides a single command-line interface for every stage of the development lifecycle. You use it to create projects, manage modules, run development servers, produce build artifacts, and configure global settings.

Installation

Install the CLI globally with your preferred package manager:

npm install -g @antelopejs/core

yarn global add @antelopejs/core

pnpm add -g @antelopejs/core

After installation, the ajs command is available in your terminal. Verify it works by checking the version:

ajs --version

Command Structure

Every CLI invocation follows the same pattern:

ajs <command> <subcommand> [arguments] [options]

The CLI organizes its functionality into three top-level commands:

Each top-level command contains subcommands that perform specific tasks. For example, ajs project dev starts the development server, while ajs project modules add installs new modules.

Global Options

These options apply to any command:

By default --verbose enables TRACE-level logging for all channels. To scope it to specific channels, pass a comma-separated list, for example --verbose=cli.command,resolution.

Getting Help

Every command and subcommand supports the --help flag. Use this flag to see available subcommands, arguments, and options:

# Top-level help
ajs --help

# Help for project commands
ajs project --help

# Help for a specific subcommand
ajs project dev --help

Configuration Storage

The CLI stores global settings in a JSON file at a platform-specific location:

This file holds values such as the default interface repository URL. You manage it through the ajs config commands rather than editing it by hand. See the Configuration page for details.