CLI Reference
hubio-sync provides a comprehensive command-line interface for managing data migrations, scheduling, and system services.
Quick Reference
| Command | Description | Status |
|---|---|---|
gui | Launch native GUI interface | ✅ Available |
serve | Start background scheduler daemon | ✅ Available |
migrate | Run one-time migration | 🚧 Pending |
sync | Run incremental sync | 🚧 Pending |
validate | Validate connectivity | 🚧 Pending |
status | Show migration status | 🚧 Pending |
config | Configuration management | 🚧 Pending |
schedule | Schedule management | 🚧 Pending |
migrations | Migration job management | 🚧 Pending |
logs | View logs | 🚧 Pending |
upgrade | Check for and install upgrades | ✅ Available |
service | System service management | ✅ Available |
info | Display build information | ✅ Available |
Global Options
hubio-sync [command] [flags]
| Flag | Description |
|---|---|
--version, -v | Print version information |
--help, -h | Show help for any command |
Getting Help
Get help for any command:
# General help
hubio-sync --help
# Command-specific help
hubio-sync serve --help
hubio-sync service install --help
Version Information
hubio-sync --version
Output:
hubio-sync version 1.0.8
Command Categories
Core Operations
migrate- One-time data migrationsync- Incremental data synchronizationvalidate- Test source/destination connectivity
User Interface
gui- Launch the graphical interface
Background Services
Job Management
status- View migration statusmigrations- Manage migration jobsschedule- Manage scheduled jobslogs- View application logs
Configuration & Maintenance
config- Manage configuration filesupgrade- Update to latest versioninfo- Display system information
Exit Codes
| Code | Meaning |
|---|---|
0 | Success |
1 | General error |
Environment Variables
hubio-sync respects the following environment variables:
| Variable | Description |
|---|---|
XDG_CONFIG_HOME | Config directory (Linux) |
XDG_DATA_HOME | Data directory (Linux) |
XDG_STATE_HOME | State/logs directory (Linux) |
APPDATA | Config directory (Windows) |
LOCALAPPDATA | Data/logs directory (Windows) |
Configuration Paths
Configuration and data are stored in platform-specific locations:
macOS:
- Config:
~/.config/hubio-sync/ - Data:
~/.local/share/hubio-sync/ - Logs:
~/Library/Logs/hubio-sync/
Linux:
- Config:
~/.config/hubio-sync/ - Data:
~/.local/share/hubio-sync/ - Logs:
~/.local/state/hubio-sync/logs/
Windows:
- Config:
%APPDATA%\hubio-sync\ - Data:
%LOCALAPPDATA%\hubio-sync\data\ - Logs:
%LOCALAPPDATA%\hubio-sync\logs\
Use hubio-sync info to see exact paths on your system.