fork of radicle with Git LFS support, backed by IPFS
Go to file
Alexis Sellier 2ea9a911af
remote-helper: Handle patch update after merge
If you accidently merge updated patch code before updating the patch in
storage, you end up in this weird state where you can't update the patch
any longer. This fixes it.
2023-08-03 18:01:04 +02:00
.github/workflows ci: Fix man page build 2023-07-21 20:52:25 +02:00
.nix nix: update toolchain 2023-06-07 11:44:44 +02:00
radicle node: Use `camelCase` for control socket data 2023-08-01 15:48:44 +02:00
radicle-cli remote-helper: Handle patch update after merge 2023-08-03 18:01:04 +02:00
radicle-cli-test cli-test: Add easy file creation syntax 2023-06-22 11:15:42 +02:00
radicle-cob cob: Remove CRDTs from COB state 2023-07-25 15:29:27 +02:00
radicle-crdt cob: Use new `Immutable` lattice for merges 2023-07-03 12:31:05 +02:00
radicle-crypto node: Some small UX fixes 2023-08-01 14:55:20 +02:00
radicle-dag dag: Improve trait bounds 2023-05-30 16:31:01 +02:00
radicle-httpd docker: Make Dockerfile easier to read 2023-08-03 13:43:20 +02:00
radicle-node docker: Make Dockerfile easier to read 2023-08-03 13:43:20 +02:00
radicle-remote-helper remote-helper: Handle patch update after merge 2023-08-03 18:01:04 +02:00
radicle-ssh cli: `rad self` improvements 2023-06-30 14:41:00 +02:00
radicle-term term: Prepare for crate publishing 2023-07-31 14:13:50 +02:00
radicle-tools cli: Make key encryption optional 2023-07-20 10:40:15 +02:00
radicle-tui cob: Remove CRDTs from COB state 2023-07-25 15:29:27 +02:00
scripts ci: Fix man page build 2023-07-21 20:52:25 +02:00
systemd Move unit files to `systemd` directory 2023-06-22 12:13:30 +02:00
.dockerignore Dockerize services 2022-12-14 17:15:40 +01:00
.env.seed seed: Update default tracking policy for seed 2023-04-17 21:16:56 +02:00
.gitignore Add a few common/useful files to .gitignore 2023-07-31 14:06:47 +02:00
.gitsigners Add @canndrew to .gitsigners 2023-07-25 12:51:48 +02:00
ARCHITECTURE.md Flesh out `HACKING.md` 2023-03-16 13:06:38 +01:00
CONTRIBUTING.md docs: Replace deprecated `--all` flag with `--workspace` 2023-07-26 13:23:15 +02:00
Cargo.lock httpd: Add a cache for `/tree` 2023-07-25 13:10:58 +02:00
Cargo.toml tui: Add basic framework 2023-03-20 16:27:42 +01:00
DCO Add licenses and contributor information 2022-11-16 12:26:12 +01:00
HACKING.md node: Rename control socket 2023-03-31 17:29:58 +02:00
LICENSE-APACHE Add licenses and contributor information 2022-11-16 12:26:12 +01:00
LICENSE-MIT Add licenses and contributor information 2022-11-16 12:26:12 +01:00
README.md Move unit files to `systemd` directory 2023-06-22 12:13:30 +02:00
build.rs Rust 1.67 2023-02-04 19:30:29 +01:00
docker-compose.yml docker: Add `$USER` env var to docker-compose 2023-07-26 12:35:55 +02:00
rad.1.adoc docs: Add `rad.1` manual page 2023-07-20 10:54:05 +02:00
rust-toolchain Update to Rust 1.70 2023-06-02 14:40:44 +02:00

README.md

❤️🪵

Radicle Heartwood Protocol & Stack

Heartwood is the third iteration of the Radicle Protocol, a powerful peer-to-peer code collaboration and publishing stack. The repository contains a full implemention of Heartwood, complete with a user-friendly command-line interface (rad) and network daemon (radicle-node).

Radicle was designed to be a secure, decentralized and powerful alternative to code forges such as GitHub and GitLab that preserves user sovereignty and freedom.

Installation

Requirements

  • Linux or Unix based operating system.
  • Git 2.34 or later
  • OpenSSH 9.1 or later with ssh-agent

📀 From binaries

Requires curl and tar.

Run the following command to install the latest binary release:

sh <(curl -sSf https://radicle.xyz/install)

📦 From source

Requires the Rust toolchain.

You can install the Radicle stack from source, by running the following commands from inside this repository:

cargo install --path radicle-cli --force --locked
cargo install --path radicle-node --force --locked
cargo install --path radicle-remote-helper --force --locked

Or directly from our seed node:

cargo install --force --locked --git https://seed.radicle.xyz/z3gqcJUoA1n9HaHKufZs5FCSGazv5.git \
    radicle-cli radicle-node radicle-remote-helper

Running

Systemd unit files are provided for the node and HTTP daemon under the /systemd folder. They can be used as a starting point for further customization.

Additionally, a Dockerfile is included under both crates.

For running in debug mode, see HACKING.md.

Contributing

See CONTRIBUTING.md and HACKING.md for an introduction to contributing to Radicle.

License

Radicle is distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE-APACHE and LICENSE-MIT for details.