xit

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

You're looking at xit, a version control system. It's pronounced like "zit" (or "shit" if you prefer). You can use it from the command line, or you can use it as a library like [Haxy](https://github.com/xit-vcs/haxy) does. Here are the main features:

* git compatible
  * uses the git networking protocol for push/fetch/clone
  * supports http, ssh, raw git protocol, and local remotes
  * [read more](docs/compat.md) about git compatibility
* combine snapshot-based and patch-based version control
  * merging and cherry-picking uses patches like Darcs and Pijul
  * restoring files and anything sent over the network uses snapshots like git
  * [read more](docs/patch.md) about snapshots vs patches
* built-in TUI
  * launch `xit` in the repo without any arguments to see the TUI
  * currently shows log, status, config, and undo
  * [read more](docs/tui.md) about the TUI
* store large/binary files efficiently
  * uses a modern chunking algorithm (FastCDC) to deltify large files
  * doesn't compress files that don't benefit from it
  * [read more](docs/chunk.md) about chunking
* universal undo
  * any change to the repo can be cleanly undone from the TUI
  * clear undo history to recover space with `xit gc`
  * [read more](docs/db.md) about the immutable database
* clean implementation
  * uses *no* third-party libraries in production...all bugs are our bugs
  * can be easily used as a library in other projects
  * contains a reuseable git implementation in pure Zig
  * [read more](docs/lib.md) about xit's internals and using xit as a library

To get started, install zig 0.17.0. In this repo, run `zig build` and you'll find the binary at `zig-out/bin/xit`. The CLI is similar to git:

```
xit init test
cd test
echo hello > readme.md
xit add readme.md
xit commit -m "hello world"
```

Yeah, that's pretty boring stuff. You can also create branches and perform merges:

```
xit branch add stuff
xit branch list
xit switch stuff
echo goodbye > readme.md
xit add readme.md
xit commit -m "goodbye world"
xit switch master
xit merge stuff
```

There are also networking commands. You can clone, fetch, and push with git remotes over HTTP and SSH. Here's what a clone and push look like:

```
xit clone https://github.com/xit-vcs/xitstarter myrepo
cd myrepo

echo hello > readme.md
xit add readme.md
xit commit -m "test commit"
xit push origin master
```

I still need to implement `pull` but for now you can combine `fetch` and `merge` to get the same effect:

```
xit fetch origin
xit merge refs/remotes/origin/master
```

Converting to/from git repos is easy using local remotes:

```
# convert from git to xit
xit clone path/to/git/repo path/to/xit/repo

# convert from xit to git
git init -b master path/to/git/repo
xit