RADICLE_NODE_OPTIONS=--force

accepted.

To view existing issues and patches with your web browser, navigate to

To contribute issues and patches, please consider [installing][install]

Radicle and follow our [guides][guides].

## Feedback

If you have feedback, feel free to create issues using `rad issue`, join

Emails sent to this address are [automatically posted][zulip-help-email] to

[our **public** #feedback channel on Zulip][zulip-feedback], revealing the

[`From` header][rfc2822s3.6.2] (which usually contains your name and email

respond to you via email.

[install]: ../README.md#installation

[readme]: ../README.md

[rfc2822s3.6.2]: https://datatracker.ietf.org/doc/html/rfc2822#section-3.6.2

[run]: ../README.md#running

    "`radicle`",

    "radicle heartwood protocol & stack", # Old fixture.

    "radicle-\\w+", # Crates in Cargo style

    "radicle\\w*::", # Crates in Rust code style

    "xyz\\.radicle\\.(issue|patch|id)", # COB Type Names

]

# ARCHITECTURE

## [Unreleased]

## New Features

- Teach `rad patch show` to show the full commit range for each revision.

  before submitting a patch. We wouldn't want you to waste your time!

* If you need help or would like to discuss your changes, come to our community chat on [Zulip][zulip].

[zulip]: https://radicle.zulipchat.com

### Submitting patches

    for rid in self.storage.inventory()? {

        ...

associated with COBs implemented in this repo, we strive to write code that is as

independent as reasonably possible from this particular domain name. For example, it

should not be used for default configuration values, or if it is, there should be a

In tests, instead use names that are compliant with RFC 2606, e.g.

"radicle.example.com".

codebase (mostly tests or user hints, fallback for configuration), and some of them

are not easy to remove. However, this is in no way a justification to add more

references.

### Proposing changes

When proposing changes via a patch:

 "cyphernet",

 "fastrand",

 "gix-packetline",

 "lexopt",

 "log",

 "mio",

[workspace.package]

edition = "2024"

license = "MIT OR Apache-2.0"

version = "0.9.0"

# Even though some crates in this workspace may build fine

gix-packetline = { version = "0.21.1", default-features = false }

human-panic = "2.0.6"

humantime = "2.3"

itertools = "0.14"

lexopt = "0.3.0"

libc = "0.2.137"

code forges such as GitHub and GitLab that preserves user sovereignty

and freedom.

information, and the [Zulip chat](https://radicle.zulipchat.com/) to

talk to the project.

in-depth description of how Radicle works.

## Installation

Run the following command to install the latest binary release:

### 📦 From source

Or directly from our seed node:

    cargo install --force --locked --root ~/.radicle \

        crates/radicle-cli crates/radicle-node crates/radicle-remote-helper

## Running

## Feedback

If you have feedback, feel free to create issues using `rad issue`, join

Emails sent to this address are [automatically posted][zulip-help-email] to

[our **public** #feedback channel on Zulip][zulip-feedback], revealing the

[`From` header][rfc2822s3.6.2] (which usually contains your name and email

[zulip]: https://radicle.zulipchat.com/

[zulip-feedback]: https://radicle.zulipchat.com/#narrow/channel/392584-feedback

[zulip-help-email]: https://talently.zulip.com/help/message-a-channel-by-email

[rfc2822s3.6.2]: https://datatracker.ietf.org/doc/html/rfc2822#section-3.6.2

node.

This is achieved through the `build/upload` script, which requires SSH access to

```

SSH_LOGIN=<user> build/upload 1.3.0-rc.3

Once the files are released we can install the binaries via:

```

```

where `$TARGET` is the relevant architecture and version.

### Release on Team Node

To help with testing the pre-release internally, we upgrade our team node,

IDs.

We do this using NixOS and the [`radicle-nix`][radicle-nix] and

## Installation

```

```

## Notes

changes in the patch release. These must be forward-ported to the `master`

branch.

[radicle-nix]: https://github.com/radicle-nix/radicle-nix

[zulip]: https://radicle.zulipchat.com/#narrow/channel/409174-announcements

ARG ALPINE_VERSION="3.20"

FROM rust:${RUST_VERSION}-alpine${ALPINE_VERSION} as builder

WORKDIR /src

COPY . .

fi

SSH_LOGIN=${SSH_LOGIN:-release}

SSH_KEY="$(rad path)/keys/radicle"

main() {

  version="$1"

  if [ -z "$version" ]; then

    echo "fatal: empty version number" >&2 ; exit 1

set -e

SSH_LOGIN=${SSH_LOGIN:-release}

SSH_KEY="$(rad path)/keys/radicle"

main() {

    echo "fatal: empty version number" >&2 ; exit 1

  fi

  # Create remote folder.

  ssh -i "$SSH_KEY" "$SSH_ADDRESS" mkdir -p "$destination"

```

$ rad config

{

  "preferredSeeds": [

  ],

  "web": {

    "pinned": {

    "publicExplorer": {

      "description": "Public explorer. This is used for generating links.",

      "$ref": "#/$defs/Explorer",

    },

    "preferredSeeds": {

      "description": "Preferred seeds. These seeds will be used for explorer links/nand in other situations when a seed needs to be chosen.",

      "type": "string",

      "pattern": "^.+@.+:((6553[0-5])|(655[0-2][0-9])|(65[0-4][0-9]{2})|(6[0-4][0-9]{3})|([1-5][0-9]{4})|([0-5]{0,5})|([0-9]{1,4}))$",

      "examples": [

        "z6MkvUJtYD9dHDJfpevWRT98mzDDpdAtmUjwyDSkyqksUr7C@xmrhfasfg5suueegrnc4gsgyi2tyclcy5oz7f5drnrodmdtob6t2ioyd.onion:8776",

        "z6Mkvky2mnSYCTUMKRdAUoZXBXLLKtnWEkWeYQcGjjnmobAU@f2atcc7udeub5kh4nkljtjwyk7ikjviorufzgwnfwhkphljl3vhq.b32.i2p:8776",

        "z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi@seed.example.com:8776",

$ rad config get node.alias

alice

$ rad config get preferredSeeds

$ rad config get node.limits.routingMaxSize

1000

```

Do you have feedback?

 - Chat <radicle.zulipchat.com>

   (Messages are automatically posted to the public #feedback channel on Zulip.)

Usage: rad[EXE] <COMMAND>

Now let's do an identity update.

``` ~alice

[..]

$ rad sync -a

✓ Synced with 1 seed(s)

  "payload": {

    "xyz.radicle.project": {

      "defaultBranch": "master",

      "name": "heartwood"

    }

  },

Your repository has been synced to the network and is now discoverable by peers.

View it in your browser at:

To push changes, run `git push`.

```

✗ Error: to sync a repository, your node must be running. To start it, run `rad node start`

```

``` (fail)

✗ Error: failed to open node control socket "[..]/.radicle/node/control.sock" (entity not found)

✗ Hint: to start your node, run `rad node start`.

```

✓ Patch acab0ec777a97d013f30be5d5d1aec32562ecb02 opened

✓ Synced with 1 seed(s)

To rad://z3yXbb1sR6UG6ixxV2YF9jUP7ABra/z6Mkt67GdsW7715MEfRuP4pSZxJRJh6kj6Y48WRqVv4N1tRk

 * [new reference]   HEAD -> refs/patches

✓ Synced with 1 seed(s)

To rad://z3yXbb1sR6UG6ixxV2YF9jUP7ABra/z6Mkt67GdsW7715MEfRuP4pSZxJRJh6kj6Y48WRqVv4N1tRk

 + e12525d...b2b6432 changes -> patches/acab0ec777a97d013f30be5d5d1aec32562ecb02 (forced update)

✓ Canonical reference refs/heads/master updated to target commit b2b6432af93f8fe188e32d400263021b602cfec8

✓ Synced with 1 seed(s)

To rad://z3yXbb1sR6UG6ixxV2YF9jUP7ABra/z6Mkt67GdsW7715MEfRuP4pSZxJRJh6kj6Y48WRqVv4N1tRk

   f2de534..b2b6432  master -> master

z6MkrLMMsiPWUcNPHcRajuMi9mDfYckSoJyPwwnknocNYPm7@seed.radicle.garden:8776

$ rad config push node.connect z6Mkmqogy2qEM2ummccUthFEaaHvyYmYBYh3dbe9W4ebScxo@ash.radicle.garden:8776

z6Mkmqogy2qEM2ummccUthFEaaHvyYmYBYh3dbe9W4ebScxo@ash.radicle.garden:8776

```

Note the warnings that the above configuration causes:

    "RAD_RNG_SEED": "0"

  },

  "warnings": [

  ]

}

```

```

$ rad node status

Node is stopped.

To start it, run `rad node start`.

```

Do you have feedback?

 - Chat <\x1b]8;;https://radicle.zulipchat.com\x1b\\radicle.zulipchat.com\x1b]8;;\x1b\\>

   (Messages are automatically posted to the public #feedback channel on Zulip.)\

";

pub const TIMESTAMP: &str = env!("SOURCE_DATE_EPOCH");

        env!("CARGO_PKG_VERSION")

    )

    .homepage(env!("CARGO_PKG_HOMEPAGE"))

    if let Some(lvl) = radicle::logger::env_level() {

        let logger = Box::new(radicle::logger::Logger::new(lvl));

use std::collections::HashMap;

use std::sync::LazyLock;

use radicle::node::config::ConnectAddress;

use radicle::profile::Config;

    HashMap::from([

        (

        ),

        (

        ),

    ])

});

) -> Vec<String> {

    iter.into_iter().enumerate().fold(Vec::new(), |mut warnings, (i, value)| {

        let old: Address = value.into();

            warnings.push(format!(

            ));

        }

        warnings

cyphernet = { workspace = true, features = ["dns", "ed25519", "p2p-ed25519", "noise-framework", "noise_sha2"] }

fastrand = { workspace = true }

gix-packetline = { workspace = true, features = ["blocking-io"] }

lexopt = { workspace = true }

log = { workspace = true, features = ["kv", "std"] }

mio = { version = "1", features = ["net", "os-poll"] }

    },

}

fn execute(options: Options) -> Result<(), ExecutionError> {

    let home = profile::home()?;

    let passphrase = None;

    #[cfg(all(feature = "systemd", target_os = "linux"))]

    let passphrase = passphrase.or_else(profile::env::passphrase);

    let secret_path = options.secret;

    #[cfg(all(feature = "systemd", target_os = "linux"))]

    let secret_path = secret_path

        .or_else(|| config.node.secret.clone())

#[test]

fn test_persistent_peer_connect() {

    let bob = Peer::new("bob", [8, 8, 8, 8]);

    let eve = Peer::new("eve", [9, 9, 9, 9]);

        (bob.id(), bob.address()).into(),

        (eve.id(), eve.address()).into(),

    ]);

#[test]

fn test_persistent_peer_reconnect_attempt() {

    let mut bob = Peer::new("bob", [8, 8, 8, 8]);

    let mut eve = Peer::new("eve", [9, 9, 9, 9]);

        MockStorage::empty(),

        peer::Config {

            config: Config {

                    (bob.id(), bob.address()).into(),

                    (eve.id(), eve.address()).into(),

                ]),

#[test]

fn test_persistent_peer_reconnect_success() {

    let bob = Peer::with_storage("bob", [9, 9, 9, 9], MockStorage::empty());

    let mut alice = Peer::config(

        MockStorage::empty(),

        peer::Config {

            config: Config {

                ..Config::new(node::Alias::new("alice"))

            },

            ..peer::Config::default()

homepage.workspace = true

license.workspace = true

version = "0.7.0"

edition.workspace = true

rust-version.workspace = true

fast-glob = { version = "0.3.2" }

fastrand = { workspace = true, features = ["std"] }

git2 = { workspace = true, features = ["vendored-libgit2"] }

log = { workspace = true, features = ["std"] }

nonempty = { workspace = true, features = ["serialize"] }

qcheck = { workspace = true, optional = true }

    fn default() -> Self {

        Self(String::from(

            std::option_env!("RADICLE_EXPLORER")

        ))

    }

}

    pub fn verbose(&self) -> String {

        const UNKNOWN_VERSION_ERROR: &str = r#"

Perhaps a new version of the identity document is released which is not supported by the current client.

The CLI command `rad id migrate` will help to migrate to an up-to-date versions."#;

        match self {

use std::ops::Deref;

use std::str::FromStr;

use std::{fmt, net};

use cyphernet::addr::PeerAddr;

use localtime::LocalDuration;

use serde::{Deserialize, Serialize};

use serde_json as json;

            #[allow(clippy::unwrap_used)] // Value is manually verified.

            NodeId::from_str("z6MkrLMMsiPWUcNPHcRajuMi9mDfYckSoJyPwwnknocNYPm7").unwrap(),

            vec![

                #[cfg(feature = "tor")]

                #[allow(clippy::unwrap_used)] // Value is manually verified.

                OnionAddrV3::from_str(

            #[allow(clippy::unwrap_used)] // Value is manually verified.

            NodeId::from_str("z6Mkmqogy2qEM2ummccUthFEaaHvyYmYBYh3dbe9W4ebScxo").unwrap(),

            vec![

                #[cfg(feature = "tor")]

                #[allow(clippy::unwrap_used)] // Value is manually verified.

                OnionAddrV3::from_str(

        match self {

            Self::Main => [

                (

                    seeds::RADICLE_NODE_BOOTSTRAP_IRIS.clone(),

                ),

                (

                    seeds::RADICLE_NODE_BOOTSTRAP_ROSA.clone(),

                ),

            ]

        with = "String",

        regex(pattern = r"^.+@.+:((6553[0-5])|(655[0-2][0-9])|(65[0-4][0-9]{2})|(6[0-4][0-9]{3})|([1-5][0-9]{4})|([0-5]{0,5})|([0-9]{1,4}))$"),

        extend("examples" = [

            "z6MkvUJtYD9dHDJfpevWRT98mzDDpdAtmUjwyDSkyqksUr7C@xmrhfasfg5suueegrnc4gsgyi2tyclcy5oz7f5drnrodmdtob6t2ioyd.onion:8776",

            "z6Mkvky2mnSYCTUMKRdAUoZXBXLLKtnWEkWeYQcGjjnmobAU@f2atcc7udeub5kh4nkljtjwyk7ikjviorufzgwnfwhkphljl3vhq.b32.i2p:8776",

            "z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi@seed.example.com:8776",

    /// Peers to connect to on startup.

    /// Connections to these peers will be maintained.

    #[serde(default)]

    /// Specify the node's public addresses

    #[serde(default)]

    pub external_addresses: Vec<Address>,

            user_agent: Some(UserAgent::default()),

            peers: PeerConfig::default(),

            listen: vec![],

            external_addresses: vec![],

            network: Network::default(),

            proxy: None,

            .to_lowercase();

        let name = git::fmt::refname!("feature")

            .join(git::fmt::RefString::try_from(random.as_str()).unwrap());

        rng.fill(&mut buffer);

Source: radicle

Uploaders: Lars Wirzenius <liw@liw.fi>, Sebastian Martinez <sebastian@rhizoma.dev>

Section: vcs

Priority: optional

Standards-Version: 4.6.2

Build-Depends: debhelper (>= 10~),

  asciidoctor

Package: radicle

Architecture: any

Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/

Upstream-Name: heartwood

Files: *

Copyright: 2019-2021, The Radicle Foundation

  nixConfig = {

    keepOutputs = true;

    extra-trusted-public-keys = ["radicle:TruHbueGHPm9iYSq7Gq6wJApJOqddWH+CEo+fsZnf4g="];

  };

            grep = rec {

              generators = [

                {

                  files = "\\.rs$";

                  excludes = [];

                }

= git-remote-rad(1)

:doctype: manpage

:revnumber: 0.8.0

:revdate: 2023-10-12

= rad-id(1)

:doctype: manpage

:revnumber: 1.0.0

:revdate: 2024-04-22

= rad-patch(1)

:doctype: manpage

:revnumber: 1.0.0

:revdate: 2024-04-22

= rad(1)

:doctype: manpage

:revnumber: 1.0.0

:revdate: 2024-04-22

To connect to a specific peer, the *connect* sub-command can be used:

For example, to connect to a community node, you can run:

The argument given to *connect* is called a node _address_. It is composed of

a Node ID (NID), followed by an *@* symbol, and the _host_ name and _port_.

= radicle-node(1)

:doctype: manpage

:revnumber: 1.0.0

:revdate: 2024-04-22

echo "## Installation"

echo

echo '```'

echo '```'

echo

echo "## Notes"

STAGED_FILES=$(git diff --cached --name-only --diff-filter=ACMR | grep '\.rs$' || true)

if [ -n "$STAGED_FILES" ]; then

    if echo "$STAGED_FILES" | xargs rg --context=3 --fixed-strings 'radicle.xyz'; then

        exit 1

    fi

`heartwood` already has the following types of tests (as of 2026-04):

However we can only run them on the currently checked out version of `heartwood`, this leaves gaps in our testing coverage, particularly for cross-version and cross-platform testing.

## Plan

  1. [ ] `radicle-node` timoni module.

  2. [ ] `radicle-node` custom container builder.

  3. [ ] `instances` topology definition files.

<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">

  <Package

    Name="Radicle"

    Manufacturer="Radicle Team"

    Version="$(env.RADICLE_VERSION)"

  >

    <MediaTemplate EmbedCab="yes" />

    <MajorUpgrade DowngradeErrorMessage="A newer version of Radicle is already installed." />

    <StandardDirectory Id="LocalAppDataFolder">

      <Directory Id="INSTALLFOLDER" Name="Radicle">  

        <Component Id="InstallFolderComponent" Guid="*">