Watcher CLI
Every data-hub-watcher command, subcommand, and flag in one place: init, watch, upload, config, service, and self-update.
Flags and subcommands for data-hub-watcher, generated from the Click CLI in the watcher package. For task walkthroughs see Install and update the watcher, Run as a Windows service, and Roll out watcher releases.
Command reference
The catalog below lists every command, argument, and option from the installed CLI help text.
Global flags
These options apply to every data-hub-watcher command (watcher 0.5.0).
Flags
--config PATHDATA_HUB_CONFIG_PATHpathOverride config file path.
--verbosebooleanEnable debug logging.
--versionbooleanShow the version and exit.
data-hub-watcher config
View and manage the watcher config file.
data-hub-watcher config edit
data-hub-watcher config open
Flags
--editortextEditor command (e.g. --editor code).
data-hub-watcher config path
data-hub-watcher config set-environment
Arguments
ENVIRONMENTrequiredchoice (staging | production | preview)Flags
--api-base-urltextAPI base URL for the target environment. Required the first time you switch to an environment; reused from config on later switches.
--api-keytextAPI key for the target environment.
--show-keybooleanEcho the API key as typed (useful on Windows terminals).
--no-registerbooleanFail instead of registering a new watcher if none is stored for the target env.
data-hub-watcher config show
data-hub-watcher config validate
data-hub-watcher init
Interactive setup wizard + API registration.
Flags
--show-keybooleanEcho the API key as it is typed/pasted. Useful on Windows terminals where hidden input is unreliable for paste.
data-hub-watcher self-update
Check the server for a newer watcher release and upgrade in place. Designed for unattended use — schedule via Windows Task Scheduler (e.g. weekly) so lab PCs converge on the latest published version without operator intervention.
Flags
--checkbooleanPrint the server-reported target version without performing the upgrade.
--forcebooleanRun the upgrade subprocess even if the local version already matches the target.
data-hub-watcher service
Windows service management.
data-hub-watcher service install
Flags
--env-path FILEfilePath to the .env file. Defaults to ~/.data-hub/.env.<environment>.
data-hub-watcher service reinstall
Flags
--env-path FILEfilePath to the .env file. Defaults to ~/.data-hub/.env.<environment>.
data-hub-watcher service start
data-hub-watcher service status
data-hub-watcher service stop
data-hub-watcher service uninstall
data-hub-watcher upload
Upload files to Data Hub (manual trigger). One-shot mode: pass both --file and --run-id to upload a single file. Queue mode: omit both to process the server-side upload queue.
Flags
--file PATHpathSpecific file to upload.
--run-idtextAssociate upload with a specific run.
--dry-runbooleanLog what would be uploaded without uploading.
data-hub-watcher watch
Start watching for new files.
Flags
--dry-runbooleanValidate and log but don't start monitoring.
Interactive setup notes
init and config edit prompt for values in the terminal. Those prompts are not CLI flags, so they do not appear in the catalog.
Keys must start with dhub_. The watcher strips zero-width and non-breaking-space characters that some Windows clipboards inject. See Install and update the watcher → Configure.
Upload examples
One-shot upload outside the watch loop:
data-hub-watcher upload --file /path/to/file.csv --run-id RUN001
data-hub-watcher upload
data-hub-watcher upload --dry-runPass both --file and --run-id, or omit both to process the server-side queue in manual mode.
Switching environments
config set-environment (and config edit when the environment changes) can take --api-base-url, --api-key, --show-key, and --no-register. Preview switches require --api-base-url the first time. See Watcher configuration → Switching environments.
Windows service notes
service commands require Windows and the windows-service install extra. Use --env-path on service install and service reinstall when the service should load a non-default .env file. Full details are in Run as a Windows service.
Self-update examples
data-hub-watcher self-update
data-hub-watcher self-update --check
data-hub-watcher self-update --forceUpgrade behavior depends on how you installed the watcher. See Install and update the watcher → Manual update.