azlin help¶

Show help for azlin commands.

Synopsis¶

azlin help [COMMAND_NAME]

Description¶

Display general help or detailed help for a specific command. Shows usage, options, examples, and related commands.

Usage¶

General Help¶

# Show all azlin commands
azlin help

Shows complete command listing with descriptions.

Command-Specific Help¶

# Show help for specific command
azlin help connect
azlin help list
azlin help new

Displays detailed information including: - Command syntax - Available options - Usage examples - Related commands

Examples¶

View All Commands¶

azlin help

Output:

azlin - Azure Ubuntu VM provisioning and management

NATURAL LANGUAGE COMMANDS (AI-POWERED):
  do            Execute commands using natural language

VM LIFECYCLE COMMANDS:
  new           Provision a new VM
  clone         Clone a VM with its home directory
  list          List VMs in resource group
  ...

Get Help for Specific Commands¶

# VM creation
azlin help new

# SSH connection
azlin help connect

# Resource cleanup
azlin help kill

Quick Reference¶

# Alternative: Use --help flag
azlin connect --help
azlin new --help
azlin list --help

Both azlin help <command> and azlin <command> --help show the same information.

Common Help Queries¶

VM Management¶

azlin help new        # Create VMs
azlin help list       # List VMs
azlin help status     # VM status
azlin help start      # Start VMs
azlin help stop       # Stop VMs
azlin help kill       # Delete VMs

Connection¶

azlin help connect    # SSH to VM
azlin help code       # VS Code integration
azlin help bastion    # Bastion hosts

Storage & Files¶

azlin help storage    # NFS storage
azlin help sync       # File sync
azlin help cp         # File copy

Monitoring¶

azlin help cost       # Cost estimates
azlin help w          # Who's logged in
azlin help ps         # Running processes
azlin help top        # System resources

Advanced¶

azlin help do         # AI commands
azlin help batch      # Batch operations
azlin help compose    # Multi-VM orchestration

Help Output Format¶

Each command help includes:

Usage - Command syntax
Description - What the command does
Arguments - Required parameters
Options - Optional flags
Examples - Common usage patterns

All commands support the --help flag:

azlin <command> --help
azlin <command> <subcommand> --help

Tips¶

Find Commands by Category¶

Use azlin help and search the output:

azlin help | grep -i "storage"
azlin help | grep -i "cost"
azlin help | grep -i "delete"

Quick Command Reference¶

# Most used commands
azlin help new        # Create VM
azlin help list       # List VMs
azlin help connect    # SSH to VM
azlin help stop       # Stop VM
azlin help kill       # Delete VM

Get Started¶

# First-time users
azlin help new        # Learn to create VMs
azlin help            # See all commands