fork of radicle with Git LFS support, backed by IPFS
Go to file
cloudhead 6349c1c559
cli: Small change to output for clarity
So that users don't confuse the revision id with a commit id, we
explicitly state it's a new revision id.
2024-01-08 17:46:22 +01:00
.config nix: switch to use nix flakes 2023-12-13 12:25:12 +01:00
.github/workflows Move `rad-web` binary to `radicle-httpd` package 2023-11-22 11:27:11 +01:00
debian Add rudimentary Debian packaging for binaries 2023-11-01 12:56:35 +01:00
radicle cli: Improve `rad remote add` 2024-01-08 17:28:01 +01:00
radicle-cli cli: Small change to output for clarity 2024-01-08 17:46:22 +01:00
radicle-cli-test cli-test: Expand env vars in commands 2024-01-05 11:03:24 +01:00
radicle-cob git: update git2-0.18.1 2023-12-04 11:11:36 +00:00
radicle-crdt Introduce `cargo-deny` 2023-08-22 14:33:00 +02:00
radicle-crypto crypto: update ssh-key 2023-12-14 16:13:29 +00:00
radicle-dag dag: Fix topological order 2023-11-03 14:17:57 +01:00
radicle-fetch radicle: Rename many more methods using new naming 2023-12-06 10:02:00 +01:00
radicle-httpd httpd: Add edits field to revision json 2023-12-22 15:17:25 +01:00
radicle-node node: Make inventory announcements more robust 2023-12-20 15:44:02 +01:00
radicle-remote-helper cli: Small change to output for clarity 2024-01-08 17:46:22 +01:00
radicle-ssh Prepare crates for publishing to `crates.io` 2023-08-07 11:31:11 +02:00
radicle-term term: Fix line width bug with tabs 2024-01-04 14:02:05 +01:00
radicle-tools cli: Tell the user when canonical head is updated 2024-01-05 12:09:30 +01:00
scripts Move `rad-web` binary to `radicle-httpd` package 2023-11-22 11:27:11 +01: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
.envrc nix: simplify devShell and envrc 2023-12-14 10:52:04 +01:00
.gitignore Cleanup .gitignore 2023-08-04 12:50:08 +02:00
.gitsigners Add yorgos to .gitsigners 2023-08-18 16:36:02 +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 radicle: Move `DataUri` to `common::DataUri` 2023-12-22 15:09:20 +01:00
Cargo.toml nix: switch to use nix flakes 2023-12-13 12:25:12 +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
deny.toml Introduce `cargo-deny` 2023-08-22 14:33:00 +02:00
docker-compose.yml docker: Add `$USER` env var to docker-compose 2023-07-26 12:35:55 +02:00
flake.lock nix: switch to use nix flakes 2023-12-13 12:25:12 +01:00
flake.nix nix: add sqlite in devShell 2024-01-02 15:23:08 +01:00
git-remote-rad.1.adoc Add rudimentary Debian packaging for binaries 2023-11-01 12:56:35 +01:00
rad-patch.1.adoc cli: Small change to output for clarity 2024-01-08 17:46:22 +01:00
rad.1.adoc cli: Consolidate policy/scope variants 2023-12-06 09:56:58 +01:00
radicle-httpd.1.adoc Add rudimentary Debian packaging for binaries 2023-11-01 12:56:35 +01:00
radicle-node.1.adoc Add rudimentary Debian packaging for binaries 2023-11-01 12:56:35 +01:00
rust-toolchain Update Rust toolchain to 1.74 2023-11-17 16:58:24 +01: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.