OXYGENHUB
# b8a0399319fc oxygen / README.md
3.0 KiB · Markdown · last changed Packed storage: zstd packs with sorted indexes, oxy gc, auto-pack at 4096 loose objects; README 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
22
## Building
23
24
```
25
cargo build --release
26
cargo test --workspace
27
```
28
29
The binary is `target/release/oxy`.
f4324e40 unknown ↶ 30
d02e545d Andy McCall ↶ 31
## Quick start
32
33
```
34
oxy identity create --name "Your Name" --email [email protected]
35
oxy config --user core.sign change      # sign every commit
36
oxy init                                 # in a project directory
37
oxy status
38
oxy commit -m "First change"
39
oxy log
40
```
41
42
Collaborating:
43
44
```
45
oxy serve --root /srv/oxy --bind 0.0.0.0:8890 --tls-cert cert.pem --tls-key key.pem --token SECRET
46
oxy clone https://host:8890/project
47
oxy config remote.origin.token SECRET
48
oxy push
49
oxy pull
50
```
51
52
Trust policy, so a server accepts only changes from keys you have granted:
53
54
```
55
oxy policy init                          # your key becomes the root
56
oxy identity export                      # a contributor sends you this file
57
oxy policy grant alice.identity
58
oxy push                                 # publishes the policy
59
```
60
61
## Layout
62
63
| Path | Contents |
64
|---|---|
65
| `crates/oxy-core` | Library: encoding, hashing, objects, the change graph, storage, identities, policy, protocol, repository operations |
66
| `crates/oxy-server` | Reference HTTP(S) server for the wire protocol |
67
| `src/cli` | The `oxy` command-line interface |
68
| `docs/spec.md` | The specification |
69
70
## Licence
71
72
MIT or Apache-2.0, at your option.