CLI Reference

Complete reference for all Asantiya command-line interface commands and options.

Global Options

All Asantiya commands support these global options:


asantiya [GLOBAL_OPTIONS] <command> [COMMAND_OPTIONS]

Global Options

Option	Short	Description
`--version`	`-v`	Show version information and exit
`--verbose`	`-V`	Enable verbose output for debugging
`--config`	`-c`	Specify path to configuration file (default: deploy.yaml)

Main Commands

`asantiya init`

Initialize a new Asantiya configuration file for your project.

Purpose: Creates a deployment configuration file with sensible defaults and optional interactive setup.

Options:

--output, -o: Output file path (default: deploy.yaml)
--interactive/--no-interactive: Run in interactive mode (default: true)
--template, -t: Configuration template to use (basic, full, minimal)

Examples:


# Create basic configuration
asantiya init
 
# Create configuration with specific template
asantiya init --template full
 
# Create configuration in custom location
asantiya init --output my-deploy.yaml

`asantiya deploy`

Build and deploy your application using the configuration file.

Purpose: Complete deployment workflow including building Docker images, starting services, and managing containers.

Options:

--config, -c: Path to configuration file
--force, -f: Force deployment without confirmation
--skip-build: Skip building the Docker image
--skip-accessories: Skip starting accessory containers
--verbose, -V: Enable verbose output

Examples:


# Deploy with default configuration
asantiya deploy
 
# Deploy with custom configuration
asantiya deploy --config production.yaml
 
# Deploy without building (use existing image)
asantiya deploy --skip-build

Application Management

`asantiya app start`

Start the main application container.

Purpose: Starts the primary application container defined in your configuration.

Examples:


asantiya app start

`asantiya app stop`

Stop the main application container and all accessories.

Purpose: Gracefully stops the main application and all associated accessory containers.

Examples:


asantiya app stop

`asantiya app remove`

Remove the main application container and associated images.

Purpose: Completely removes the application container and cleans up Docker images.

Examples:


asantiya app remove

Accessory Commands

`asantiya accessory`

Manage accessories (additional services like databases, caches, etc.).


asantiya accessory <subcommand> [OPTIONS] [ACCESSORY_NAME]

`asantiya accessory deploy`

Deploy an accessory service.


asantiya accessory deploy [ACCESSORY_NAME] [OPTIONS]

Options:

--all - Deploy all accessories
--wait - Wait for deployment to complete

Examples:


# Deploy specific accessory
asantiya accessory deploy postgres
 
# Deploy all accessories
asantiya accessory deploy --all
 
# Deploy and wait for completion
asantiya accessory deploy postgres --wait

`asantiya accessory start`

Start an accessory service.


asantiya accessory start [ACCESSORY_NAME] [OPTIONS]

Examples:


# Start specific accessory
asantiya accessory start postgres
 
# Start all accessories
asantiya accessory start --all

`asantiya accessory stop`

Stop an accessory service.


asantiya accessory stop [ACCESSORY_NAME] [OPTIONS]

Examples:


# Stop specific accessory
asantiya accessory stop postgres
 
# Stop all accessories
asantiya accessory stop --all

`asantiya accessory remove`

Remove an accessory service.


asantiya accessory remove [ACCESSORY_NAME] [OPTIONS]

Options:

--volumes - Also remove associated volumes

Examples:


# Remove specific accessory
asantiya accessory remove postgres
 
# Remove with volumes
asantiya accessory remove postgres --volumes

`asantiya accessory status`

Show status of accessory services.


asantiya accessory status [ACCESSORY_NAME] [OPTIONS]

Examples:


# Show status of all accessories
asantiya accessory status
 
# Show status of specific accessory
asantiya accessory status postgres

`asantiya accessory logs`

Show logs from accessory services.


asantiya accessory logs [ACCESSORY_NAME] [OPTIONS]

Options:

--follow - Follow log output
--tail N - Show last N lines

Examples:


# Show logs for all accessories
asantiya accessory logs
 
# Show logs for specific accessory
asantiya accessory logs postgres
 
# Follow logs in real-time
asantiya accessory logs postgres --follow

Configuration Commands

`asantiya config`

Manage configuration files and settings.


asantiya config <subcommand> [OPTIONS]

`asantiya config validate`

Validate configuration file syntax and settings.


asantiya config validate [OPTIONS]

Options:

--config FILE - Validate specific configuration file

Examples:


# Validate default configuration
asantiya config validate
 
# Validate specific configuration file
asantiya config validate --config deploy.prod.yaml

`asantiya config show`

Display current configuration.


asantiya config show [OPTIONS]

Options:

--config FILE - Show specific configuration file
--json - Output in JSON format

Examples:


# Show current configuration
asantiya config show
 
# Show configuration in JSON format
asantiya config show --json

`asantiya config test`

Test configuration without deploying.


asantiya config test [OPTIONS]

Examples:


# Test current configuration
asantiya config test

Utility Commands

`asantiya doctor`

Check system requirements and configuration.


asantiya doctor [OPTIONS]

Options:

--fix - Attempt to fix common issues

Examples:


# Check system health
asantiya doctor
 
# Check and fix issues
asantiya doctor --fix

`asantiya version`

Show version information.


asantiya version [OPTIONS]

Options:

--json - Output in JSON format

Examples:


# Show version
asantiya version
 
# Show version in JSON format
asantiya version --json

`asantiya help`

Show help information.


asantiya help [COMMAND]

Examples:


# Show general help
asantiya help
 
# Show help for specific command
asantiya help deploy

For more information about specific commands, use asantiya help <command> or refer to the Examples section.