Skip to content

Latest commit

 

History

History
313 lines (218 loc) · 6.77 KB

README.md

File metadata and controls

313 lines (218 loc) · 6.77 KB
Raw

qbit-scripts

CLI for automating various qBittorrent tasks.

Usage

$ npm install -g qbit-scripts
$ qbit-scripts COMMAND
running command...
$ qbit-scripts (--version)
qbit-scripts/0.0.0 linux-x64 node-v18.8.0
$ qbit-scripts --help [COMMAND]
USAGE
  $ qbit-scripts COMMAND
...

Commands

qbit-scripts help [COMMAND]

Display help for qbit-scripts.

USAGE
  $ qbit-scripts help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for qbit-scripts.

See code: @oclif/plugin-help

qbit-scripts plugins

List installed plugins.

USAGE
  $ qbit-scripts plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ qbit-scripts plugins

See code: @oclif/plugin-plugins

qbit-scripts plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ qbit-scripts plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ qbit-scripts plugins add

EXAMPLES
  $ qbit-scripts plugins:install myplugin 

  $ qbit-scripts plugins:install https://github.com/someuser/someplugin

  $ qbit-scripts plugins:install someuser/someplugin

qbit-scripts plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ qbit-scripts plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ qbit-scripts plugins:inspect myplugin

qbit-scripts plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ qbit-scripts plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ qbit-scripts plugins add

EXAMPLES
  $ qbit-scripts plugins:install myplugin 

  $ qbit-scripts plugins:install https://github.com/someuser/someplugin

  $ qbit-scripts plugins:install someuser/someplugin

qbit-scripts plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ qbit-scripts plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Links a plugin into the CLI for development.
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ qbit-scripts plugins:link myplugin

qbit-scripts plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ qbit-scripts plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ qbit-scripts plugins unlink
  $ qbit-scripts plugins remove

qbit-scripts plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ qbit-scripts plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ qbit-scripts plugins unlink
  $ qbit-scripts plugins remove

qbit-scripts plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ qbit-scripts plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ qbit-scripts plugins unlink
  $ qbit-scripts plugins remove

qbit-scripts plugins update

Update installed plugins.

USAGE
  $ qbit-scripts plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

qbit-scripts unclog-queue

move stalled torrents to the end of the queue

USAGE
  $ qbit-scripts unclog-queue -h <value> -u <value> -p <value> [-t <value>]

FLAGS
  -h, --host=<value>       (required) qbit host
  -p, --password=<value>   (required) qbit password
  -t, --threshold=<value>  [default: 1h] min active time to be considered stalled
  -u, --username=<value>   (required) qbit username

DESCRIPTION
  move stalled torrents to the end of the queue

EXAMPLES
  $ qbit-scripts unclog-queue -h https://qbit.example.com -u admin -p adminadmin

See code: dist/commands/unclog-queue.ts