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 #
Core Operations #
- sync - Synchronize repositories and deploy containers
- 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
Image Management #
- image pull - Pull container images from repositories
Unit Management #
Configuration #
- config - Configuration management commands
Command Categories #
Repository Operations #
Commands that interact with Git repositories and perform synchronization.
Validation & Development #
Commands for validating Docker Compose files and supporting development workflows.
Service Management #
Commands for controlling container lifecycle and examining running services.
Unit Administration #
Commands for managing Quadlet units and their systemd integration.
System Configuration #
Commands for validating and managing Quad-Ops configuration.
Common Usage Patterns #
Development Workflow #
# Validate compose files before committing
quad-ops validate docker-compose.yml
# Validate entire project directory
quad-ops validate ./compose-files/
Initial Deployment #
# Configure repositories and perform first sync
sudo quad-ops sync
Regular Operations #
# Check service status
sudo quad-ops unit list
# Restart specific service
sudo quad-ops up myapp-web
# Stop all services for maintenance
sudo quad-ops down
Exit Codes #
Quad-Ops uses standard exit codes for scripting and automation:
| Exit Code | Meaning |
|---|---|
0 | Success |
1 | General error |
2 | Invalid command usage |
3 | Configuration error |
4 | Git operation failed |
5 | systemd operation failed |
Getting Help #
Command-Specific Help #
# Help for any command
quad-ops <command> --help
# Examples
quad-ops sync --help
quad-ops unit list --help
Manual Pages #
# View manual page (if installed)
man quad-ops
man quad-ops-sync
Next Steps #
Browse the individual command references for detailed information on options, examples, and use cases.