Skip to content
rTorrent XMLRPC Bindings for Go
Go Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
rtorrent
xmlrpc
.gitignore
.travis.yml
LICENSE
README.md
go.mod
go.sum
main.go
test.sh

README.md

go-rtorrent

GoDoc Go Report Card Build Status Coverage Status MIT license

rTorrent XMLRPC Bindings for Go (golang)

Documentation

GoDoc

Features

  • Get IP, Name, Up/Down totals
  • Get torrents within a view
  • Get torrent by hash
  • Get files for torrents
  • Set the label on a torrent
  • Add a torrent by URL or by metadata
  • Delete a torrent (including files)

Installation

To install the package, run go get github.com/mrobinsn/go-rtorrent

To use it in application, import "github.com/mrobinsn/go-rtorrent/rtorrent"

To install the command line utility, run go install "github.com/mrobinsn/go-rtorrent"

Library Usage

conn, _ := rtorrent.New("http://my-rtorrent.com/RPC2", false)
name, _ := conn.Name()
fmt.Printf("My rTorrent's name: %v", name)

You can connect to a server using Basic Authentication by including the credentials in the endpoint URL:

conn, _ := rtorrent.New("https://user:pass@my-rtorrent.com/RPC2", false)

Command Line Utility

A basic command line utility is included

go-rtorrent

NAME:
   rTorrent XMLRPC CLI - A new cli application

USAGE:
   go-rtorrent [global options] command [command options] [arguments...]

VERSION:
   1.0.0

AUTHOR(S):
   Michael Robinson <m@michaelrobinson.io>

COMMANDS:
   get-ip    retrieves the IP for this rTorrent instance
   get-name    retrieves the name for this rTorrent instance
   get-totals    retrieves the up/down totals for this rTorrent instance
   get-torrents    retrieves the torrents from this rTorrent instance
   get-files    retrieves the files for a specific torrent
   help, h    Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --endpoint "http://myrtorrent/RPC2"    rTorrent endpoint
   --disable-cert-check            disable certificate checking on this endpoint, useful for testing
   --help, -h                show help
   --version, -v            print the version

Contributing

Pull requests are welcome, please ensure you add relevant tests for any new/changed functionality.

You can’t perform that action at this time.