Command Line Flags

GatherHub provides several command line flags that can be used to customize its behavior when launching from the terminal.

Usage: gatherhub [flags]

Available Command Flags

Flag Description Default Example
--config Path to config file data/config/config.toml gatherhub --config=/path/to/custom-config.toml
--scan Scan sources for new content false gatherhub --scan
--download Process pending downloads false gatherhub --download
--status Show download status false gatherhub --status
--retry Retry failed downloads false gatherhub --retry
--clean Clean failed downloads false gatherhub --clean
--daemon Run as daemon false gatherhub --daemon
--api Start API server false gatherhub --api
--web Start web interface false gatherhub --web
--help Show help information false gatherhub --help
--import-bookmarks Import browser bookmarks with specified name Empty gatherhub --import-bookmarks="firefox-bookmarks"
--browser Browser to import from (firefox, chrome) firefox gatherhub --import-bookmarks="chrome-bookmarks" --browser=chrome
--profile Optional browser profile path Empty gatherhub --import-bookmarks="firefox-work" --profile="/path/to/profile"
--generate-admin-password Generate a new admin password hash false gatherhub --generate-admin-password
--reindex-all Reindex all downloaded files false gatherhub --reindex-all

Examples

Basic Usage
gatherhub

Starts GatherHub with default settings. Without any flags, it will show the version information and usage instructions.

Custom Configuration
gatherhub --config=/path/to/custom-config.toml

Starts GatherHub with a custom configuration file.

Run as a Service
gatherhub --daemon

Runs GatherHub as a daemon, executing scheduled operations according to the configuration.

Start Web Interface and API Server
gatherhub --web --api

Starts both the web interface and API server for managing downloads through the browser and via API calls.

Import Browser Bookmarks
gatherhub --import-bookmarks="firefox-bookmarks" --browser=firefox

Imports bookmarks from Firefox and adds them as download jobs with the source name "firefox-bookmarks".

Process Pending Downloads
gatherhub --download

Processes all pending download jobs, then exits.

Search Results

Type to search documentation...