Command Reference

Quick reference for common commands used in managing ANTE ERP.

CLI Commands (Recommended)

If you installed ANTE ERP using the CLI (ante-erp-cli), use these commands for all management tasks. The CLI provides simplified, user-friendly commands that handle complex Docker operations automatically.

Installation & Setup

bash

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

# Check CLI version
ante --version

# Get help
ante --help

# View command-specific help
ante install --help
ante backup --help

Service Management

bash

# Check status of all services
ante status

# Start all services
ante start

# Stop all services
ante stop

# Restart all services
ante restart

# Run system health diagnostics
ante doctor

Viewing Logs

bash

# View all logs (last 100 lines)
ante logs

# Follow logs in real-time
ante logs --follow

# View logs for specific service
ante logs --service backend
ante logs --service frontend
ante logs --service postgres
ante logs --service redis
ante logs --service mongodb

# View specific number of lines
ante logs --lines 200

# Follow specific service logs
ante logs --service backend --follow

Common Log Commands:

bash

# Debug backend issues
ante logs --service backend --lines 500 --follow

# Monitor all services
ante logs --follow

# Export logs to file
ante logs > logs-$(date +%Y%m%d).txt

Backup & Restore

bash

# Create full backup (all databases and volumes)
ante backup

# List available backups
ante backup:list

# Restore from backup
ante restore

# Restore specific backup file
ante restore /path/to/backup.tar.gz

# Restore with confirmation prompt
ante restore --interactive

Backup Details:

Backups include PostgreSQL, MongoDB, Redis data
Backups include uploaded files and configuration
Stored in ./backups/ directory by default
Named with timestamp: ante-backup-YYYYMMDD-HHMMSS.tar.gz

Database Operations

bash

# Run database migrations
ante db:migrate

# Seed database with initial data
ante db:seed

# Open PostgreSQL database shell
ante db:shell

# View database information
ante db:info

# Optimize database performance
ante db:optimize

# Reset database (⚠️ DESTRUCTIVE - deletes all data)
ante db:reset

# Backup database only
ante db:backup

Database Shell Examples:

bash

# After running: ante db:shell

# List all tables
\dt

# Describe table structure
\d table_name

# Run SQL query
SELECT * FROM users LIMIT 10;

# Exit shell
\q

Updates & Maintenance

bash

# Update to latest version
ante update

# Check for available updates
ante update --check

# Update and restart services
ante update --restart

# View current and available versions
ante version

Update Process:

Creates automatic backup before update
Pulls latest Docker images
Runs database migrations if needed
Restarts services with new version
Verifies health after update

Health & Diagnostics

bash

# Run comprehensive health check
ante doctor

# Check specific component
ante doctor --component backend
ante doctor --component database
ante doctor --component redis

# Verbose diagnostics output
ante doctor --verbose

Health Check Includes:

✅ Docker service status
✅ Container health checks
✅ Database connectivity
✅ Redis/Cache status
✅ MongoDB connection
✅ Disk space usage
✅ Memory usage
✅ Port availability

Configuration

bash

# View current configuration
ante config:show

# Edit configuration
ante config:edit

# Validate configuration
ante config:validate

# Reset to default configuration
ante config:reset

Uninstallation

bash

# Uninstall ANTE ERP (removes containers, keeps data)
ante uninstall

# Uninstall and remove all data (⚠️ DESTRUCTIVE)
ante uninstall --purge

# Uninstall with backup first
ante backup && ante uninstall

Alternative: Direct Docker Commands

If you installed manually without the CLI, or need direct Docker access, use these commands:

Docker Compose Commands

Basic Operations

bash

# Start all services
docker compose up -d

# Stop all services
docker compose down

# Restart services
docker compose restart

# View status
docker compose ps

# View logs
docker compose logs

# Follow logs (live)
docker compose logs -f

# Stop without removing containers
docker compose stop

# Start stopped containers
docker compose start

Specific Services

bash

# Start specific service
docker compose up -d backend

# Stop specific service
docker compose stop backend

# Restart specific service
docker compose restart backend

# View specific service logs
docker compose logs backend

# Follow specific service logs
docker compose logs -f backend

Image Management

bash

# Pull latest images
docker compose pull

# Build images (if using local Dockerfiles)
docker compose build

# Pull and recreate containers
docker compose pull && docker compose up -d

# Force recreate containers
docker compose up -d --force-recreate

Advanced Operations

bash

# Scale a service (multiple instances)
docker compose up -d --scale backend=3

# Remove all containers and volumes (⚠️ DELETES DATA)
docker compose down -v

