Command Reference #
Complete reference for all Quad-Ops commands with detailed options, examples, and use cases.
Command Structure #
Quad-Ops follows a hierarchical command structure:
quad-ops [global-options] <command> [command-options] [arguments]
Global Options #
| Option | Short | Description |
|---|---|---|
--config | Path to configuration file | |
--verbose | -v | Enable verbose output |
--user | -u | Run in rootless user mode |
--quadlet-dir | Override unit output directory | |
--repository-dir | Override git checkout directory | |
--help | -h | Show help information |
Available Commands #
Command-Specific Help #
# Help for any command
quad-ops <command> --help
# Examples
quad-ops sync --help
quad-ops unit list --help
Core Operations #
- sync - Synchronize repositories and deploy containers
- daemon - Run quad-ops as a daemon with periodic synchronization
- up - Start all or specific services
- down - Stop and remove services
- validate - Validate Docker Compose files and quad-ops extensions
- update - Update quad-ops to the latest version
- version - Show version information and check for updates
System Health #
- doctor - Check system health and configuration
Image Management #
- image pull - Pull container images from repositories
Unit Management #
Configuration #
- config - Configuration management commands