haxy

<p align="center">
<code>                                             
░██    ░██     ░████    ░██    ░██ ░██    ░██
░██    ░██    ░██ ░██    ░██  ░██   ░██  ░██ 
░██    ░██   ░██   ░██    ░█████     ░█████  
░█████████  ░█████████     ░███       ░███   
░██    ░██ ░██      ░██    ░████      ░██    
░██    ░██ ░██      ░██   ░██ ░██     ░██    
░██    ░██ ░██      ░██  ░██   ░██    ░██    
                                             </code></p>

**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:

<p align="center">
<a href="https://raw.githubusercontent.com/xit-vcs/haxy/refs/heads/master/docs/screenshots/terminal.avif"><img src="docs/screenshots/terminal.avif" width="49%" /></a>
<a href="https://raw.githubusercontent.com/xit-vcs/haxy/refs/heads/master/docs/screenshots/web.avif"><img src="docs/screenshots/web.avif" width="49%" /></a>
</p>

## Why another git forge?

Haxy is based around two design ideas:

### 1. Store project metadata (issues, patches, and discussions) in the repo

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](docs/event.md) about the event system.

### 2. Provide a TUI that is served over SSH, in addition to a web UI

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](docs/tui.md)