Archives/phetch
2
0
Fork 0
mirror of https://github.com/xvxx/phetch synced 2024-11-05 00:00:58 +00:00
Code Issues Releases Wiki Activity
652 Commits 4 Branches 29 Tags 147 MiB
Rust 99.2%
Makefile 0.8%
8645571d7a
Go to file
chris west 8645571d7a print a plain version when no tty
2020-01-11 16:10:11 -08:00
.cargo Have the linker strip the binary (cross-compile friendly) 2020-01-11 12:38:05 -08:00
.github/workflows quiet down the action output 2019-12-30 21:17:18 -08:00
doc Add new flags to manpage 2020-01-11 15:14:38 -08:00
img fix border 2019-12-23 23:52:34 -08:00
src print a plain version when no tty 2020-01-11 16:10:11 -08:00
.gitignore debug log 2019-12-21 18:47:20 -08:00
build.rs just the date 2020-01-06 10:26:48 -08:00
Cargo.lock print a plain version when no tty 2020-01-11 16:10:11 -08:00
Cargo.toml print a plain version when no tty 2020-01-11 16:10:11 -08:00
LICENSE MIT 2019-12-17 16:49:03 -08:00
Makefile Have the linker strip the binary (cross-compile friendly) 2020-01-11 12:38:05 -08:00
README.md Add new flags to manpage 2020-01-11 15:14:38 -08:00

README.md


phetch is a terminal client designed to help you quickly navigate the gophersphere.

features

  • <1MB executable for Linux and Mac
  • Technicolor design (based on GILD)
  • No-nonsense keyboard navigation
  • Supports Gopher searches, text and menu pages, and downloads
  • Save your favorite Gopher sites with bookmarks
  • Opt-in history tracking
  • Secure Gopher support (TLS)
  • Tor support

usage

    phetch [options]          Launch phetch in interactive mode
    phetch [options] [url]    Open Gopher URL in interactive mode

Options:

    -s, --tls                 Try to open Gopher URLs securely w/ TLS
    -o, --tor                 Use local Tor proxy to open all pages
    -S, -O                    Disable TLS or Tor
                            
    -r, --raw                 Print raw Gopher response only
    -p, --print               Print rendered Gopher response only
    -l, --local               Connect to 127.0.0.1:7070

    -c, --config FILE         Use instead of ~/.config/phetch/phetch.conf
    -C, --no-config           Don't use any config file   
    
    -h, --help                Show this screen
    -v, --version             Show phetch version

Command line options always override options set in phetch.conf.

Once you've launched phetch, use `ctrl-h` to view the on-line help.

installation

On macOS you can install with Homebrew:

brew install xvxx/code/phetch

Binaries for Linux, Raspberry Pi, and Mac are available at https://github.com/xvxx/phetch/releases:

Just unzip/untar the phetch program into your $PATH and get going!

You can also build and install from source:

git clone https://github.com/xvxx/phetch
cd phetch
env PREFIX=/usr/local make install

updates

To check for new versions of phetch, use the on-line help system in the app (ctrl-h) or visit:

gopher://phkt.io/1/phetch/latest

development

cargo run -- <gopher-url>

Pro-tip: Run a local gopher server on 127.0.0.1:7070 and start phetch with -l or --local to quickly connect to it.

To build with TLS support on Linux, you need openssl and pkg-config:

sudo apt install -y pkg-config libssl-dev

To build without TLS support, build with the disable-tls feature:

cargo build --features disable-tls

You can check whether TLS is enabled by visiting the About page:

cargo run --features disable-tls -- gopher://phetch/about

screenies

DOS Archive Floodgap
DOS Archive Floodgap

bugs

  • unknown keypress: [ during status messages
  • new status doesn't replace old (download complete -> copy url)

v1.0

  • Changelog generation (for gopher and github)
  • GIF screencast

future features

  • track binary size per release
  • text views are menus when URLs are present (one per line max)
  • Find Text in Text views
  • fuzzy find incremental search
  • persistent history
  • bookmarks: toggle instead of just prepending to the file
  • bookmarks: save the title of the current page