Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sunny/remotransmission

Command line interface for remote Transmission
https://github.com/sunny/remotransmission

Last synced: 2 months ago
JSON representation

Command line interface for remote Transmission

Awesome Lists containing this project

README

        

RemoTransmission
================

A command line interface for remote transmission.

Can add a torrent and list the current torrents with their percentage.

Install
-------

```sh
$ gem install remotransmission
```

Usage
-----

```sh
$ remotransmission
Usage: remotransmission [options...]

Commands:
-a, --add=URL Add a torrent by its URL
-l, --list List current torrents
--help Show this message
--version Show version

Options:
--host=IP The hostname or ip of the server to connect to (default "localhost")
--port=PORT The port to bind to (default 9091)
-u, --user=USER User to authenticate (default "freebox")
-p, --password=PASSWORD Password to authenticate
-d, --debug Enable debug mode (default false)
```

Examples
--------

Adding a magnet URL with the default host and port and user (`192.168.0.254`,
`9091` and `freebox`) and specifying a password:

```sh
$ remotransmission -p PaSsWord --add 'magnet://...'
success
```

List all current torrents by specifying the hostname, user and password:

```sh
$ remotransmission -u bob -p PaSsWord -s 214.512.12.20 --list
100% - ubuntu-10.10-desktop-i386.iso
80% - ubuntu-10.10-server-i386.iso
```

Configuration file
------------------

To set any global option you can create a `~/.config/remotransmission/settings.json`:

```json
{
"host": "192.168.0.254",
"port": 9091,
"user": "freebox",
"password": "foobarspam",
"debug": true
}
```

Development
-----------

Running remotransmission locally:

```sh
$ bundle
$ bundle exec remotransmission
```

Build, install and release the gem through rake tasks.

```sh
$ rake -T
```

Credit
------

- Authors : Sunny Ripert
- License : [[MIT|http://opensource.org/licenses/MIT]]