All Projects → scttcper → deluge

scttcper / deluge

Licence: MIT License
Deluge API wrapper

Programming Languages

typescript
32286 projects

Projects that are alternatives of or similar to deluge

Deluge-Dark
A dark skin for Deluge WebUI to use with Organizr
Stars: ✭ 41 (+173.33%)
Mutual labels:  deluge, deluge-web
tdpt
Torrent downloading progress on Telegram
Stars: ✭ 32 (+113.33%)
Mutual labels:  deluge
Deluge Webapi
Plugin for Deluge WebUI providing sane JSON API
Stars: ✭ 90 (+500%)
Mutual labels:  deluge
Gooby
Gooby: The ultimate infinite Plex media server using a VPS and Cloud service
Stars: ✭ 230 (+1433.33%)
Mutual labels:  deluge
Deluge Streaming
Streaming plugin for deluge, making it possible to read torrents and download required parts on-demand.
Stars: ✭ 119 (+693.33%)
Mutual labels:  deluge
Katastrophe
Command Line Tool to download torrents
Stars: ✭ 85 (+466.67%)
Mutual labels:  deluge
Muximux
A lightweight way to manage your HTPC
Stars: ✭ 1,008 (+6620%)
Mutual labels:  deluge
sherpa
a mini-package-manager for QNAP NAS
Stars: ✭ 63 (+320%)
Mutual labels:  deluge
seedbox-from-scratch
The Dockered Seedbox From Scratch Mod 2 Script
Stars: ✭ 14 (-6.67%)
Mutual labels:  deluge
Thoradia
Thoradia Add-ons Repository
Stars: ✭ 208 (+1286.67%)
Mutual labels:  deluge
Htpc Docker Standup
A simple docker-compose based configuration to stand up a new HTPC w/ Plex, Deluge, Sonarr, Radarr and more!
Stars: ✭ 160 (+966.67%)
Mutual labels:  deluge
Unpackerr
Extracts downloads for Radarr, Sonarr, Lidarr - Deletes extracted files after import
Stars: ✭ 122 (+713.33%)
Mutual labels:  deluge
Plexguide.com
Welcome to https://PlexGuide.com ~ Rapidly deploy multiple-hasty Docker Containers through Ansible with local or Unlimited Google HD Space!
Stars: ✭ 1,631 (+10773.33%)
Mutual labels:  deluge
Deluge Filebottool
A plugin to integrate simple FileBot functionality into Deluge
Stars: ✭ 98 (+553.33%)
Mutual labels:  deluge
iFeral
A script for shared seedbox without root access.
Stars: ✭ 60 (+300%)
Mutual labels:  deluge
Torrt
Automates torrent updates for you
Stars: ✭ 73 (+386.67%)
Mutual labels:  deluge
deluge-uTorrentImport
cross platform Deluge Plugin for importing torrents from uTorrent
Stars: ✭ 74 (+393.33%)
Mutual labels:  deluge
mediastack
All in one Docker Compose media server
Stars: ✭ 42 (+180%)
Mutual labels:  deluge
swerpbox
SwerpBox, a seedbox and Media Center combined with the power of 🐳 Docker.
Stars: ✭ 57 (+280%)
Mutual labels:  deluge
deluge-updatorr
Deluge plugin for automatic torrents updates
Stars: ✭ 19 (+26.67%)
Mutual labels:  deluge

deluge npm CircleCI coverage status

TypeScript api wrapper for deluge using got

Install

npm install @ctrl/deluge

Use

import { Deluge } from '@ctrl/deluge';

const client = new Deluge({
  baseUrl: 'http://localhost:8112/',
  password: 'deluge',
});

async function main() {
  const res = await client.getAllData();
  console.log(res);
}

API

Docs: https://deluge.vercel.app

Normalized API

These functions have been normalized between torrent clients. Can easily support multiple torrent clients. See below for alternative supported torrent clients

getAllData

Returns all torrent data and an array of label objects. Data has been normalized and does not match the output of native listTorrents().

const data = await client.getAllData();
console.log(data.torrents);
getTorrent

Returns one torrent data

const data = await client.getTorrent();
console.log(data);
pauseTorrent and resumeTorrent

Pause or resume a torrent

const paused = await client.pauseTorrent();
console.log(paused);
const resumed = await client.resumeTorrent();
console.log(resumed);
removeTorrent

Remove a torrent. Does not remove data on disk by default.

// does not remove data on disk
const result = await client.removeTorrent('torrent_id', false);
console.log(result);

// remove data on disk
const res = await client.removeTorrent('torrent_id', true);
console.log(res);

See Also

transmission - https://github.com/scttcper/transmission
qbittorrent - https://github.com/scttcper/qbittorrent
utorrent - https://github.com/scttcper/utorrent
rtorrent - https://github.com/scttcper/rtorrent

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].