| .cargo | ||
| .github/workflows | ||
| benches | ||
| doc | ||
| img | ||
| src | ||
| .gitignore | ||
| build.rs | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| Cross.toml | ||
| LICENSE | ||
| Makefile | ||
| 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
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
If you already have a Gopher client, download phetch here:
gopher://phkt.io/1/phetch/latest
On macOS you can install with Homebrew:
brew install xvxx/code/phetch
On Arch Linux, install phetch with your favorite AUR helper:
yay 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 if you have cargo,
make, and the other dependencies described in the next section:
git clone https://github.com/xvxx/phetch
cd phetch
env PREFIX=/usr/local make install
development
To build with TLS support on Linux, you need openssl and
pkg-config:
sudo apt install -y pkg-config libssl-dev
Regular development uses cargo:
cargo run -- <gopher-url>
Pro-tip: Run a local gopher server (like phd) on 0.0.0.0:7070
and start phetch with -l or --local to quickly connect to it.
Useful for debugging!
phetch builds with TLS and Tor support by default. To disable these
features, or to enable only one of them, use the
--no-default-features flag:
cargo build --no-default-features
You can check whether TLS is enabled by visiting the About page:
cargo run --no-default-features -- gopher://phetch/about
To enable just TLS support, or just Tor support, use --features:
cargo run --no-default-features --features tor -- gopher://phetch/about
media player support
phetch includes experimental support for opening video files (; item
type) and sound files (s item type) in mpv. To test it out,
compile phetch using the --features media flag and then visit a
compatible Gopher server (maybe one using gophor?). Or check out the
"gopher types" help page by pressing ctrl-h then 3 in phetch:
cargo run --features media gopher://phetch/1/help/types
todo
- ctrl-c in load() not yet implemented
bugs
- telnet IO seems broken after raw_input change (
1146f42)
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