mirror of https://github.com/xvxx/phetch
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.
77 lines
2.3 KiB
Markdown
77 lines
2.3 KiB
Markdown
<p align="center">
|
|
<img src="./img/logo.png">
|
|
<br> <br>
|
|
<a href="LICENSE">
|
|
<img src="https://img.shields.io/badge/license-MIT-blueviolet?style=flat-square">
|
|
</a>
|
|
<a href="https://github.com/dvkt/phetch/releases/tag/v0.0.0">
|
|
<img src="https://img.shields.io/badge/current_release-0.0.0-brightgreen.svg?style=flat-square">
|
|
</a>
|
|
<a href="https://github.com/dvkt/phetch">
|
|
<img src="https://img.shields.io/badge/dev_version-0.1.0--dev-lightgrey.svg?style=flat-square">
|
|
</a>
|
|
</p>
|
|
|
|
`phetch` is a terminal gopher client designed for quick keyboard navigation. It is the spiritual successor to [GILD](https://github.com/dvkt/gild).
|
|
|
|
**features:**
|
|
|
|
- small (<1MB) executable for linux and mac
|
|
- technicolor design
|
|
- no nonsense keyboard navigation
|
|
|
|
## usage
|
|
|
|
phetch <gopher-url> # Show Gopherhole at URL
|
|
phetch -r <gopher-url> # Print raw Gopher response.
|
|
phetch -h # Show this screen.
|
|
phetch -v # Show phetch version.
|
|
|
|
Once you've launched `phetch`, use `Ctrl-H` to view the on-line help.
|
|
|
|
## installation
|
|
|
|
Binaries for Linux and Mac are available at https://github.com/dvkt/phetch/releases:
|
|
|
|
- MacOS: https://github.com/dvkt/phetch/releases/download/v0.1.0/phetch-macos.zip
|
|
- Linux x86_64: https://github.com/dvkt/phetch/releases/download/v0.1.0/phetch-linux-x86-64.tar.gz
|
|
- Linux ARM: https://github.com/dvkt/phetch/releases/download/v0.1.0/phetch-linux-arm.tar.gz
|
|
|
|
Just unzip/untar the `phetch` program into your $PATH and get going!
|
|
|
|
## development
|
|
|
|
cargo run -- <gopher-url>
|
|
|
|
## resources
|
|
|
|
- [rfc 1346](https://tools.ietf.org/html/rfc1436)
|
|
- http://ascii-table.com/ansi-escape-sequences.php
|
|
- http://www.lihaoyi.com/post/BuildyourownCommandLinewithANSIescapecodes.html
|
|
|
|
## todo
|
|
|
|
### basics
|
|
- [ ] download to ~/Downloads
|
|
gopher://zaibatsu.circumlunar.space/1/~cardboard64/
|
|
- [ ] `?` to show all keyboard shortcuts
|
|
- [ ] save history to file
|
|
- [ ] load history from file
|
|
- [ ] load most recent URL when opening without args
|
|
- [ ] ipv6
|
|
### bonus
|
|
- [ ] TLS
|
|
- [ ] fuzzy find search links
|
|
- https://github.com/stewart/rff
|
|
- https://github.com/Schlechtwetterfront/fuzzy-rs
|
|
- [ ] detect SIGWINCH
|
|
- https://github.com/BurntSushi/chan-signal
|
|
|
|
## screenies
|
|
|
|
![Links](./img/links.png)
|
|
|
|
![DOS Menu](./img/menu.png)
|
|
|
|
![Game Archive](./img/oldies.png)
|