[data-reveal]{opacity:1!important;transform:none!important}
DocumentationCLI reference

CLI reference

Find the command that creates, runs, tests or builds an AntelopeJS project.

Run ajs <command> --help for the options of your installed version. Without a global install, npx @antelopejs/core <command> runs the same command. The CLI manages standalone projects. An embedded host manages its modules in code.

TaskCommandDetails
Create a projectnpx @antelopejs/core project init my-appProject commands
Run and reload local modulesajs project dev --watchDevelopment mode
Find missing providersajs project modules installProject module commands
Test a moduleajs module testModule commands
Build and run an artifactajs project build, then ajs project startProject commands
Script the CLI--quiet, and --json where supportedOutput and exit codes

Command reference

Introduction

Installation, command structure, global options, output, exit codes and plugins.

Project commands

Create, run, build and start projects, and manage their logging settings.

Project module commands

Add, list, update and remove the modules of a project, and pin their dependencies with module locks.

Module commands

Create modules from templates and run their test suites.

Configuration

Show and change global CLI settings, such as the interface repository URL.

Cheat sheet

Tables of every CLI command, option and common workflow.

Plugin API

Build a CLI plugin whose output, errors and exit codes match ajs, with @antelopejs/core/cli.