amfora/README.md

Amfora

Image modified from: amphora by Alvaro Cabrera from the Noun Project

Recording of v1.0.0

Amfora aims to be the best looking Gemini client with the most features... all in the terminal. It does not support Gopher or other non-Web protocols - check out Bombadillo for that.

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. Use Windows Terminal instead, and make sure it works with UTF-8. Note that some of the application colors might not display correctly on Windows, but all functionality will still work.

It fully passes Sean Conman's client torture test, as well as the Egsam one.

Installation

Binary

Download a binary from the releases page. On Unix-based systems you will have to make the file executable with chmod +x <filename>. You can rename the file to just amfora for easy access, and move it to /usr/local/bin/.

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:

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

Make sure to click "Watch" in the top right, then "Custom" > "Releases" to get notified about new releases!

Arch Linux

Arch Linux users can install Amfora using pacman.

sudo pacman -S amfora

Homebrew

If you use Homebrew, you can install Amfora through the my personal tap.

brew tap makeworld-the-better-one/tap
brew install amfora

You can update it with:

brew upgrade amfora

KISS Linux

KISS Linux users can install Amfora from jedahan's repository.

Add jedahan's kiss repository:

git clone https://github.com/jedahan/kiss-repo.git repo-jedahan
export KISS_PATH="$KISS_PATH:$PWD/repo-jedahan"

Build and install Amfora:

kiss build amfora
kiss install amfora

From Source

This section is for advanced users who want to install the latest (possibly unstable) version of Amfora.

Click to expand

Requirements:

• Go 1.13 or later
• GNU Make

Please note the Makefile does not intend to support Windows, and so there may be issues.

git clone https://github.com/makeworld-the-better-one/amfora
cd amfora
# git checkout v1.2.3 # Optionally pin to a specific version instead of the latest commit
make # Might be gmake on macOS
sudo make install # If you want to install the binary for all users

Because you installed with the Makefile, running amfora -v will tell you exactly what commit the binary was built from.

Arch Linux users can also install the latest commit of Amfora from the AUR. It has the package name amfora-git, and is maintained by @lovetocode999

yay -S amfora-git

MacOS users can also use Homebrew to install the latest commit of Amfora:

brew tap makeworld-the-better-one/tap
brew install --HEAD amfora

You can update it with:

brew upgrade --fetch-HEAD amfora

Features / Roadmap

Features in italics are in the master branch, but not in the latest release.

• URL browsing with TOFU and error handling
• Tabbed browsing
• Support ANSI color codes on pages, even for Windows
• Styled page content (headings, links)
• Basic forward/backward history, for each tab
• Input (Status Code 10 & 11)
• Multiple charset support (over 55)
• Built-in search (uses GUS by default)
• Bookmarks
• Download pages and arbitrary data
• Theming
  • Check out the user contributed themes!
• Emoji favicons
  • See gemini://mozz.us/files/rfc_gemini_favicon.gmi for details
  • Disabled by default, enable in config
• Proxying
  • Schemes like Gopher or HTTP can be proxied through a Gemini server
• Client certificate support
  • Full client certificate UX within the client
    • Create transient and permanent certs within the client, per domain
    • Manage and browse them
    • Similar to Kristall
    • https://lists.orbitalfox.eu/archives/gemini/2020/001400.html
• Subscriptions
  • Subscribing to RSS, Atom, and JSON Feeds are all supported
  • So is subscribing to a page, to know when it changes
• Open non-text files in another application
  • Allow piping/streaming content instead of downloading it first
• Stream support
• Table of contents for pages
• Search in pages with Ctrl-F
• Support Markdown rendering
• Persistent history

Usage & Configuration

Please see the wiki for an introduction on how to use Amfora and configure it.

Known Bugs

• Pasting on Windows is truncated, the full paste content won't be added. (#43)

You can also check out all the issues with the bug label.

Libraries

Amfora ❤️ open source!

• cview for the TUI
  • It's a fork of tview with PRs merged and active support
  • It uses tcell for low level terminal operations
• Viper for configuration and TOFU storing
• go-gemini, my forked and updated Gemini client/server library
• My progressbar fork - pull request here
• go-humanize
• My gofeed fork - pull request here

License

This project is licensed under the GPL v3.0. See the LICENSE file for details.