CLI

Project Commands

Here's how to create and manage your Antelopejs projects using the CLI - from starting new projects to running them and managing modules.

Project Management

These commands help you work with your Antelopejs projects.

project init

Creates a new project.

ajs project init <project>

Shortcuts:

ajs p init
ajs p i

What it does:

Walks you through setting up a new project. It creates the antelope.json file and helps you set up your main module.

Arguments:

Argument	Description	Required
`<project>`	Name of your project	Yes

Example:

ajs project init my-app

project run

Runs your project.

ajs project run

Shortcuts:

ajs p run
ajs p r

What it does:

Starts your Antelopejs app by loading all the modules listed in your project.

Options:

Option	Description	Default	Shortcut	Environment variable
`--project`	Where your project is	.	-p	ANTELOPEJS_PROJECT
`--env`	Which environment to run	-	-e	ANTELOPEJS_LAUNCH_ENV
`--watch`	Auto-reload when files change	false	-w	-

Example:

ajs project run --watch --env development

Module Management

These commands help you add, remove, and update modules in your project.

project modules add

Adds modules to your project.

ajs project modules add <modules...>

Shortcuts:

ajs p modules add
ajs p m add

What it does:

Gets the modules you want and adds them to your project.

Arguments:

Argument	Description	Required
`<modules...>`	Modules to add (list them)	Yes

Options:

Option	Description	Default	Shortcut	Environment variable
`--project`	Where your project is	.	-p	ANTELOPEJS_PROJECT
`--env`	Which environment to use	-	-e	ANTELOPEJS_LAUNCH_ENV
`--mode`	How to get the module (npm/git/local/dir)	npm	-m	-

Example:

ajs project modules add @ajs/api @ajs/auth --mode npm

project modules remove

Takes modules out of your project.

ajs project modules remove <modules...>

Shortcuts:

ajs p modules remove
ajs p m remove

What it does:

Removes modules you no longer need from your project.

Arguments:

Argument	Description	Required
`<modules...>`	Modules to remove (list them)	Yes

Options:

Option	Description	Default	Shortcut	Environment variable
`--project`	Where your project is	.	-p	ANTELOPEJS_PROJECT
`--env`	Which environment to use	-	-e	ANTELOPEJS_LAUNCH_ENV

Example:

ajs project modules remove @ajs/auth

project modules update

Updates modules to newer versions.

ajs project modules update <modules...>

Shortcuts:

ajs p modules update
ajs p m update

What it does:

Gets the latest version of modules and updates them in your project.

Arguments:

Argument	Description	Required
`<modules...>`	Modules to update (list them)	Yes

Options:

Option	Description	Default	Shortcut	Environment variable
`--project`	Where your project is	.	-p	ANTELOPEJS_PROJECT
`--env`	Which environment to use	-	-e	ANTELOPEJS_LAUNCH_ENV

Example:

ajs project modules update @ajs/api

project modules fix

Helps fix missing dependencies.

ajs project modules fix

Logging Management

These commands help you manage logging for your project.

project logging show

Displays the current logging configuration of your Antelopejs project.

ajs project logging show

Aliases:

ajs p logging show
ajs p l show

Options:

Option	Description	Default	Alias	Environment variable
`--project`	Path to Antelopejs project	.	-p	ANTELOPEJS_PROJECT
`--env`	Launch environment	-	-e	ANTELOPEJS_LAUNCH_ENV

Example:

ajs project logging show

project logging set

Modifies the logging configuration of your Antelopejs project.

ajs project logging set

Aliases:

ajs p logging set
ajs p l set

Description:

This command allows you to modify various settings of the current logging configuration for your Antelopejs project.

Options:

Option	Description	Default	Alias	Environment variable
`--project`	Path to Antelopejs project	.	-p	ANTELOPEJS_PROJECT
`--env`	Launch environment	-	-e	ANTELOPEJS_LAUNCH_ENV
`--enable`	Enable logging	-	-	-
`--disable`	Disable logging	-	-	-
`--enableModuleTracking`	Enable module tracking	-	-	-
`--disableModuleTracking`	Disable module tracking	-	-	-
`--includeModule`	Include logging of a specific module	-	-	-
`--excludeModule`	Exclude logging of a specific module	-	-	-

Example:

ajs project logging set --enable --includeModule api

Configuration

Here's how to view and change your CLI settings.

Module Commands

Here's how to create and manage your modules with the CLI - from creating new ones to handling interfaces.