# Remove containers but keep volumes
docker compose down

# View configuration (resolved)
docker compose config

# Validate docker-compose.yml
docker compose config -q

Docker Commands

Container Management

bash

# List running containers
docker ps

# List all containers (including stopped)
docker ps -a

# Stop a container
docker stop ante-backend

# Start a container
docker start ante-backend

# Restart a container
docker restart ante-backend

# Remove a container
docker rm ante-backend

# Force remove running container
docker rm -f ante-backend

Logs and Monitoring

bash

# View container logs
docker logs ante-backend

# Follow logs
docker logs -f ante-backend

# Last N lines
docker logs --tail=100 ante-backend

# Logs since timestamp
docker logs --since="2025-10-27T10:00:00" ante-backend

# Show timestamps
docker logs -t ante-backend

# Real-time stats
docker stats

# Stats for specific container
docker stats ante-backend

# One-time stats snapshot
docker stats --no-stream

Container Inspection

bash

# Inspect container
docker inspect ante-backend

# Get specific value (IP address)
docker inspect -f '{{range.NetworkSettings.Networks}}{{.IPAddress}}{{end}}' ante-backend

# View port mappings
docker port ante-backend

# View environment variables
docker inspect -f '{{range $index, $value := .Config.Env}}{{println $value}}{{end}}' ante-backend

Executing Commands

bash

# Execute command in running container
docker exec ante-backend ls -la

# Interactive shell
docker exec -it ante-backend /bin/sh
docker exec -it ante-backend /bin/bash

# Execute as specific user
docker exec -u root ante-backend whoami

# Execute in background
docker exec -d ante-backend npm run task

File Operations

bash

# Copy file TO container
docker cp local-file.txt ante-backend:/app/

# Copy file FROM container
docker cp ante-backend:/app/logs/app.log ./logs/

# Copy directory
docker cp ante-backend:/app/uploads ./backup/uploads

Image Management

bash

# List images
docker images

# Pull image
docker pull ghcr.io/gtplusnet/ante-self-hosted-backend:latest

# Remove image
docker rmi ghcr.io/gtplusnet/ante-self-hosted-backend:latest

# Remove unused images
docker image prune

# Remove all unused images
docker image prune -a

# View image history
docker history ghcr.io/gtplusnet/ante-self-hosted-backend:latest

# Tag image
docker tag ante-backend:latest ante-backend:backup

Volume Management

bash

# List volumes
docker volume ls

# Inspect volume
docker volume inspect ante-erp_postgres_data

# Remove volume (⚠️ DELETES DATA)
docker volume rm ante-erp_postgres_data

# Remove unused volumes
docker volume prune

# Create volume
docker volume create my-volume

Network Management

bash

# List networks
docker network ls

# Inspect network
docker network inspect ante-erp_ante-network

# Create network
docker network create my-network

# Connect container to network
docker network connect my-network ante-backend

# Disconnect container from network
docker network disconnect my-network ante-backend

System Management

bash

# Show disk usage
docker system df

# Detailed disk usage
docker system df -v

# Clean up everything unused
docker system prune

# Clean up with volumes (⚠️ DELETES DATA)
docker system prune -a --volumes

# Show Docker info
docker info

# Show Docker version
docker version

Database Commands

PostgreSQL

bash

# Access PostgreSQL shell
docker compose exec postgres psql -U ante -d ante_db

# Execute SQL command
docker compose exec postgres psql -U ante -d ante_db -c "SELECT version();"

# List databases
docker compose exec postgres psql -U ante -c "\l"

# Backup database
docker compose exec -T postgres pg_dump -U ante ante_db > backup.sql

# Backup compressed
docker compose exec -T postgres pg_dump -U ante ante_db | gzip > backup.sql.gz

# Restore database
docker compose exec -T postgres psql -U ante -d ante_db < backup.sql

# Restore compressed
gunzip -c backup.sql.gz | docker compose exec -T postgres psql -U ante -d ante_db

Common PostgreSQL Queries:

sql

-- List all tables
\dt

-- Describe table
\d users

-- Show table size
SELECT pg_size_pretty(pg_total_relation_size('users'));

-- Active connections
SELECT count(*) FROM pg_stat_activity;

-- Database size
SELECT pg_size_pretty(pg_database_size('ante_db'));

-- Kill connection
SELECT pg_terminate_backend(pid) FROM pg_stat_activity WHERE pid = 12345;

Redis

bash

# Access Redis CLI
docker compose exec redis redis-cli -a "$REDIS_PASSWORD"

