Skip to content

ANTE CLI

The ANTE CLI (ante-erp-cli) is a comprehensive command-line tool for managing ANTE ERP self-hosted installations. It provides a simplified, user-friendly interface for installation, configuration, maintenance, and troubleshooting of your ANTE ERP system.

Why Use the CLI?

The ANTE CLI is the recommended way to install and manage ANTE ERP because it:

  • Simplifies Installation: Install ANTE in under 5 minutes with a single command
  • Automated Setup: Handles Docker configuration, database initialization, and credential generation
  • Easy Management: Intuitive commands for starting, stopping, and monitoring services
  • Built-in Diagnostics: Run health checks and troubleshoot issues with ante doctor
  • Safe Updates: Automatic backup creation before updates
  • Cross-Platform: Works on Linux, macOS, and Windows (WSL2)

Quick Start

bash
# Install the CLI globally
npm install -g ante-erp-cli

# Install ANTE ERP
ante install

# Check status
ante status

# View logs
ante logs --follow

That's it! Your ANTE ERP instance is now running at http://localhost:8080.

Features

Installation & Setup

  • Interactive installation wizard
  • Multiple installation presets (minimal, standard, enterprise)
  • Multiple frontend app selection (Gate, Guardian, Facial Recognition, POS)
  • Automatic SSL/HTTPS setup with Let's Encrypt
  • Custom domain configuration with integrated SSL

Service Management

  • Start, stop, and restart services
  • Real-time service status monitoring
  • Container health checks
  • Log viewing with filtering

Backup & Restore

  • One-command backup creation
  • Backup keywords for easy identification
  • Automatic cleanup of old backups
  • Automatic backup scheduling
  • Point-in-time restoration
  • Compressed backup storage

Database Operations

  • Database migrations and seeding
  • Clone remote databases (PostgreSQL and MongoDB)
  • Database optimization and performance tuning
  • PostgreSQL shell access
  • Database port exposure/security management
  • Database information and statistics

Maintenance

  • Update to latest version with automatic backup
  • Complete system reset with mandatory backup
  • System health diagnostics
  • Configuration management
  • Docker Compose regeneration
  • Cleanup and optimization

Documentation Structure

This CLI documentation is organized into the following sections:

System Requirements

  • Node.js: 24.0.0 or higher (LTS)
  • Docker: 20.10+ with Docker Compose v2
  • Operating System: Linux, macOS, or Windows (WSL2)
  • RAM: 4GB minimum, 8GB recommended
  • Disk Space: 20GB minimum, 50GB recommended

Next Steps

  1. Install the CLI - Get started with installing the ANTE CLI
  2. Command Reference - Learn about all available commands
  3. Self-Hosting Guide - Detailed self-hosting documentation

Support


Ready to get started? Head over to the Installation Guide to install the ANTE CLI.

Released under the MIT License.