Amfora Gemini browser - repo mirror
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
makeworld 06b649d81a Doc for #274 9 hours ago
.github Drop support for Go 1.14, update CI software 6 days ago
bookmarks Appease linter 6 days ago
cache 🐛 Capture all scrolling keys 7 months ago
client Appease linter 6 days ago
config Get recent theme changes to work when color = false 3 days ago
contrib Lint and GIF link fix 3 days ago
display Fix bad article in error message (#274) 9 hours ago
logger 🎉 Initial commit, full featured 1 year ago
renderer Fix issue from prev commit when color = true 3 days ago
rr 📝 Clarify rr licensing 8 months ago
structs 🚨 Lint fix 9 months ago
subscriptions cview update (#107) 10 months ago
sysopen Appease linter 6 days ago
webbrowser Appease linter 6 days ago
.gitignore 📝 Wiki script, link to wiki on new tab 12 months ago
.golangci.yml Appease linter 6 days ago
.goreleaser.yml 🔧 Disable automatic homebrew 1 year ago
CHANGELOG.md Doc for #274 9 hours ago
LICENSE Create LICENSE 1 year ago
Makefile 🔨 Add gen command to Makefile 8 months ago
NOTES.md Text and element colors of default theme change to be black on white terminals 3 days ago
README.md Drop support for Go 1.14, update CI software 6 days ago
THANKS.md Doc for #271 4 days ago
amfora.desktop 🐛 Removing TryExec helps get Amfora to show up 1 year ago
amfora.go Render stdin text as Gemtext (#205) (#242) 6 months ago
default-config.toml Default to using the user's terminal theme colors 4 days ago
demo-large.gif 📝 Update README with Gif 1 year ago
go.mod Text and element colors of default theme change to be black on white terminals 3 days ago
go.sum Text and element colors of default theme change to be black on white terminals 3 days ago
logo.png 🎉 Initial commit, full featured 1 year ago

README.md

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.

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.

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 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 geminispace.info by default)
  • Bookmarks
  • Download pages and arbitrary data
  • Theming
  • Proxying
    • Schemes like Gopher or HTTP can be proxied through a Gemini server
  • Client certificate support
  • 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
    • Ability to stream content instead of downloading it first
  • Stream support
  • Table of contents for pages
  • Search in pages with Ctrl-F
  • Persistent history

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.