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

84 lines
2.5 KiB
Markdown

5 years ago
<p align="center">
5 years ago
<img src="./phetch.png">
<br> <br>
5 years ago
<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>
5 years ago
</p>
5 years ago
5 years ago
`phetch` is a terminal gopher client designed for quick keyboard navigation. It is the spiritual successor to [GILD](https://github.com/dvkt/gild).
5 years ago
5 years ago
**features:**
5 years ago
5 years ago
- small (<1MB) executable for linux and mac
5 years ago
- technicolor design
5 years ago
- no nonsense keyboard navigation
5 years ago
## usage
5 years ago
phetch <gopher-url> # Show Gopherhole at URL
5 years ago
phetch -r <gopher-url> # Print raw Gopher response.
phetch -h # Show this screen.
phetch -v # Show phetch version.
5 years ago
5 years ago
A `<gopher-url>` should be something like:
- gopherproject.org
- gopher://txtn.ws/
- forthworks.com/1/atua
- "gopher://gopherpedia.com/0/Gascon campaign of 1345"
- "gopher://gopherpedia.com/7/lookup?computers"
- gopher://localhost:7070/1/links/gopher
5 years ago
## installation
5 years ago
Binaries for Linux and Mac are available at https://github.com/dvkt/phetch/releases:
5 years ago
5 years ago
- 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
5 years ago
5 years ago
Just unzip/untar the `phetch` program into your $PATH and get going!
5 years ago
5 years ago
## development
5 years ago
cargo run -- <gopher-url>
5 years ago
## resources
5 years ago
- [rfc 1346](https://tools.ietf.org/html/rfc1436)
5 years ago
- http://ascii-table.com/ansi-escape-sequences.php
5 years ago
- http://www.lihaoyi.com/post/BuildyourownCommandLinewithANSIescapecodes.html
5 years ago
5 years ago
## TODO
### Basics
- [ ] download to ~/Downloads
5 years ago
- [ ] `?` to show all keyboard shortcuts
5 years ago
- [ ] save history to file
- [ ] load history from file
- [ ] load most recent URL when opening without args
5 years ago
- [ ] ipv6
5 years ago
### Bonus
5 years ago
- [ ] show loading spinner during gopher request
5 years ago
- [ ] TLS
5 years ago
- [ ] fuzzy find search links
- https://github.com/stewart/rff
- https://github.com/Schlechtwetterfront/fuzzy-rs
- [ ] detect SIGWINCH
- https://github.com/BurntSushi/chan-signal
## Screenies
5 years ago
![Links](./img/links.png)
5 years ago
![DOS Menu](./img/menu.png)
5 years ago
![Game Archive](./img/oldies.png)