CLI Reference

hubio-sync provides a comprehensive command-line interface for managing data migrations, scheduling, and system services.

Quick Reference

CommandDescriptionStatus
guiLaunch native GUI interface✅ Available
serveStart background scheduler daemon✅ Available
migrateRun one-time migration🚧 Pending
syncRun incremental sync🚧 Pending
validateValidate connectivity🚧 Pending
statusShow migration status🚧 Pending
configConfiguration management🚧 Pending
scheduleSchedule management🚧 Pending
migrationsMigration job management🚧 Pending
logsView logs🚧 Pending
upgradeCheck for and install upgrades✅ Available
serviceSystem service management✅ Available
infoDisplay build information✅ Available

Global Options

hubio-sync [command] [flags]
FlagDescription
--version, -vPrint version information
--help, -hShow 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 migration
  • sync - Incremental data synchronization
  • validate - Test source/destination connectivity

User Interface

  • gui - Launch the graphical interface

Background Services

  • serve - Run the scheduler daemon
  • service - Install and manage as system service

Job Management

Configuration & Maintenance

  • config - Manage configuration files
  • upgrade - Update to latest version
  • info - Display system information

Exit Codes

CodeMeaning
0Success
1General error

Environment Variables

hubio-sync respects the following environment variables:

VariableDescription
XDG_CONFIG_HOMEConfig directory (Linux)
XDG_DATA_HOMEData directory (Linux)
XDG_STATE_HOMEState/logs directory (Linux)
APPDATAConfig directory (Windows)
LOCALAPPDATAData/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.


See Also