2020-06-18 23:54:48 +03:00
# Amfora
2020-06-19 02:10:45 +03:00
< center > <!-- I know, that's not how you usually do it :) -->
2020-06-19 02:13:40 +03:00
< img src = "logo.png" alt = "amphora logo" width = "30%" >
2020-06-24 20:39:49 +03:00
< h6 > Image modified from: amphora by Alvaro Cabrera from the Noun Project< / h6 >
2020-06-19 02:10:45 +03:00
< / center >
2020-06-18 23:54:48 +03:00
2020-06-19 00:23:54 +03:00
[](https://goreportcard.com/report/github.com/makeworld-the-better-one/amfora)
[](https://www.gnu.org/licenses/gpl-3.0.en.html)
2020-06-19 02:10:45 +03:00
< center > <!-- I know, that's not how you usually do it :) -->
2020-06-19 02:13:40 +03:00
< a href = "https://raw.githubusercontent.com/makeworld-the-better-one/amfora/master/demo-large.gif" >
2020-06-19 02:10:45 +03:00
< img src = "demo-large.gif" alt = "Demo GIF" width = "80%" >
2020-06-19 02:13:40 +03:00
< / a >
2020-06-19 02:10:45 +03:00
< / center >
2020-06-24 18:37:32 +03:00
###### Recording of v1.0.0
2020-06-19 00:23:54 +03:00
Amfora aims to be the best looking [Gemini ](https://gemini.circumlunar.space/ ) client with the most features... all in the terminal. It does not support Gopher or other non-Web protocols - check out [Bombadillo ](http://bombadillo.colorfield.space/ ) for that.
2020-06-27 23:41:13 +03:00
It also aims to be completely cross platform, with full Windows support. If you're on Windows, I would not recommend using the default terminal software. Maybe use [Cmder ](https://cmder.net/ ) instead. Note that some of the application colors will not display correctly on most Windows terminals, but all functionality will still work.
2020-06-18 23:54:48 +03:00
2020-06-21 00:17:34 +03:00
It fully passes Sean Conman's client torture test, including the new Unicode tests. It mostly passes the Egsam test.
2020-06-18 23:54:48 +03:00
2020-06-19 02:25:08 +03:00
## Installation
2020-07-02 07:13:32 +03:00
Download a binary from the [releases ](https://github.com/makeworld-the-better-one/amfora/releases ) page. On Unix-based systems you might have to make the file executable with `chmod +x <filename>` . You should also move the binary to `/usr/local/bin/` .
2020-06-22 02:37:23 +03:00
2020-06-27 23:41:13 +03:00
On Windows, make sure you click "Advanced > Run anyway" after double-clicking, or something like that.
Unix systems can install the desktop entry file to get Amfora to appear when they search for applications:
2020-06-22 02:37:23 +03:00
```bash
curl -sSL https://raw.githubusercontent.com/makeworld-the-better-one/amfora/master/amfora.desktop -o ~/.local/share/applications/amfora.desktop
update-desktop-database ~/.local/share/applications
```
2020-06-19 02:25:08 +03:00
2020-06-18 23:54:48 +03:00
## Usage
2020-06-22 02:48:58 +03:00
Just call `amfora` or `amfora <url>` on the terminal. On Windows it might be `amfora.exe` instead.
2020-06-18 23:54:48 +03:00
2020-06-24 18:37:32 +03:00
To determine the version, you can run `amfora --version` or `amfora -v` .
2020-06-18 23:54:48 +03:00
The project keeps many standard terminal keybindings and is intuitive. Press < kbd > ?< / kbd > inside the application to pull up the help menu with a list of all the keybindings, and < kbd > Esc< / kbd > to leave it. If you have used Bombadillo you will find it similar.
2020-07-02 07:13:32 +03:00
It is designed with large terminals in mind, but should look and work well at any reasonable terminal size.
It was tested with left-to-right languages, and will likely not work as well with right-to-left languages like Arabic.
2020-06-18 23:54:48 +03:00
## Features / Roadmap
2020-06-21 00:17:34 +03:00
Features in *italics* are in the master branch, but not in the latest release.
2020-06-18 23:54:48 +03:00
- [x] URL browsing with TOFU and error handling
- [x] Tabbed browsing
- [x] Support ANSI color codes on pages, even for Windows
- [x] Styled page content (headings, links)
- [x] Basic forward/backward history, for each tab
- [x] Input (Status Code 10 & 11)
2020-06-24 20:39:49 +03:00
- [x] Multiple charset support (over 55)
- [x] Built-in search (uses GUS by default)
- [x] Bookmarks
2020-06-18 23:54:48 +03:00
- [ ] Search in pages with < kbd > Ctrl-F</ kbd >
- [ ] Download pages and arbitrary data
- [ ] Emoji favicons
- See `gemini://mozz.us/files/rfc_gemini_favicon.gmi` for details
2020-07-01 20:39:13 +03:00
- [ ] Stream support
2020-06-22 06:39:33 +03:00
- [ ] Full mouse support
2020-06-18 23:54:48 +03:00
- [ ] Table of contents for pages
- [ ] Full client certificate UX within the client
2020-06-22 06:39:33 +03:00
- *I will be waiting for some spec changes/recommendations to happen before implementing this*
2020-06-18 23:54:48 +03:00
- Create transient and permanent certs within the client, per domain
- Manage and browse them
- https://lists.orbitalfox.eu/archives/gemini/2020/001400.html
- [ ] Subscribe to RSS and Atom feeds and display them
- [ ] Support Markdown rendering
2020-06-22 06:39:33 +03:00
- [ ] History browser
2020-06-18 23:54:48 +03:00
## Configuration
2020-06-22 18:56:55 +03:00
The config file is written in the intuitive [TOML ](https://github.com/toml-lang/toml ) file format. See [default-config.toml ](./default-config.toml ) for details. By default this file is available at `~/.config/amfora/config.toml` , or `$XDG_CONFIG_HOME/amfora/config.toml` , if that variable is set.
2020-06-18 23:54:48 +03:00
On Windows, the file is in `%APPDATA%\amfora\config.toml` , which usually expands to `C:\Users\<username>\AppData\Roaming\amfora\config.toml` .
## Libraries
Amfora ❤️ open source!
- [cview ](https://gitlab.com/tslocum/cview/ ) for the TUI
- It's a fork of [tview ](https://github.com/rivo/tview ) with PRs merged and active support
- It uses [tcell ](https://github.com/gdamore/tcell ) for low level terminal operations
- [Viper ](https://github.com/spf13/viper ) for configuration and TOFU storing
- [go-gemini ](https://github.com/makeworld-the-better-one/go-gemini ), my forked and updated Gemini client/server library
## License
This project is licensed under the GPL v3.0. See the [LICENSE ](./LICENSE ) file for details.
