You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
phetch/README.md

100 lines
2.9 KiB
Markdown

4 years ago
<!--
4 years ago
/ / /
___ (___ ___ (___ ___ (___
4 years ago
| )| )|___)| | | )
4 years ago
|__/ | / |__ |__ |__ | /
|
4 years ago
--> <p align="center"> <img src="./img/logo.png"> </p>
4 years ago
4 years ago
`phetch` is a terminal client designed to help you quickly navigate
the gophersphere.
5 years ago
4 years ago
## features
5 years ago
4 years ago
- <1MB executable for linux and mac
- technicolor design (based on [GILD](https://github.com/dvkt/gild))
4 years ago
- no-nonsense keyboard navigation
- supports gopher searches, text and menu pages, and downloads
- save your favorite gopherholes with bookmarks
4 years ago
- opt-in history
5 years ago
4 years ago
## usage
4 years ago
phetch launch and show start page
phetch <gopher-url> open gopher url
4 years ago
phetch -r, --raw <gopher-url> print raw gopher response
phetch -l, --local connect to 127.0.0.1:7070
4 years ago
phetch -h, --help show this screen
phetch -v, --version show phetch version
4 years ago
once you've launched phetch, use `ctrl-h` to view the on-line help.
4 years ago
## installation
4 years ago
binaries for linux, mac, and raspberry pi are available
at https://github.com/dvkt/phetch/releases:
4 years ago
- [phetch-v0.1.10-linux-x86_64.tar.gz][0]
- [phetch-v0.1.10-linux-armv7.tar.gz (RPi)][1]
- [phetch-v0.1.10-macos.zip][2]
4 years ago
just unzip/untar the `phetch` program into your $PATH and get going!
4 years ago
## updates
to check for new versions of `phetch`, you can use the on-line help
system (`ctrl-h`) or visit:
gopher://phkt.io/1/phetch/latest
5 years ago
## development
5 years ago
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.
4 years ago
## screenies
4 years ago
![DOS Archive](./img/dos.png)
4 years ago
![Menu View](./img/menu-view.png)
4 years ago
![Text View](./img/text-view.png)
4 years ago
## todo
4 years ago
4 years ago
- [ ] fork+exec telnet: gopher://bitreich.org/1/lawn/bbs
4 years ago
- [ ] TLS -- https://dataswamp.org/~solene/2019-03-07-gopher-server-tls.html
- [ ] ~/.config/phetch/phetch.conf
## bugs
- [ ] gopher://1436.ninja/1/twit.cgi ("iWritten and performed by
Nathaniel" weirdness) (kitty only)
- [ ] gopherpedia 'recent entries' weirdness (also kitty only)
4 years ago
- [ ] "stream did not contain valid UTF-8" sdf.org/maps/
4 years ago
- [ ] ctrl-z (suspend) doesn't work
4 years ago
- [ ] gopher://alexschroeder.ch/2020-01-02_This_Gopher_Hole/menu
4 years ago
4 years ago
## v1.0
4 years ago
4 years ago
- [ ] check for updates over gopher
4 years ago
- [ ] Changelog generation (for gopher and github)
4 years ago
- [ ] GIF screencast
4 years ago
- [ ] man page (small one)
4 years ago
## future features
4 years ago
- [ ] track binary size per release
4 years ago
- [ ] text views are menus when URLs are present (one per line max)
- [ ] Find Text in Text views
4 years ago
- [ ] fuzzy find incremental search
- [ ] persistent history
- [ ] bookmarks: toggle instead of just prepending to the file
- [ ] bookmarks: save the title of the current page
[0]: https://github.com/dvkt/phetch/releases/download/v0.1.10/phetch-v0.1.10-linux-x86_64.tar.gz
[1]: https://github.com/dvkt/phetch/releases/download/v0.1.10/phetch-v0.1.10-linux-armv7.tar.gz
[2]: https://github.com/dvkt/phetch/releases/download/v0.1.10/phetch-v0.1.10-macos.zip