# Execute command
docker compose exec redis redis-cli -a "$REDIS_PASSWORD" PING

# Get all keys
docker compose exec redis redis-cli -a "$REDIS_PASSWORD" KEYS "*"

# Get value
docker compose exec redis redis-cli -a "$REDIS_PASSWORD" GET key_name

# Delete key
docker compose exec redis redis-cli -a "$REDIS_PASSWORD" DEL key_name

# Flush all data (⚠️ CLEARS CACHE)
docker compose exec redis redis-cli -a "$REDIS_PASSWORD" FLUSHALL

# Info
docker compose exec redis redis-cli -a "$REDIS_PASSWORD" INFO

# Memory stats
docker compose exec redis redis-cli -a "$REDIS_PASSWORD" INFO memory

Common Redis Commands:

bash

# Monitor real-time commands
MONITOR

# Save snapshot
SAVE

# Background save
BGSAVE

# Check key exists
EXISTS key_name

# Get TTL (time to live)
TTL key_name

# Set expiration
EXPIRE key_name 3600

# Get database size
DBSIZE

MongoDB

bash

# Access MongoDB shell
docker compose exec mongodb mongosh --username ante --password "$MONGO_PASSWORD" --authenticationDatabase admin

# Execute command
docker compose exec mongodb mongosh --username ante --password "$MONGO_PASSWORD" --authenticationDatabase admin --eval "db.version()"

# Backup database
docker compose exec -T mongodb mongodump --username=ante --password="$MONGO_PASSWORD" --authenticationDatabase=admin --db=ante --archive | gzip > backup.archive.gz

# Restore database
gunzip -c backup.archive.gz | docker compose exec -T mongodb mongorestore --username=ante --password="$MONGO_PASSWORD" --authenticationDatabase=admin --archive

Common MongoDB Commands:

javascript

// Show databases
show dbs

// Use database
use ante

// Show collections
show collections

// Count documents
db.collection.countDocuments()

// Find documents
db.collection.find().limit(10)

// Database stats
db.stats()

// Collection stats
db.collection.stats()

// Drop collection
db.collection.drop()

Application Management Commands

Backend Operations

bash

# Run database migrations
docker compose exec backend npx prisma migrate deploy

# Generate Prisma client
docker compose exec backend npx prisma generate

# View migration status
docker compose exec backend npx prisma migrate status

# Open Prisma Studio (database GUI)
docker compose exec backend npx prisma studio

# Run custom script
docker compose exec backend node scripts/my-script.js

# Install new package (if needed)
docker compose exec backend npm install package-name

# View environment variables
docker compose exec backend printenv

Health Checks

bash

# Check backend health
curl http://localhost:3001/health

# Check frontend
curl -I http://localhost:8080

# Check all services
docker compose ps

# Test database connection
docker compose exec backend npx prisma db execute --stdin <<< "SELECT 1"

Maintenance Commands

Backups

bash

# Full backup
~/ante-erp/scripts/backup-all.sh

# Database only
docker compose exec -T postgres pg_dump -U ante ante_db | gzip > backup_$(date +%Y%m%d).sql.gz

# Restore backup
~/ante-erp/scripts/restore-backup.sh backup-file.tar.gz

Updates

bash

# Update to latest version
~/ante-erp/scripts/update.sh

# Manual update
docker compose pull
docker compose up -d --force-recreate

# Update specific service
docker compose pull backend
docker compose up -d backend

Cleanup

bash

# Clean Docker system
docker system prune -a

# Clean logs
find ~/ante-erp/logs -name "*.log" -mtime +30 -delete

# Clean old backups
find ~/ante-erp/backups -name "*.tar.gz" -mtime +90 -delete

# Vacuum database
docker compose exec postgres psql -U ante -d ante_db -c "VACUUM ANALYZE;"

Monitoring Commands

Resource Usage

bash

# Real-time container stats
docker stats

# System resources
htop  # or top

# Disk usage
df -h
docker system df

# Memory usage
free -h

# Process list
docker compose exec backend ps aux

Log Analysis

bash

# Count errors in logs
docker compose logs backend | grep -i error | wc -l

# Show recent errors
docker compose logs backend | grep -i error | tail -20

# Export logs
docker compose logs > logs_$(date +%Y%m%d).txt

# Search logs for pattern
docker compose logs backend | grep "timeout"

# Logs with timestamps
docker compose logs -t backend

Troubleshooting Commands

Diagnostics

bash

# Health check
~/ante-erp/scripts/health-check.sh

# Check service connectivity
docker compose exec backend ping -c 3 postgres

