Skip to content

davep/rogallo

Repository files navigation

Rogallo

Rogallo

GitHub Actions Workflow Status GitHub commits since latest release GitHub Issues or Pull Requests GitHub Release Date PyPI - License PyPI - Python Version PyPI - Version

Introduction

Rogallo is a terminal-based client for the Gemini Protocol. As of the time of writing it should be considered to be very early alpha-quality software. What features it has work well, but it is lacking a good number of features. It is in early active development.

Important

This means, until it hits v1.0.0, any given update might be very different or might break things from the previous update. If you decide to try it out, please keep this in mind.

Installing

pipx

The application can be installed using pipx:

pipx install rogallo

uv

The application can be installed using uv:

uv tool install rogallo

If you don't have uv installed you can use uvx.sh to perform the installation. For GNU/Linux or macOS or similar:

curl -LsSf uvx.sh/rogallo/install.sh | sh

or on Windows:

powershell -ExecutionPolicy ByPass -c "irm https://uvx.sh/rogallo/install.ps1 | iex"

Once installed run the rogallo command.

File locations

Rogallo stores files in an rogallo directory within both $XDG_DATA_HOME and $XDG_CONFIG_HOME. If you wish to fully remove anything to do with Rogallo you will need to remove those directories too.

Expanding for the common locations, the files normally created are:

  • ~/.config/rogallo/configuration.json -- The configuration file.
  • ~/.local/share/rogallo/* -- The locally-held data.

Getting help

If you need help, or have any ideas, please feel free to raise an issue or start a discussion.

TODO

See the TODO tag in issues to see what I'm planning.