CLI
Introduction
The Antelopejs CLI tool helps you create, manage, and run your projects with simple commands.
Installation
The CLI is your main tool for working with Antelopejs. You can install it globally using your favorite package manager:
npm install -g antelopejs
yarn global add antelopejs
pnpm add -g antelopejs
This gives you the ajs command you can use anywhere on your system.
Don't want to install it globally? No problem. Just use npx:
npx antelopejs <command>Usage
Commands follow this simple pattern:
ajs <command> <subcommand> [options]
Available Commands
Core Commands
| Command | Description |
|---|---|
project | Create and manage projects |
module | Work with modules |
config | Change CLI settings |
help | Get help for commands |
Getting Help
Stuck on a command? Just add --help to see how to use it:
ajs project --help
ajs module init --help
Command Shortcuts
Save some typing with these handy shortcuts:
| Full Command | Shortcut |
|---|---|
ajs project init | ajs p i |
ajs module init | ajs m i |
ajs project run | ajs p r |
Configuration
The CLI remembers your settings in a config file. You can check or change these settings:
ajs config show
ajs config set <key> <value>
Interface Repository
The CLI pulls from a Git repo called interfaces to get:
- Ready-to-use interfaces that follow best practices
- Project templates to get you started quickly
- Interface code you can add to your project
This repo is maintained by the community to ensure quality. If you need something custom, you can fork it and point the CLI to your version instead.