FifteenthStandard.Quartermaster 1.0.2

dotnet tool install --global FifteenthStandard.Quartermaster --version 1.0.2
                    
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest
                    
if you are setting up this repo
dotnet tool install --local FifteenthStandard.Quartermaster --version 1.0.2
                    
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=FifteenthStandard.Quartermaster&version=1.0.2
                    
nuke :add-package FifteenthStandard.Quartermaster --version 1.0.2
                    

Quartermaster

Search and download torrents. Torrents are sourced from The Pirate Bay via the API at https://apibay.org/q.php?q=%SEARCH_TERMS%.

Usage

qm search <terms>        Search for torrents
Arguments:
  <terms>  Search terms, e.g. title, IMDb ID

qm download <hash>       Download a torrent
Arguments:
  <hash>  Torrent info hash
Options:
  --interactive  Interactively select files to download

qm config <key>          Get configuration
Arguments:
  <key>  The config setting to get
         Possible values:
         - directory  The directory to which torrents are downloaded

qm config <key> <value>  Set configuration
Arguments:
  <key>   The config setting to set
           Possible values:
           - directory  The directory to which torrents are downloaded
  <value>  The new value to set

Example Usage

# Search for a torrent by title
$ qm search the godfather
Hash                                        Size        Seeds    Name
----------------------------------------    --------    -----    --------------------------------------------------------------------------------
0123456789ABCDEF0123456789ABCDEF01234567       2.4GB      256    The Godfather (1972)
...

# Search for a torrent by IMDb ID
$ qm search tt0068646
Hash                                        Size        Seeds    Name
----------------------------------------    --------    -----    --------------------------------------------------------------------------------
0123456789ABCDEF0123456789ABCDEF01234567       2.4GB      256    The Godfather (1972)
...

# Download a torrent to current directory
$ qm download 0123456789ABCDEF0123456789ABCDEF01234567
Downloading torrent file to ~/0123456789ABCDEF0123456789ABCDEF01234567.torrent
Downloading to ~/The Godfather (1972)
 15%    Downloading
 15%    The.Godfather.1972.mp4
 85%    The.Godfather.1972.srt

# Set download directory with environment variable
$ export QM_DIRECTORY=~/torrents
$ qm download 0123456789ABCDEF0123456789ABCDEF01234567
Downloading torrent file to ~/torrents/0123456789ABCDEF0123456789ABCDEF01234567.torrent
Downloading to ~/torrents/The Godfather (1972)
 15%    Downloading
 15%    The.Godfather.1972.mp4
 85%    The.Godfather.1972.srt

# Set download directory via config file
$ unset QM_DIRECTORY
$ qm config directory ~/torrents

# Confirm configuration
$ qm config directory
~/torrents

# Manually confirm configuration
$ cat ~/.qmconfig
directory = ~/torrents

# Select files to download
$ qm download 0123456789ABCDEF0123456789ABCDEF01234567 --interactive
Downloading torrent file to ~/torrents/0123456789ABCDEF0123456789ABCDEF01234567.torrent
+    2.4GB The.Godfather.1972.mp4
-  104.7KB The.Godfather.1972.srt

[▲▼]: Move cursor    [Space]: Toggle selection    [a]: Toggle all    [Enter]: Confirm

Dependencies

Quartermaster uses the following dependencies:

  • Developed with .NET 7
  • CLI developed with System.CommandLine
  • https://apibay.org/q.php?q=%SEARCH_TERMS% to search for torrents
  • https://itorrents.org/torrent/%INFO_HASH%.torrent to download torrent files
  • MonoTorrent to download torrents

Build

To build, download and install the .NET 7 SDK and then run the following.

dotnet build

To run locally, run the following.

dotnet run -- <command> [<arguments>]

To build a standalone executable, run the following.

dotnet publish

This standalone executable can then be copied to a directory on your PATH to easily run from anywhere.

Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last Updated
1.0.2 1,765 1/20/2023
1.0.1 1,752 1/19/2023
1.0.0 1,742 12/31/2022