LinuxCommandLibrary

transmission-remote

Control remote Transmission BitTorrent client

TLDR

Add a torrent file or magnet link to Transmission and download to a specified directory

$ transmission-remote [hostname] [[-a|--all]] [torrent|url] [[-w|--download-dir]] [/path/to/download_directory]
copy

Change the default download directory
$ transmission-remote [hostname] [[-w|--download-dir]] [/path/to/download_directory]
copy

List all torrents
$ transmission-remote [hostname] [[-l|--list]]
copy

Start torrent 1 and 2, stop torrent 3
$ transmission-remote [hostname] [[-t|--torrent]] "1,2" [[-s|--start]] [[-t|--torrent]] 3 [[-S|--stop]]
copy

Remove torrent 1 and 2, and also delete local data for torrent 2
$ transmission-remote [hostname] [[-t|--torrent]] 1 [[-r|--remove]] [[-t|--torrent]] 2 [[-rad|--remove-and-delete]]
copy

Stop all torrents
$ transmission-remote [hostname] [[-t|--torrent]] [all] [[-S|--stop]]
copy

Move torrents 1-10 and 15-20 to a new directory (which will be created if it does not exist)
$ transmission-remote [hostname] [[-t|--torrent]] "1-10,15-20" --move [/path/to/new_directory]
copy

SYNOPSIS

transmission-remote [options] [torrent-id(s) or "all"]

PARAMETERS

-a |
    Add a torrent.

-t |<"all">
    Specify torrent ID or "all".

-r
    Remove the specified torrent(s).

-s
    Start the specified torrent(s).

-S
    Stop the specified torrent(s).

-v
    Verify the specified torrent(s).

-l
    List all torrents.

-i
    Show complete info for the specified torrent(s).

-p
    Set the Transmission daemon's port number.

-u
    Set the username for authentication.

-w
    Set the password for authentication.

-n
    Set the username and password for authentication in one parameter.

-T
    Ask server for torrent list.

-e
    Set the location of the configuration directory.

-d
    Set the new download directory.

-f
    Associate a new torrent file with the specified torrent(s).

-h
    Show help message and exit.

DESCRIPTION

The `transmission-remote` command is a command-line client for interacting with a remote Transmission BitTorrent daemon. It allows users to add, remove, start, stop, and manage torrents running on a server without needing to be physically present at the server. It provides a text-based interface for performing common torrent management tasks, such as setting download limits, adjusting peer connections, verifying torrent data, and querying the status of ongoing downloads and uploads. Its design allows users to easily control a headless Transmission installation, common in seedboxes and home server setups, from other machines on the network. transmission-remote offers more options, as compare to the web client.

CAVEATS

Authentication is required if the Transmission daemon is configured to require it. Torrent IDs are assigned by the daemon and can change. Using 'all' can be dangerous if there are many torrents.

RETURN CODES

The `transmission-remote` command returns 0 on success. A non-zero return code indicates an error, such as a failed connection to the daemon or an invalid command-line argument.

EXAMPLES

Add a torrent: `transmission-remote -a torrent.torrent`.
Start torrent ID 5: `transmission-remote -s 5`.
Stop all torrents: `transmission-remote -S all`.
List all torrents: `transmission-remote -l`.
Remove torrent ID 3: `transmission-remote -r 3`.

HISTORY

The `transmission-remote` command has evolved alongside the Transmission BitTorrent client itself. It was created to provide a lightweight command-line interface for managing Transmission daemons, particularly in headless environments. The functionality and features have been extended over time to support new features in the daemon, such as magnet links, encryption, and various configuration options.

SEE ALSO

transmissiond(1)

Copied to clipboard