Merge pull request #5 from murtaza-u/nightly

V1.0

Author: murtaza-u

Makefile

@@ -4,7 +4,7 @@ BINDIR ?= $(PREFIX)/bin
 all: trt
 
 trt:
-	go build
+	CGO_ENABLED=1 go build
 
 install: all
 	install -d $(DESTDIR)$(BINDIR)

PKGBUILD

@@ -1,29 +1,28 @@
-# Maintainer: Murtaza Udaipurwala <murtaza.u6e24@gmail.com>
+# Maintainer: Murtaza Udaipurwala <murtaza@murtazau.xyz>
 pkgname=transmission-remote-tui-git
 _gitname=${pkgname%-git}
 pkgver=0.0
 pkgrel=1
 pkgdesc="A TUI for BitTorrent client Transmission"
 arch=('any')
-url="https://github.com/Murtaza-Udaipurwala/transmission-remote-tui"
+url="https://github.com/murtaza-u/transmission-remote-tui"
 license=('GPL3')
-depends=("transmission-cli")
-makedepends=("make" "git" "go")
+makedepends=("git" "go" "make")
 provides=("trt")
 source=("git+$url")
 md5sums=('SKIP')
 
 pkgver() {
     cd "$_gitname"
-    printf "0.0.r%s.%s" "$(git rev-list --count HEAD)" "$(git rev-parse --short HEAD)"
+    printf "0.1r%s.%s" "$(git rev-list --count HEAD)" "$(git rev-parse --short HEAD)"
 }
 
 build() {
-	cd "$_gitname"
-	make
+    cd "$_gitname"
+    make
 }
 
 package() {
-	cd "$_gitname"
+    cd "$_gitname"
     make PREFIX=/usr DESTDIR="$pkgdir" install
 }

README.md

@@ -1,72 +1,77 @@
-# Transmission Remote TUI (trt)
-> A TUI for BitTorrent client transmission
+# Transmission Remote TUI (`trt`)
 
+> A TUI for BitTorrent client transmission
 
-![torrent list](assets/torrents.png)
+![torrent list](./look/torrents.jpg)
+![files](./look/details.jpg)
 
-![peers](assets/peers.png)
+## Installation
 
-![overview](assets/overview.png)
-<figcaption align = "center"><b><sup>**</sup>Yes! I am torrenting linux/bsd iso to evade legal issues</b></figcaption>
+### Arch Linux
 
-## Installation
+* `trt` is available in the `AUR` (packaged by the developer himself)
 
-#### Arch Linux
-- `trt` is available in the AUR(packaged by the developer himself)
 ```bash
-$ yay -S transmission-remote-tui-git
+yay -S transmission-remote-tui-git
 ```
 
-#### From source
-- Build dependencies: `go`
+### From source
+
+* Build dependencies: `go`
 
 ```bash
-$ git clone https://github.com/Murtaza-Udaipurwala/transmission-remote-tui
-$ cd transmission-remote-tui
-$ make
-$ sudo make clean install
+make && sudo make install clean
 ```
 
 ## Usage
-- The actual binary is called `trt`
 
-- Transmission daemon must be running
+* The actual binary is called `trt`
+* Transmission daemon must be running
+
 ```bash
-$ transmission-daemon &
+transmission-daemon &
 ```
 
-- In case you have changed the default transmission rpc port(9091), specify the new port
+* Remote `RPC` URL
+
 ```bash
-$ trt --port <new port>
+trt --url http://203.12.65.10:9091/transmission/rpc
 ```
 
-- In case you enabled authentication, specify the username and password
+* Authenticate, if required
+
 ```bash
-$ trt --username <username> --password <password>
+trt --username <username> --password <password>
 ```
 
-- Navigation
+* Version
 
