░██ ░██ ░████ ░██ ░██ ░██ ░██
░██ ░██ ░██ ░██ ░██ ░██ ░██ ░██
░██ ░██ ░██ ░██ ░█████ ░█████
░█████████ ░█████████ ░███ ░███
░██ ░██ ░██ ░██ ░████ ░██
░██ ░██ ░██ ░██ ░██ ░██ ░██
░██ ░██ ░██ ░██ ░██ ░██ ░██
Haxy is now in preview! Try it now: https://try.haxy.net/
You're looking at Haxy, a git forge that is local-first and text-based. Haxy has a text user interface (TUI) that you can view in your terminal or on the web. Get local control of your data and hop on the TUI train!
Here's what it looks like in the terminal and on the web:
Haxy is based around two design ideas:
Keeping project metadata in the repo has a few benefits:
- You can easily replicate it to different Haxy instances.
- You can view/edit it locally and push your changes later, just like you do with code.
You can still edit this data via the UI of a Haxy instance just like any other git forge. Additionally, however, you can run the Haxy binary locally to browse a repo's issues and other metadata offline. If you have push access to the repo, you can make changes locally and push them later.
Haxy repos have a special branch called haxy/events where events are stored. Any time project metadata is created or updated, an event is created. There's one event per commit, which is stored as JSON in the commit message itself. The server consumes these events into its database when it receives them -- essentially, a form of event sourcing.
Read more about the event system.
Haxy provides a text user interface (TUI) over SSH, so you can browse the Haxy instance entirely from your terminal. These are sometimes called SSH apps. One big advantage they have is that you are automatically authenticated with your SSH key, so creating an account on a Haxy instance and associating it with your SSH public key can be done instantly.
Additionally, Haxy provides a web UI for a more typical experience in a web browser. The web UI simply renders the TUI in your browser. This sounds terrifying, but the web renderer still uses standard HTML controls. The renderer runs from a small webassembly binary, but pages are also initially server-rendered so content can be viewed even if scripts are disabled.
Read more about the TUI.
To build, install zig 0.17.0 and do zig build and you'll find the binary at zig-out/bin/haxy.
On a production server you would run this binary with the serve subcommand. Read more about self-hosting.
To run it in local mode, just run it with no subcommand in any git repo. It will show a completely offline haxy UI just for that repo.
The easiest way to try Haxy out is like this:
zig build try
This will launch a server with fake data that it stores in the temp-try directory. It will then launch the TUI directly in your terminal (you can exit by pressing escape). Additionally, you can view the web UI at http://localhost:8080.
A fun test is to push Haxy itself to the server. You can do that by running the following command, which will push it to the server using SSH:
GIT_SSH_COMMAND='ssh -p 8022 -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o IdentitiesOnly=yes -i temp-try/key' git push localhost:admin:haxy HEAD:master
After that, go to the admin user in the UI and you'll see Haxy's repo page: http://localhost:8080/admin:haxy/files/branch:master
"C'mon Alex! You always dreamt about going on a big adventure! Let this be our first!" -- Lunar: Silver Star Story