# Test database connection
docker compose exec postgres pg_isready -U ante

# Test Redis
docker compose exec redis redis-cli -a "$REDIS_PASSWORD" ping

# Network troubleshooting
docker network inspect ante-erp_ante-network

# View container processes
docker compose top

Recovery

bash

# Restart everything
docker compose restart

# Restart in order (databases first)
docker compose restart postgres redis mongodb
sleep 10
docker compose restart backend frontend

# Force recreate
docker compose down
docker compose up -d

# Reset single service
docker compose rm -f backend
docker compose up -d backend

Shortcuts and Aliases

Add these to your ~/.bashrc or ~/.bash_aliases:

bash

# Navigate to ANTE directory
alias cda='cd ~/ante-erp'

# View ANTE logs
alias antelogs='docker compose -f ~/ante-erp/docker-compose.yml logs -f'

# ANTE status
alias antestatus='docker compose -f ~/ante-erp/docker-compose.yml ps'

# ANTE restart
alias anterestart='docker compose -f ~/ante-erp/docker-compose.yml restart'

# ANTE backup
alias antebackup='~/ante-erp/scripts/backup-all.sh'

# ANTE update
alias anteupdate='~/ante-erp/scripts/update.sh'

# Quick access to PostgreSQL
alias antepsql='docker compose -f ~/ante-erp/docker-compose.yml exec postgres psql -U ante -d ante_db'

# Quick access to backend shell
alias anteshell='docker compose -f ~/ante-erp/docker-compose.yml exec backend /bin/sh'

Reload your shell:

bash

source ~/.bashrc

Keyboard Shortcuts

When viewing logs:

Ctrl + C - Stop following logs
Ctrl + Z - Suspend process
Ctrl + D - Exit shell/EOF

When in interactive shell:

Ctrl + P, Ctrl + Q - Detach from container (keep running)
Ctrl + D - Exit shell
Ctrl + L - Clear screen

Quick Reference Card

Print this for quick access:

ANTE ERP Command Quick Reference
================================

Start:       docker compose up -d
Stop:        docker compose down
Restart:     docker compose restart
Status:      docker compose ps
Logs:        docker compose logs -f

Backend:     docker compose logs -f backend
Frontend:    docker compose logs -f frontend
Database:    docker compose exec postgres psql -U ante -d ante_db

Backup:      ~/ante-erp/scripts/backup-all.sh
Update:      ~/ante-erp/scripts/update.sh
Health:      curl http://localhost:3001/health

Emergency:   docker compose down && docker compose up -d

Next Steps

Last Updated: October 27, 2025

Command Reference ​

CLI Commands (Recommended) ​

Installation & Setup ​

Service Management ​

Viewing Logs ​

Backup & Restore ​

Database Operations ​

Updates & Maintenance ​

Health & Diagnostics ​

Configuration ​

Uninstallation ​

Alternative: Direct Docker Commands ​

Docker Compose Commands ​

Basic Operations ​

Specific Services ​

Image Management ​

Advanced Operations ​

Docker Commands ​

Container Management ​

Logs and Monitoring ​

Container Inspection ​

Executing Commands ​

File Operations ​

Image Management ​

Volume Management ​

Network Management ​

System Management ​

Database Commands ​

PostgreSQL ​

Redis ​

MongoDB ​

Application Management Commands ​

Backend Operations ​

Health Checks ​

Maintenance Commands ​

Backups ​

Updates ​

Cleanup ​

Monitoring Commands ​

Resource Usage ​

Log Analysis ​

Troubleshooting Commands ​

Diagnostics ​

Recovery ​

Shortcuts and Aliases ​

Keyboard Shortcuts ​

Quick Reference Card ​

Next Steps ​

Command Reference

CLI Commands (Recommended)

Installation & Setup

Service Management

Viewing Logs

Backup & Restore

Database Operations

Updates & Maintenance

Health & Diagnostics

Configuration

Uninstallation

Alternative: Direct Docker Commands

Docker Compose Commands

Basic Operations

Specific Services

Image Management

Advanced Operations

Docker Commands

Container Management

Logs and Monitoring

Container Inspection

Executing Commands

File Operations

Image Management

Volume Management

Network Management

System Management

Database Commands

PostgreSQL

Redis

MongoDB

Application Management Commands

Backend Operations

Health Checks

Maintenance Commands

Backups

Updates

Cleanup

Monitoring Commands

Resource Usage

Log Analysis

Troubleshooting Commands

Diagnostics

Recovery

Shortcuts and Aliases

Keyboard Shortcuts

Quick Reference Card

Next Steps