-| keybinding | Action                                      |
-|------------|---------------------------------------------|
-| h, j, k, l | move around                                 |
-| g          | scroll the to top of the page               |
-| G          | scroll the to bottom of the page            |
-| q          | quit / go back                              |
-| Q          | kill the transmission daemon                |
-| l, enter   | show more details about a torrent           |
-| K          | move torrent up the queue                   |
-| J          | move torrent down the queue                 |
-| U          | move torrent at the top of the queue        |
-| D          | move torrent at the bottom of the queue     |
-| p          | pause/start torrent                         |
-| r          | remove torrent                              |
-| R          | remove torrent and delete all the files     |
-| v          | verify torrent                              |
-| t          | ask trackers for more peers                 |
-| m          | copy magnet link to clipboard               |
-
-- Changing file's priority
+```bash
+trt --version
+```
+
+* Navigation
+
+| keybinding | Action                                             |
+|------------|----------------------------------------------------|
+| h, j, k, l | move around                                        |
+| g          | scroll to the top of the page                      |
+| G          | scroll to the bottom of the page                   |
+| q          | quit / go back                                     |
+| Q          | kill the transmission daemon                       |
+| l, enter   | show more details about a torrent                  |
+| K          | move torrent up the queue                          |
+| J          | move torrent down the queue                        |
+| U          | move torrent at the top of the queue               |
+| D          | move torrent at the bottom of the queue            |
+| p          | pause/start torrent                                |
+| r          | remove torrent                                     |
+| R          | remove torrent and delete corresponding local data |
+| v          | verify torrent                                     |
+| t          | ask trackers for more peers                        |
+| m          | copy magnet link to clipboard                      |
+
+* Changing file's priority
 
 | keybinding | Action                                      |
 |------------|---------------------------------------------|
@@ -80,57 +85,33 @@ $ trt --username <username> --password <password>
 | N          | change priority of all files to 'normal'    |
 | H          | change priority of all files to 'high'      |
 
-## Uninstalling
+## Uninstall
+
 ```bash
-$ sudo make uninstall
+sudo make uninstall
 ```
 
 ## Further reading
 
-### Setting up mimeapp entry
-- `trt` does not have the ability to read/add torrent files/magnet
-  links(however, it can be added rather easily). This is because you don't
-  really need this feature.
-
-- Simply create a mimeapp entry, telling it what to do when it finds a torrent file/magnet link
-```bash
-# File: ~/.config/mimeapps.list
-# xdg-open will use these settings to determine how to open filetypes.
-
-[Default Applications]
+* `trt` does not have the ability to read new torrent files/magnet links.
+  Use [transmission-remote](https://linux.die.net/man/1/transmission-remote)
+  for that.
 
-# These .desktop entries can also be seen and changed in ~/.local/share/applications/
-x-scheme-handler/magnet=torrent.desktop;
-application/x-bittorrent=torrent.desktop;
-```
+* Adding `mimeapp` entry
 
-- Now we must create torrent.desktop file under `~/.local/share/applications/`
 ```bash
 # File: ~/.local/share/applications/torrent.desktop
 
 [Desktop Entry]
 Type=Application
 Name=Torrent
-Exec=/usr/bin/env transadd %U
+Exec=/usr/bin/env transmission-remote -a %U
 ```
 
-- `transadd` is a shell script in my `PATH`. This is the script that tells
-  `transmission daemon` to add our torrent
 ```bash
-#!/bin/sh
-
-# Mimeapp script for adding torrent to transmission-daemon, but will also start
-# the daemon first if not running.  transmission-daemon sometimes fails to take
-# remote requests in its first moments, hence the sleep.
+# File: ~/.config/mimeapps.list
 
-pidof transmission-daemon >/dev/null || transmission-daemon &
-sleep 3
-# notify-send "🔽 Adding Torrent"
-exec transmission-remote -a "$@"
+[Default Applications]
+x-scheme-handler/magnet=torrent.desktop;
+application/x-bittorrent=torrent.desktop;
 ```
-
-[Video tutorial on setting up mimeapp entry](https://odysee.com/@Luke:7/torrenting-setup-with-transmission:1)(the TUI program used is `transmission-remote-cli` instead of `trt`)
-
-
-#### All pull requests are welcomed
-#### Open issues for discussion/bug report

assets/overview.png

@@ -2,11 +2,19 @@ package cli
 
 import "flag"
 
-func ParseArgs() (username, password, url string, port int) {
-	flag.IntVar(&port, "port", 9091, "rpc port")
-	flag.StringVar(&username, "username", "", "username")
-	flag.StringVar(&password, "password", "", "password")
-	flag.StringVar(&url, "url", "http://localhost", "rpc url")
+type Flags struct {
+	Username string
+	Password string
+	URL      string
+	Version  bool
+}
+
+const defaultURL = "http://localhost:9091/transmission/rpc"
+
+func (f *Flags) Parse() {
+	flag.StringVar(&f.URL, "url", defaultURL, "RPC url")
+	flag.StringVar(&f.Username, "username", "", "username")
+	flag.StringVar(&f.Password, "password", "", "password")
+	flag.BoolVar(&f.Version, "version", false, "version")
 	flag.Parse()
-	return
 }