fork of radicle with Git LFS support, backed by IPFS
Go to file
Fintan Halpenny c847a16e14 radicle: return iterator types for db policies
Instead of collecting the results and returning the collection as an
iterator, introduce `FollowPolicies` and `SeedPolicies` types, which
implement `Iterator`.

Note that a call in `service` changed due to the lifetime borrow. It
simply `collect`s into a `Vec` for the time being.
2025-04-11 12:35:55 +02:00
.cargo fetch: upgrade gix crates 2024-05-17 13:27:18 +02:00
.config nix: switch to use nix flakes 2023-12-13 12:25:12 +01:00
.radicle ci: don't build docs for depedencies 2025-01-14 13:45:34 +01:00
build build: ensure zigbuild install doesn't break reproducible build 2025-02-26 09:32:00 +02:00
debian Remove `radicle-httpd` crate 2024-06-06 11:14:00 +02:00
radicle radicle: return iterator types for db policies 2025-04-11 12:35:55 +02:00
radicle-cli radicle: use `Alias` in `follow` 2025-04-11 12:35:55 +02:00
radicle-cli-test Relax version requirement for `radicle` dependencies 2024-08-20 16:35:04 +02:00
radicle-cob cob: fix documentation 2024-12-04 12:40:40 +01:00
radicle-crdt crdt: run cargo fmt 2024-08-09 12:41:01 +02:00
radicle-crypto crypto: RefCell instead of Mutex in Agent 2025-01-28 14:05:45 +01:00
radicle-dag Update `radicle` to 0.14 2024-11-29 15:25:09 +01:00
radicle-fetch fetch: allow missing default branch 2024-11-06 16:47:01 +01:00
radicle-node radicle: return iterator types for db policies 2025-04-11 12:35:55 +02:00
radicle-remote-helper cli: Implement `rad cob migrate` 2024-11-22 21:27:45 +01:00
radicle-signals Update `radicle-signals` crate to 0.10.0 2024-09-03 12:31:07 +02:00
radicle-ssh Update radicle crates to 0.9.0 2024-03-26 11:56:27 +01:00
radicle-systemd Update `radicle-systemd` Cargo.toml 2024-09-03 12:40:22 +02:00
radicle-term term: Bump version to 0.12.0 2024-12-02 13:03:25 +01:00
radicle-tools crypto: RefCell instead of Mutex in Agent 2025-01-28 14:05:45 +01:00
scripts scripts: Small fix to contributor count 2024-12-05 14:25:28 +01:00
systemd Remove `radicle-httpd` crate 2024-06-06 11:14:00 +02:00
.dockerignore build: Add "upload" build step 2024-04-29 10:47:03 +02: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 Reproducible cross-compiled builds 2024-04-20 11:11:00 +02:00
.gitsigners Add yorgos to .gitsigners 2023-08-18 16:36:02 +02:00
ARCHITECTURE.md docs: link to protocol guide 2024-04-03 15:32:26 +02:00
CONTRIBUTING.md docs: Typo fixes 2024-04-29 13:28:31 +02:00
Cargo.lock nix: Nix flake maintenance 2025-04-10 15:29:08 +02:00
Cargo.toml node: Socket Activation with systemd 2024-07-22 10:44:22 +02:00
DCO Add licenses and contributor information 2022-11-16 12:26:12 +01:00
HACKING.md docs: Add a note on running isolated nodes 2024-09-12 17:56:21 +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 docs, cli: Mention feedback, also via e-mail 2025-04-10 15:04:52 +02:00
VERSIONING.md build: Add "upload" build step 2024-04-29 10:47:03 +02:00
build.rs build: Update env vars for build process 2024-06-20 10:47:50 +02:00
deny.toml nix: Nix flake maintenance 2025-04-10 15:29:08 +02:00
flake.lock nix: Nix flake maintenance 2025-04-10 15:29:08 +02:00
flake.nix nix: Nix flake maintenance 2025-04-10 15:29:08 +02:00
git-remote-rad.1.adoc Add rudimentary Debian packaging for binaries 2023-11-01 12:56:35 +01:00
rad-id.1.adoc cli: Have way to delete payload field in `rad id` 2024-05-13 16:12:41 +02:00
rad-patch.1.adoc man: make a note on draft patches 2025-01-14 14:05:21 +01:00
rad.1.adoc docs: note that node logs may also be in the system journal 2025-01-14 13:27:33 +01:00
radicle-node.1.adoc docs: Update manual pages to 1.0.0 2024-04-22 14:37:19 +02:00
rust-toolchain.toml rust: Migrate to `rust-toolchain.toml` 2024-08-22 11:12:10 +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 implementation 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.

See the Protocol Guide for an in-depth description of how Radicle works.

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:

curl -sSf https://radicle.xyz/install | sh

Or visit our download page.

📦 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 --root ~/.radicle
cargo install --path radicle-node --force --locked --root ~/.radicle
cargo install --path radicle-remote-helper --force --locked --root ~/.radicle

Or directly from our seed node:

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

Running

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

For running in debug mode, see HACKING.md.

Feedback

If you have feedback, feel free to create issues using rad issue, join our Zulip, or email feedback@radicle.xyz. Emails sent to this address are automatically posted to our public #feedback channel on Zulip, revealing the From header (which usually contains your name and email address). This allows us to discuss your feedback on Zulip, and, if necessary, respond to you via email.

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.