search

makew0rld / amfora

A fancy terminal browser for the Gemini protocol.
GNU General Public License v3.0
1.14k stars 68 forks source link
browser gemini gemini-protocol go golang terminal tui

readme

Amfora

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

go reportcard license GPLv3

Demo GIF

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.

Project Status

Amfora is in maintenance mode. When possible, I’ll make/merge bug fixes, and maybe slowly merge feature PRs by others. See my blog post for details.

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!

Linux

Packaging status

Amfora is packaged in many Linux distros. It's also on Scoop for Windows users.

macOS (Homebrew)

If you use Homebrew, you can install Amfora with:

brew install amfora

You can update it with:

brew upgrade amfora

macOS (MacPorts)

On macOS, Amfora can also be installed through MacPorts:

sudo port install amfora

You can update it with:

sudo port selfupdate
sudo port upgrade amfora

NOTE: this installation source is community-maintained. More information here.

Termux

If you're using Termux on Android you can't just run Amfora like normal. After installing Amfora, run pkg install proot. Then run termux-chroot before running the Amfora binary. You can exit out of the chroot after closing Amfora. See here for why this is needed.

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.15 or later - GNU Make Please note the Makefile does not intend to support Windows, and so there may be issues. ```shell 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](https://brew.sh/) to install the latest commit of Amfora: ``` 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.

Usage & Configuration

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

Libraries

Amfora ❤️ open source!

License

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