Skip to main content

TUI and CLI client for the Transmission daemon

Project description

stig is a TUI (text user interface) and CLI (command line interface) client for the BitTorrent client Transmission.

image0

Features

  • Use filters to list/start/stop/remove/… torrents matching any combination of criteria

  • Tabs with different lists, documentation, etc

  • Everything is done via commands, and they are invoked

    • through single- or multi-key (think emacs) keybindings,

    • by entering them in a command prompt (think vi),

    • by providing them as CLI arguments in your interactive shell or in scripts,

    • or by listing them in an rc file.

  • Support for themes with 16 and 256 colors

  • Complete built-in documentation with help command

  • Full API abstraction layer makes it possible to add support for other BitTorrent clients with RPC interfaces

Examples

Add two torrents (file and hash) and exit

$ stig add /path/to/some.torrent d4d6b73851fe3288e40389a8e1fb98124a9b9ba5

Connect to non-default host and present the TUI

$ stig set srv.url torrents.local:1234

Print all uploading and/or downloading torrents on torrents.local and exit

$ stig set srv.url torrents.local \; ls active

List torrents with more than 50 seeds, then remove them

$ stig ls 'seeds>50'
$ stig rm 'seeds>50'

Stop/pause torrents with /foo/ in their download path and a ratio above 10

$ stig stop 'path~/foo/&ratio>10'

Open two tabs with different torrent lists:

  • slowly uploading torrents with /foo/ in their download path

  • small or well-seeded torrents, sorted by size (ascending) and number of seeds (descending)

$ stig tab ls 'path~/foo/&rate-up<10k' \; tab ls 'size<500M|seeds>=1k' --sort 'size,!seeds'

Configuration and Scripting

All configuration is done in $HOME/.config/stig/rc. Each line is a command that is called during startup. Commands given as CLI arguments are called after the rc commands.

Example $HOME/.config/stig/rc

# Host that runs Transmission daemon
set srv.url otherhost:123

# Poll every 10 seconds
set tui.poll 10

# Default columns in torrent lists
set columns.torrents name ratio rate-up rate-down

# Open a few tabs
tab ls active --sort !progress,path,!rate
tab ls paused --sort !progress --columns name,progress,ratio,size
tab ls isolated --sort tracker --columns name,path

You can have different rc files and run them either with stig -c path/to/file or by using the shebang #!/path/to/stig -Tc (-T disables the TUI, -c specifies the rc file) to turn them into executables.

Example maintenance script

#!/home/ich/.local/bin/stig -Tc
rm path=/path/to/torrents/trash
pause seeds>100
start seeds<20&size>10G|seeds<50&size>20G

Installation

The latest release can be installed from PyPI.

$ pip3 install stig

The latest development version is in the dev branch.

$ pip3 install git+https://github.com/rndusr/stig.git@dev

For Arch Linux stig is available on AUR as stig and the development version as stig-git.

Developers can either install stig with pip3 from a local path and pass the --editable option or run python3 -m stig in the project directory.

Requirements

Contributing

Development happens in the dev branch while master is the current stable release.

If you want to contribute code and get stuck, don’t know where to even begin, or just to make sure you’re not duplicating someone else’s efforts, open an issue.

License

stig is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stig-0.7.3a0.tar.gz (133.5 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page