Welcome to Xirvik Tool’s documentation!¶
Commands¶
xirvik¶
Root command.
xirvik [OPTIONS] COMMAND [ARGS]...
Options
- -C, --config <config>¶
Configuration file
- -H, --host <host>¶
Xirvik host (without protocol)
ftp¶
Commands for managing the FTP server.
xirvik ftp [OPTIONS] COMMAND [ARGS]...
add-ftp-user¶
Adds an FTP user.
xirvik ftp add-ftp-user [OPTIONS] USERNAME PASSWORD
Options
- -p, --port <port>¶
- -d, --debug¶
- -r, --root-directory <root_directory>¶
- -H, --host <host>¶
Xirvik host (without protocol)
- -C, --config <config>¶
Configuration file
Arguments
- USERNAME¶
Required argument
- PASSWORD¶
Required argument
delete-ftp-user¶
Deletes an FTP user.
xirvik ftp delete-ftp-user [OPTIONS] USERNAME
Options
- -p, --port <port>¶
- -d, --debug¶
- -H, --host <host>¶
Xirvik host (without protocol)
- -C, --config <config>¶
Configuration file
Arguments
- USERNAME¶
Required argument
list-ftp-users¶
Lists FTP users.
xirvik ftp list-ftp-users [OPTIONS]
Options
- -p, --port <port>¶
- -d, --debug¶
- -H, --host <host>¶
Xirvik host (without protocol)
- -C, --config <config>¶
Configuration file
rtorrent¶
Commands for managing rTorrent.
xirvik rtorrent [OPTIONS] COMMAND [ARGS]...
fix-rtorrent¶
Restarts the rtorrent service in case ruTorrent cannot connect to it. Not guaranteed to fix anything!
xirvik rtorrent fix-rtorrent [OPTIONS]
Options
- -H, --host <host>¶
Xirvik host (without protocol)
- -C, --config <config>¶
Configuration file
- -p, --port <port>¶
- -d, --debug¶
list-all-files¶
list all tracked file paths.
xirvik rtorrent list-all-files [OPTIONS]
Options
- -H, --host <host>¶
Xirvik host (without protocol)
- -C, --config <config>¶
Configuration file
- -p, --port <port>¶
- -d, --debug¶
list-files¶
list a torrent’s files in a given format.
xirvik rtorrent list-files [OPTIONS] HASH
Options
- -H, --host <host>¶
Xirvik host (without protocol)
- -C, --config <config>¶
Configuration file
- -p, --port <port>¶
- -d, --debug¶
- -I, --no-headers¶
- -F, --table-format <table_format>¶
- Options:
asciidoc | double_grid | double_outline | fancy_grid | fancy_outline | github | grid | heavy_grid | heavy_outline | html | jira | latex | latex_booktabs | latex_longtable | latex_raw | mediawiki | mixed_grid | mixed_outline | moinmoin | orgtbl | outline | pipe | plain | presto | pretty | psql | rounded_grid | rounded_outline | rst | simple | simple_grid | simple_outline | textile | tsv | unsafehtml | youtrack | json
- -S, --sort <sort>¶
- Options:
name | size_bytes | priority
- -R, --reverse-order¶
Arguments
- HASH¶
Required argument
list-torrents¶
list torrents in a given format.
xirvik rtorrent list-torrents [OPTIONS]
Options
- -H, --host <host>¶
Xirvik host (without protocol)
- -C, --config <config>¶
Configuration file
- -p, --port <port>¶
- -d, --debug¶
- -I, --no-headers¶
- -F, --table-format <table_format>¶
- Options:
asciidoc | double_grid | double_outline | fancy_grid | fancy_outline | github | grid | heavy_grid | heavy_outline | html | jira | latex | latex_booktabs | latex_longtable | latex_raw | mediawiki | mixed_grid | mixed_outline | moinmoin | orgtbl | outline | pipe | plain | presto | pretty | psql | rounded_grid | rounded_outline | rst | simple | simple_grid | simple_outline | textile | tsv | unsafehtml | youtrack | json
- -S, --sort <sort>¶
- Options:
name | hash | label | creation_date | state_changed | finished
- -R, --reverse-order¶
list-untracked-files¶
list untracked file paths.
xirvik rtorrent list-untracked-files [OPTIONS]
Options
- -H, --host <host>¶
Xirvik host (without protocol)
- -L, --server-list-command <server_list_command>¶
This should be a command that outputs lines where each line is a complete file path that matches the “torrents/<username>/…” output from ruTorrent’s API. An example using SSH:
ssh name-of-server ‘find /media/sf_hostshare -type f’ | sed -re ‘s|^/media/sf_hostshare|/torrents/username|g’
- -d, --debug¶
main¶
Delete torrents based on certain criteria.
xirvik rtorrent main [OPTIONS]
Options
- -u, --username <username>¶
Xirvik user
- -p, --password <password>¶
Xirvik password
- -r, --max-retries <max_retries>¶
Number of retries for each request (passed to client)
- -d, --debug¶
Enable debug level logging
- --backoff-factor <backoff_factor>¶
Back-off factor used when calculating time to wait to retry a failed request
- --netrc <netrc>¶
netrc file path
- -C, --config <config>¶
Configuration file
- -H, --host <host>¶
Xirvik host (without protocol)
- -D, --ignore-date¶
- -a, --ignore-ratio¶
- -y, --dry-run¶
- --days <days>¶
- --label <label>¶
- --max-attempts <max_attempts>¶
- --sleep-time <sleep_time>¶
main¶
Move torrents according to labels assigned.
xirvik rtorrent main [OPTIONS]
Options
- -u, --username <username>¶
Xirvik user
- -p, --password <password>¶
Xirvik password
- -r, --max-retries <max_retries>¶
Number of retries for each request (passed to client)
- -d, --debug¶
Enable debug level logging
- --backoff-factor <backoff_factor>¶
Back-off factor used when calculating time to wait to retry a failed request
- --netrc <netrc>¶
netrc file path
- -C, --config <config>¶
Configuration file
- -H, --host <host>¶
Xirvik host (without protocol)
- -b, --batch-size <batch_size>¶
Batch size.
- -c, --completed-dir <completed_dir>¶
Top directory where moved torrent data will be placed
- -t, --sleep-time <sleep_time>¶
Time to sleep in seconds at certain times during this batch of requests
- -l, --lower-label¶
Call lower() on labels used to make directory names
- --ignore-labels <ignore_labels>¶
List of labels to ignore (case-sensitive).
main¶
Move torrents in error state to another location.
xirvik rtorrent main [OPTIONS]
Options
- -u, --username <username>¶
Xirvik user
- -p, --password <password>¶
Xirvik password
- -r, --max-retries <max_retries>¶
Number of retries for each request (passed to client)
- -d, --debug¶
Enable debug level logging
- --backoff-factor <backoff_factor>¶
Back-off factor used when calculating time to wait to retry a failed request
- --netrc <netrc>¶
netrc file path
- -C, --config <config>¶
Configuration file
- -H, --host <host>¶
Xirvik host (without protocol)
- --sleep-time <sleep_time>¶
start-torrents¶
Uploads torrent files to the server.
xirvik rtorrent start-torrents [OPTIONS] [DIRECTORIES]...
Options
- -p, --port <port>¶
- -d, --debug¶
- --start-stopped¶
- -s, --syslog¶
- -H, --host <host>¶
Xirvik host (without protocol)
- -C, --config <config>¶
Configuration file
- --no-verify¶
Disable TLS verification (not recommended)
Arguments
- DIRECTORIES¶
Optional argument(s)
vm¶
Commands for the Linux virtual machine.
xirvik vm [OPTIONS] COMMAND [ARGS]...