LinuxCommandLibrary

deluge-console

Manage Deluge torrent client from command line

TLDR

Start the interactive console interface

$ deluge-console
copy

Connect to a Deluge daemon instance
$ connect [hostname]:[port]
copy

Add a torrent to the daemon
$ add [url|magnet|path/to/file]
copy

Display information about all torrents
$ info
copy

Display information about a specific torrent
$ info [torrent_id]
copy

Pause a torrent
$ pause [torrent_id]
copy

Resume a torrent
$ resume [torrent_id]
copy

Remove a torrent from the daemon
$ rm [torrent_id]
copy

SYNOPSIS

deluge-console [OPTIONS] [COMMANDS]

PARAMETERS

-h, --help
    Show program's help message and exit.

-v, --version
    Show program's version number and exit.

-L LEVEL, --loglevel LEVEL
    Set the log level (e.g., debug, info, warning, error, critical).

-c PATH, --config PATH
    Set the configuration directory for Deluge.

-d DAEMON_HOST, --daemon DAEMON_HOST
    Connect to a specific Deluge daemon. Format: [user:pass@]host:port.

-H HOST, --host HOST
    Connect to the Deluge daemon on the specified host.

-p PORT, --port PORT
    Connect to the Deluge daemon on the specified port.

-u USERNAME, --username USERNAME
    Username for daemon authentication.

-P PASSWORD, --password PASSWORD
    Password for daemon authentication (use with caution, especially in scripts, as it's visible).

--skip-config
    Do not load Deluge configuration files on startup.

--skip-plugins
    Do not load any plugins on startup.

DESCRIPTION

deluge-console is the command-line interface (CLI) client for the
Deluge BitTorrent application. It allows users to interact with a
running Deluge daemon (deluged) to manage torrents, configure
settings, and monitor status without a graphical user interface.
This makes it ideal for remote administration, scripting, and
server environments where a GUI is not available or desired.
Users can add new torrents, pause/resume downloads, remove
torrents, view detailed information, and change various client
and daemon configurations.

CAVEATS

deluge-console requires a running Deluge daemon (deluged) to connect to.
Without a daemon, it cannot perform any torrent management operations.
Authentication is necessary if the daemon is configured with a password.
While powerful for scripting, not all nuanced features of the GUI client
are directly exposed or as easily managed via the console.

INTERACTIVE VS. NON-INTERACTIVE USE

When run without arguments, deluge-console enters an interactive
shell where users can type commands directly. It can also be used
non-interactively by piping commands or by specifying commands
after the initial options, making it suitable for scripting
automation (e.g., echo "add magnet_link" | deluge-console).

CLIENT-SERVER ARCHITECTURE

deluge-console is a client that communicates with the deluged
daemon. This separation means the daemon can run on a remote server
or a headless machine, while users can connect and manage their
torrents from a local workstation using deluge-console,
deluge-web, or the GTK client.

HISTORY

Deluge, including its console client, originated in 2006,
developed in Python using the GTK+ toolkit. It was designed with a
client-server architecture from the outset, separating the core daemon
(deluged) from its various user interfaces. This modular design
naturally led to the creation of deluge-console, providing a
robust and essential tool for server management and automation from its early days.

SEE ALSO

deluged(1), deluge(1), deluge-web(1)

Copied to clipboard