From 666975211a77cdd99625f7d2ebe6210fb100efbc Mon Sep 17 00:00:00 2001 From: Ben Sarmiento Date: Thu, 11 Jan 2024 05:33:31 +0100 Subject: [PATCH] Add command line help output --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 3c0965b..cffef90 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,28 @@ A webdav server is also exposed to your localhost via port `9999`. ### Note: when using zurg in a server outside of your home network, ensure that "Use my Remote Traffic automatically when needed" is unchecked on your [Account page](https://real-debrid.com/account) +## Command-line utility + +``` +Usage: + zurg [flags] + zurg [command] + +Available Commands: + clear-downloads Clear all downloads (unrestricted links) in your account + clear-torrents Clear all torrents in your account + completion Generate the autocompletion script for the specified shell + help Help about any command + network-test Run a network test + version Prints zurg's current version + +Flags: + -c, --config string config file path (default "./config.yml") + -h, --help help for zurg + +Use "zurg [command] --help" for more information about a command. +``` + ## Why zurg? Why not X? - Better performance than anything out there; changes in your library appear instantly ([assuming Plex picks it up fast enough](./plex_update.sh))