golift / nzbget

Go Library to interact with NZBGet API

NZBGet Go Module

Full-featured Go Library to interact with NZBGet's JSON RPC interface. See exposed methods below.

If you'd like new features, please open a GitHub issue or pull request.

Examples

Simple example to print some logs.

package main

import (
	"fmt"

	"golift.io/nzbget"
)

func main() {
	nzb := nzbget.New(&nzbget.Config{
		URL:  "http://nzbget.server.io:6789/",
		User: "userName",
		Pass: "passWord",
	})

	events, err := nzb.Log(0, 100)
	if err != nil {
		panic(err)
	}

	nzbVer, err := nzb.Version()
	if err != nil {
		panic(err)
	}

	fmt.Println("NZBGet Version: ", nzbVer)

	for _, event := range events {
		fmt.Println(event.ID, event.Kind, event.Time, event.Text)
	}
}
// Output:
// NZBGet Version:  21.1
// 47 INFO 2022-06-27 01:42:19 -0700 PDT Renaming 0b710bf619488ca0a1b5f83f53fde577.15 to eQ7Aq0DBEhHGCgSXy3PZ.part16.rar
// 103 INFO 2022-06-27 01:42:23 -0700 PDT Unrar: Extracting from eQ7Aq0DBEhHGCgSXy3PZ.part28.rar
// 104 INFO 2022-06-27 01:42:24 -0700 PDT Unrar: All OK
// 105 INFO 2022-06-27 01:42:24 -0700 PDT Deleting archive files
// 106 INFO 2022-06-27 01:42:24 -0700 PDT Deleting file eQ7Aq0DBEhHGCgSXy3PZ.part21.rar

Methods

Official NZBGet API reference can be found here.

All of these methods are exposed.

Program Control

• version
• shutdown
• reload

Queue and History

• listgroups
• listfiles
• history
• append
• editqueue
• scan

Status, Logging and Statistics

• status
• log
• writelog
• loadlog
• servervolumes
• resetservervolume

Pause and Speed Limit

• rate
• pausedownload
• resumedownload
• pausepost
• resumepost
• pausescan
• resumescan
• scheduleresume

Configuration

• config
• loadconfig
• saveconfig
• configtemplates

nzbget's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update actions/checkout digest to 0ad4b8f
• Update actions/setup-go action to v5
• Update golangci/golangci-lint-action action to v5
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

github-actions

.github/workflows/codetests.yml

• actions/setup-go v4
• actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
• golangci/golangci-lint-action v3
• actions/setup-go v4
• actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
• golangci/golangci-lint-action v3

gomod

go.mod

• go 1.18
• github.com/gorilla/rpc v1.2.1

---

• Check this box to trigger a request for Renovate to run again on this repository

PPParameters not working when adding an nzb file

First of all, thank you for providing this great library. I needed something to interact with NZBGet, and it saved me some time today.

I'm currently facing an issue; perhaps I'm making a mistake somewhere, or there might be a bug in the code.
My intention was to configure certain post-processing parameters, but for some reason, they are being ignored.
I tried the example Python snippet from https://nzbget.net/api/append, and it worked successfully.

Here's an example of the code I'm using:

package main

import (
	"encoding/base64"
	"fmt"
	"golift.io/nzbget"
	"os"
	"path/filepath"
)

func main() {
	nzbFile := "test.nzb"
	nzbContent, err := os.ReadFile(nzbFile)
	if err != nil {
		panic(err)
	}

	nzb := nzbget.New(&nzbget.Config{
		URL: "http://localhost:6789/",
		User: "userName",
		Pass: "passWord",
	})

	fmt.Println(nzb.Version())

	input := &nzbget.AppendInput{
		Filename:  filepath.Base(nzbFile),
		Content:   base64.StdEncoding.EncodeToString(nzbContent),
		AddToTop:  false,
		AddPaused: true,
		DupeMode:  "SCORE",
		Parameters: []*nzbget.Parameter{
			{Name: "*unpack:", Value: "no"},
		},
	}

	ret, err := nzb.Append(input)
	if err != nil {
		panic(err)
	}

	fmt.Printf("Return Code: %d\n", ret)
}