OXYGENHUB
# 99cdbaeea274 oxygen / README.md
4.2 KiB · Markdown · last changed Release builds for Linux, macOS and Windows 1 month ago renderedsource blame history raw
648724d8 unknown ↶ 1
# Oxygen
2
d02e545d Andy McCall ↶ 3
Oxygen (`oxy`) is a distributed, commutative version control system written in Rust for large repositories. See [docs/spec.md]docs/spec.md for the specification.
4
5
It is self-hosting: this directory is an Oxygen repository, and the project's own history is kept with `oxy`, not with Git.
6
7
## What is different
8
9
- **History is a set of changes, not a chain of snapshots.** A change records what it did to identified lines and tree nodes and which earlier changes it depends on. Changes that do not depend on each other commute, so there are no merge commits and rebasing independent work rewrites nothing.
10
- **Conflicts are data.** A conflicted state can be committed, pushed and pulled. Resolving one is an ordinary edit followed by a commit.
11
- **Every change has a stable ID and a content hash.** The ID survives rewrites; the hash makes history tamper-evident.
12
- **Everything is signed.** Composite Ed25519 + ML-DSA-65 signatures on changes and on every bookmark update, verified against a trust policy that lives in the repository.
13
- **Every operation is undoable** through an operation log.
14
- **Large files are chunked** with content-defined chunking into a BLAKE3-addressed store.
15
16
## Status
17
18
Early, but usable for its own development. Implemented: the object model, the change graph with conflict detection and resolution, the working copy (`status`, `commit`, `checkout`, `diff`, `undo`), identities and signatures, remotes over local paths and HTTP(S) with `clone`, `fetch`, `pull`, `push`, the reference server `oxy serve`, the trust policy, and packed storage.
19
20
Not yet: checkpoints for very long histories, history editing (`rebase`, `split`, `edit`), multiple workspaces, garbage collection with retention, and the Thin client profile for constrained machines.
21
25c6adfa Andy McCall ↶ 22
## Install
23
24
Builds for Linux, macOS and Windows are on the [releases page]https://oxygenhub.io/andymccall/oxygen/releases. These are early releases: the macOS and Windows builds are not signed and have had little testing.
25
26
- **Debian, Ubuntu and other Linux with apt** (x86_64 or arm64): download `oxy_VERSION_amd64.deb` (or `_arm64.deb`) and run `sudo apt install ./oxy_VERSION_amd64.deb`. It needs glibc 2.28 or later (Debian 10, Ubuntu 20.04 and newer).
27
- **Other Linux:** unpack `oxy-VERSION-linux-x86_64.tar.gz` (or `-linux-arm64`) and put `oxy` on your `PATH`.
28
- **macOS** (Apple Silicon or Intel): unpack `oxy-VERSION-macos-arm64.tar.gz` (or `-macos-x86_64`), then `xattr -d com.apple.quarantine oxy`, since the build is not notarised, and put it on your `PATH`.
29
- **Windows:** unzip `oxy-VERSION-windows-x86_64.zip` and put the folder on your `PATH`. SmartScreen may warn on first run, since the build is not signed.
30
31
`oh`, the OxygenHub command line, is released the same way from [OxygenHub's releases]https://oxygenhub.io/andymccall/oxygenhub/releases.
32
33
Check a download against the release's `SHA256SUMS` with `sha256sum -c SHA256SUMS --ignore-missing`.
34
d02e545d Andy McCall ↶ 35
## Building
36
37
```
38
cargo build --release
39
cargo test --workspace
40
```
41
42
The binary is `target/release/oxy`.
f4324e40 unknown ↶ 43
d02e545d Andy McCall ↶ 44
## Quick start
45
46
```
47
oxy identity create --name "Your Name" --email [email protected]
48
oxy config --user core.sign change      # sign every commit
49
oxy init                                 # in a project directory
50
oxy status
51
oxy commit -m "First change"
52
oxy log
53
```
54
55
Collaborating:
56
57
```
58
oxy serve --root /srv/oxy --bind 0.0.0.0:8890 --tls-cert cert.pem --tls-key key.pem --token SECRET
59
oxy clone https://host:8890/project
60
oxy config remote.origin.token SECRET
61
oxy push
62
oxy pull
63
```
64
65
Trust policy, so a server accepts only changes from keys you have granted:
66
67
```
68
oxy policy init                          # your key becomes the root
69
oxy identity export                      # a contributor sends you this file
70
oxy policy grant alice.identity
71
oxy push                                 # publishes the policy
72
```
73
74
## Layout
75
76
| Path | Contents |
77
|---|---|
78
| `crates/oxy-core` | Library: encoding, hashing, objects, the change graph, storage, identities, policy, protocol, repository operations |
79
| `crates/oxy-server` | Reference HTTP(S) server for the wire protocol |
80
| `src/cli` | The `oxy` command-line interface |
81
| `docs/spec.md` | The specification |
82
83
## Licence
84
25c6adfa Andy McCall ↶ 85
MIT or Apache-2.0, at your option (see `LICENSE`).