go-transmission

November 21, 2025 · View on GitHub

Go client library for Transmission BitTorrent client RPC API.

Features

Full implementation of Transmission RPC protocol version 18 (semver 5.4.0)
All 24 RPC methods supported
Automatic CSRF protection handling
HTTP Basic Authentication support
Context-based cancellation and timeouts
Idiomatic Go API with comprehensive types

Requirements

Go 1.24 or later
Transmission 4.0+ (RPC version 17+)

Installation

go get github.com/lexfrei/go-transmission/api/transmission

Quick Start

package main

import (
    "context"
    "fmt"
    "log"

    "github.com/lexfrei/go-transmission/api/transmission"
)

func main() {
    // Create client
    client, err := transmission.New("http://localhost:9091/transmission/rpc")
    if err != nil {
        log.Fatal(err)
    }
    defer client.Close()

    ctx := context.Background()

    // Get all torrents
    result, err := client.TorrentGet(ctx, []string{"id", "name", "status", "percentDone"}, nil)
    if err != nil {
        log.Fatal(err)
    }

    for _, t := range result.Torrents {
        fmt.Printf("Torrent: %s (%.1f%%)\n", *t.Name, *t.PercentDone*100)
    }
}

Authentication

If Transmission requires authentication:

client, err := transmission.New(
    "http://localhost:9091/transmission/rpc",
    transmission.WithAuth("username", "password"),
)

Timeout

Set a custom timeout:

client, err := transmission.New(
    "http://localhost:9091/transmission/rpc",
    transmission.WithTimeout(30 * time.Second),
)

Logging

Inject a custom logger implementing the Logger interface:

// Logger interface
type Logger interface {
    Debug(msg string, fields ...Field)
    Warn(msg string, fields ...Field)
    Error(msg string, fields ...Field)
}

// Example: slog adapter
type slogAdapter struct {
    logger *slog.Logger
}

func (s *slogAdapter) Debug(msg string, fields ...transmission.Field) {
    s.logger.Debug(msg, fieldsToAttrs(fields)...)
}

func (s *slogAdapter) Warn(msg string, fields ...transmission.Field) {
    s.logger.Warn(msg, fieldsToAttrs(fields)...)
}

func (s *slogAdapter) Error(msg string, fields ...transmission.Field) {
    s.logger.Error(msg, fieldsToAttrs(fields)...)
}

// Use with client
client, err := transmission.New(
    "http://localhost:9091/transmission/rpc",
    transmission.WithLogger(&slogAdapter{logger: slog.Default()}),
)