Loading...
System management commands help you initialize, monitor, and manage your Apito CLI installation.
init - Initialize Apito CLI SystemInitializes and validates the Apito CLI system configuration.
Usage:
apito init
Features:
~/.apito directory if it doesn't existapito start --db commandsWhat it checks:
Examples:
# First-time setup
apito init
# Re-run to validate configuration
apito init
Default Configuration:
The init command creates a .env file with these default values:
ENVIRONMENT=local
COOKIE_DOMAIN=localhost
CORS_ORIGIN=http://localhost:4000
PLUGIN_PATH=plugins
PUBLIC_KEY_PATH=keys/public.key
PRIVATE_KEY_PATH=keys/private.key
APITO_SYSTEM_DB_ENGINE=embed
BRANKA_KEY=<auto-generated-32-character-key>
BRANKA_KEY Behavior:
status - Show Service and Database StatusShows whether services are running and displays database status when available.
Usage:
apito status [engine|console]
Features:
db-compose.yml existsExamples:
# Show all services and database status
apito status
# Show specific service status
apito status engine
apito status console
Output Example:
[INFO] Database Status:
[SUCCESS] apito-system-postgres: Running
[SUCCESS] apito-project-postgres: Running
[WARNING] engine (docker) is not running
[WARNING] console (docker) is not running
logs - View Service and Database LogsView logs for Apito services (engine/console) and databases with real-time following and tail control.
Usage:
apito logs [engine|console] [--db system|project] [--follow] [--tail N]
Options:
--db system|project - Show logs for specific database type--follow, -f - Follow log output in real-time--tail N, -n N - Show last N lines (default: 100)Features:
--follow flag--tail flagExamples:
# Database logs
apito logs --db system --tail 10
apito logs --db project --follow
apito logs --db system -f -n 5
# Service logs
apito logs engine --tail 50
apito logs console --follow
apito logs engine -f -n 100
# Default behavior (engine logs, last 100 lines)
apito logs
Output Examples:
# Database logs
[INFO] Showing logs for system database (apito-system-postgres):
2025-08-14 05:48:09.188 UTC [1] LOG: database system is ready to accept connections
# Service logs (when services are running)
[INFO] Showing logs for engine service:
# Log output from the engine container