Radicle

https://radicle.dev/guides
Admin
Radicle is a sovereign peer-to-peer network for code collaboration and publishing built on top of...
Tokens:21,224
Snippets:295
Trust Score:7.2
Update:2 months ago
Show doc for...
Tokens:
Raw
### Initialize a Radicle project

Source: https://radicle.dev/guides/quick-start

Run this command within your project directory to start the setup wizard and announce your repository to the network.

```bash
$ cd /path/to/my-project
$ rad init

Initializing radicle 👾 project in .

✓ Name: my-project
✓ Description: A short description of my project
✓ Default branch: main
✓ Visibility: public
✓ Project my-project created.

Your project's Repository ID (RID) is rad:z3gqc…
You can show it any time by running `rad .` from this directory.

✓ Project successfully announced to the network.
```

--------------------------------

### Enable and start node service

Source: https://radicle.dev/guides/seeder

Enable the systemd service to start on boot and start it immediately.

```bash
systemctl enable --now radicle-node
```

--------------------------------

### Install via Script

Source: https://radicle.dev/guides/quick-start

The recommended quick installation method for the Radicle toolchain.

```bash
$ curl -sSLf https://radicle.xyz/install | sh
```

--------------------------------

### Install and verify Caddy

Source: https://radicle.dev/guides/seeder

Installs the Caddy web server and confirms the installation version.

```bash
apt-get install caddy
```

```bash
caddy version
v2.6.4 h1:2hwYqiRwk1tf3VruhMpLcYTg+11fCdr8S3jhNAdnPy8=
```

--------------------------------

### Install on Debian/Ubuntu

Source: https://radicle.dev/guides/quick-start

Install Radicle using the apt package manager.

```bash
curl -LO https://radicle.xyz/apt/radicle-archive-keyring.deb
sudo apt install ./radicle-archive-keyring.deb
echo "deb [signed-by=/usr/share/radicle/radicle-archive-keyring.asc] https://radicle.xyz/apt release main" \
  | sudo tee -a /etc/apt/sources.list
sudo apt-get update && sudo apt-get install radicle
```

--------------------------------

### Install Radicle via script

Source: https://radicle.dev/guides/user

Execute the installation script to download and set up Radicle binaries and man pages.

```bash
$ curl -sSLf http://localhost:3000/install | sh
```

--------------------------------

### Install from Source

Source: https://radicle.dev/guides/quick-start

Build the toolchain from local source or directly from the seed node using Cargo.

```bash
cargo install --path crates/radicle-cli --force --locked --root ~/.radicle
cargo install --path crates/radicle-node --force --locked --root ~/.radicle
cargo install --path crates/radicle-remote-helper --force --locked --root ~/.radicle
```

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

--------------------------------

### Start node and connect to peer

Source: https://radicle.dev/guides/user

Commands to start the node and establish a connection to a peer using their onion address.

```bash
$ rad node start
```

```bash
$ rad node connect z6Mkhp7VUnuufpvuQ3PdysShAjL86VDRUpPpkesqiysDBGs9@odmmeotgcfx65l5hn6ejkaruvai222vs7o7tmtllszqk5xbysolfdd.onion:8776
```

--------------------------------

### Install via Homebrew

Source: https://radicle.dev/guides/quick-start

Install Radicle using the Homebrew package manager.

```bash
$ brew install radicle
```

--------------------------------

### View private repository initialization output

Source: https://radicle.dev/guides/user

Example output showing the successful creation of a private repository and its associated Repository ID.

```text
$ rad init --private

Initializing private radicle 👾 repository in /home/paxel/src/schrödingers-paradox..
...

Your Repository ID (RID) is rad:z3jEQE4VMzkR1UVeSLiN9E8AMtV6a.
You can show it any time by running `rad .` from this directory.

You have created a private repository.
This repository will only be visible to you, and to peers you explicitly allow.

To make it public, run `rad publish`.
To push changes, run `git push`.
```

--------------------------------

### Verify Radicle Installation

Source: https://radicle.dev/guides/quick-start

Check the installed version of the Radicle CLI.

```bash
$ rad --version
```

--------------------------------

### Set ownership of installation directories

Source: https://radicle.dev/guides/seeder

Changes ownership of local binary and manual directories to the current user to allow installation without root.

```bash
$ sudo chown $(whoami): /usr/local/{bin,man,man/man1}
```

--------------------------------

### Start Radicle Node

Source: https://radicle.dev/guides/quick-start

Initializes the node process to connect and replicate repositories.

```bash
$ rad node start
```

--------------------------------

### Verify Git and SSH installations

Source: https://radicle.dev/guides/user

Check the installed versions of Git and SSH to ensure they meet the minimum requirements.

```bash
git --version
```

```bash
ssh -V
```

--------------------------------

### Enable and test Caddy service

Source: https://radicle.dev/guides/seeder

Starts the Caddy service and verifies HTTPS connectivity to the API.

```bash
systemctl enable --now caddy
```

```bash
curl https://seed.radicle.example/api/v1
```

--------------------------------

### Radicle URL Scheme Examples

Source: https://radicle.dev/guides/protocol

Examples of rad:// URLs for specific peer namespaces and canonical repository states.

```text
rad://z42hL2jL4XNk6K8oHQaSWfMgCL7ji/z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi
```

```text
rad://z42hL2jL4XNk6K8oHQaSWfMgCL7ji
```

--------------------------------

### Start Radicle node in foreground

Source: https://radicle.dev/guides/seeder

Run the node in the foreground to verify connectivity and sync status before setting up as a service.

```bash
rad node start --foreground
```

--------------------------------

### View patch details

Source: https://radicle.dev/guides/quick-start

Example output showing the metadata and status of a patch in the heartwood repository.

```text
╭──────────────────────────────────────────────────────────────────────────╮
│ Title    fetch: Update gix packages                                      │
│ Patch    76f1369e7bab4126e97b175bcddea58f55f3c741                        │
│ Author   fintohaps (you)                                                 │
│ Head     aed9c2603884a8cd76c433262657d72289bd36bb                        │
│ Base     caee776c388ffac2ea55cc9d1e3d7fa108ca6df5                        │
│ Commits  ahead 1, behind 0                                               │
│ Status   open                                                            │
│                                                                          │
│ Several vulnerabilities were found in the gix packages[^1][^2][^3].      │
│                                                                          │
│ Update the packages to their latest versions which include the fixes.    │
│                                                                          │
│ The only required change is in `ls_refs`.                                │
│ `RefPrefixes` was introduced and this fixes the issue with `ref-prefix`. │
│ This should now improve the ls-refs stage and only return references     │
│ that the client is asking for, as opposed to all references.             │
│                                                                          │
│ [^1]: https://github.com/radicle-dev/heartwood/security/dependabot/38    │
│ [^2]: https://github.com/radicle-dev/heartwood/security/dependabot/39    │
│ [^3]: https://github.com/radicle-dev/heartwood/security/dependabot/36    │
├──────────────────────────────────────────────────────────────────────────┤
│ aed9c26 fetch: Update gix packages                                       │
├──────────────────────────────────────────────────────────────────────────┤
│ ● Revision 76f1369 @ caee776..aed9c26 by fintohaps (you) 5 hours ago     │
╰──────────────────────────────────────────────────────────────────────────╯
```

--------------------------------

### Radicle repository URL

Source: https://radicle.dev/guides/user

Example of a Radicle repository URL format.

```text
rad://z31hE1wco9132nedN3mm5qJjyotna/z6MkvZwzK64f3GuDcAs6dEcje89ddfHkBjS1v9Dkh7aCGq3C
```

--------------------------------

### Minimal Radicle Node Configuration

Source: https://radicle.dev/guides/seeder

A sample JSON configuration file demonstrating a permissive seeding policy and external address setup.

```json
{
  "node": {
    "alias": "seed.radicle.example",
    "listen": ["0.0.0.0:8776"],
    "externalAddresses": ["seed.radicle.example:8776"],
    "seedingPolicy": {
      "default": "allow",
      "scope": "all"
    }
  }
}
```

--------------------------------

### Radicle repository fetch URL

Source: https://radicle.dev/guides/user

Example of a Radicle repository URL format used for fetching.

```text
rad://z31hE1wco9132nedN3mm5qJjyotna
```

--------------------------------

### Manage the radicle-httpd service

Source: https://radicle.dev/guides/seeder

Commands to enable, start, and verify the status of the HTTP daemon service.

```bash
systemctl enable --now radicle-httpd
```

```bash
systemctl status radicle-httpd
```

--------------------------------

### Example Node ID DID

Source: https://radicle.dev/guides/protocol

A sample Node ID represented as a Decentralized Identifier using the did:key method.

```text
did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK
```

--------------------------------

### Example Repository Identifier (RID)

Source: https://radicle.dev/guides/protocol

A sample URN representing a unique Radicle repository identifier.

```text
rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5
```

--------------------------------

### Signed References Blob

Source: https://radicle.dev/guides/protocol

Example content of a signed references blob found under the refs/rad/sigrefs branch, formatted similarly to git show-ref output.

```text
9767b485c2aad1e23097d2b5165287ba84cfa452 refs/heads/master
f3eaa7454e3a4714885905ae99f616fc7895b5fa refs/cobs/xyz.radicle.patch/fe31d5b6049583a42c21a543545d182b893aa4a0
0590b78ee42b39087983e4de04164065e5aa11bc refs/cobs/xyz.radicle.patch/ffbb812ad6e7fe1c5c610b1246ca5ca9d7d16027
```

--------------------------------

### Push a new patch to Radicle

Source: https://radicle.dev/guides/quick-start

Use this command to create a new patch starting from the current HEAD commit.

```bash
$ git push rad HEAD:refs/patches
```

--------------------------------

### Initialize a local Git repository

Source: https://radicle.dev/guides/user

Prepare a local directory as a Git repository and commit initial files before initializing with Radicle.

```bash
$ cd schrödingers-paradox
$ git init
$ cp ~/secrets/897af-captain.log data/897af-captain.log
$ git commit -a -m "Add captain's log from ship 897AF"
```

--------------------------------

### Initialize repository for Radicle

Source: https://radicle.dev/guides/user

Publishes a local Git repository to the Radicle network.

```bash
$ rad init

Initializing radicle 👾 project in .

✓ Name: dark-star
✓ Description: Decoding data from the dark star to establish a model of the universe
✓ Default branch: main
✓ Visibility: public
✓ Project dark-star created.

Your project's Repository ID (RID) is rad:z31hE1wco9132nedN3mm5qJjyotna.
You can show it any time by running `rad .` from this directory.

✓ Project successfully announced to the network.

Your project has been announced to the network and is now discoverable by peers.
You can check for any nodes that have replicated your project by running `rad sync status`.

To push changes, run `git push`.
```

--------------------------------

### Download the radicle-httpd systemd unit file

Source: https://radicle.dev/guides/seeder

Downloads the service configuration file to the systemd directory.

```bash
curl -sSL https://seed.radicle.dev/raw/rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5/570a7eb141b6ba001713c46345d79b6fead1ca15/systemd/radicle-httpd.service -o /etc/systemd/system/radicle-httpd.service
```

--------------------------------

### Initialize a private Radicle repository

Source: https://radicle.dev/guides/user

Use the --private flag to initialize a repository that remains unannounced and unpublished on the network.

```bash
$ rad init --private
```

--------------------------------

### Download systemd unit file

Source: https://radicle.dev/guides/seeder

Fetch the official Radicle node service file and save it to the systemd directory.

```bash
curl -sSL https://seed.radicle.dev/raw/rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5/570a7eb141b6ba001713c46345d79b6fead1ca15/systemd/radicle-node.service -o /etc/systemd/system/radicle-node.service
```

--------------------------------

### List private repositories

Source: https://radicle.dev/guides/user

Verify the visibility status of repositories using the list command.

```text
╭────────────────────────────────────────────────────────────────────────╮
│ Name                   RID                                 Visibility  │
├────────────────────────────────────────────────────────────────────────┤
│ schrödingers-paradox   rad:z3jEQE4VMzkR1UVeSLiN9E8AMtV6a   private     │
╰────────────────────────────────────────────────────────────────────────╯
```

--------------------------------

### List available patches

Source: https://radicle.dev/guides/user

Displays a summary of open patches in the repository.

```bash
$ rad patch
╭───────────────────────────────────────────────────────────────────────────────────────────────────╮
│ ●  ID       Title                                Author           Head     +       -   Updated    │
├───────────────────────────────────────────────────────────────────────────────────────────────────┤
│ ●  e5f0a5a  Add anomalous data from ship 897AF   z6MkvZw…7aCGq3C  80b8d42  +50382  -0  1 hour ago │
╰───────────────────────────────────────────────────────────────────────────────────────────────────╯
```

--------------------------------

### Prepare branch for patch

Source: https://radicle.dev/guides/user

Creates a new branch, copies necessary data, and stages the changes.

```bash
$ git checkout -b anomalous-data-897af
$ cp /var/run/897af.log data/897af.log
$ git add data/
```

--------------------------------

### List seeded repositories

Source: https://radicle.dev/guides/user

Displays all repositories currently being seeded by the node.

```bash
$ rad ls --seeded
```

--------------------------------

### Initialize a Radicle profile

Source: https://radicle.dev/guides/seeder

Creates a new Radicle profile with a specified alias, generating the necessary Ed25519 key pair.

```bash
rad auth --alias seed.radicle.example
```

--------------------------------

### Initialize Radicle Identity

Source: https://radicle.dev/guides/user

Create a new cryptographic key pair and Radicle identity.

```bash
$ rad auth
```

```bash
$ rad auth

Initializing your radicle 👾 identity

✓ Enter your alias: paxel
✓ Enter a passphrase: ********
✓ Creating your Ed25519 keypair...
✓ Adding your radicle key to ssh-agent...
✓ Your Radicle DID is did:key:z6Mkhp7VUnuufpvuQ3PdysShAjL86VDRUpPpkesqiysDBGs9. This identifies your device. Run `rad self` to show it at all times.
✓ You're all set.
...
```

--------------------------------

### Open a new issue in Radicle

Source: https://radicle.dev/guides/user

Navigate to the repository directory and initiate the issue creation process using the Radicle CLI.

```bash
$ cd dark-star
$ rad issue open
```

--------------------------------

### List contributed repositories

Source: https://radicle.dev/guides/user

Displays repositories the user has interacted with, such as by pushing branches or commenting.

```bash
$ rad ls
```

--------------------------------

### List repository issues

Source: https://radicle.dev/guides/user

Display a table of all issues associated with the current repository.

```bash
$ rad issue
╭──────────────────────────────────────────────────────────────────────────────────────────────────╮
│ ●   ID        Title                                                    Author                    │
├──────────────────────────────────────────────────────────────────────────────────────────────────┤
│ ●   80464b3   Categorize initial dataset                               paxel    (you)            │
│ ●   e4255cc   Establish data standards for IUI Dark Star Data group    paxel    (you)            │
│ ●   3e2f653   Add anomalous data from ship 897AF                       calyx    z6Mkgom…unurCap  │
│ ●   badda04   Recruit Neboriens to join IUI and share dark star data   calyx    z6Mkgom…unurCap  │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
```

--------------------------------

### Inspect repository policy

Source: https://radicle.dev/guides/seeder

View the specific seeding policy applied to a given repository.

```bash
rad inspect rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5 --policy
```

--------------------------------

### Configure Caddy for HTTPS

Source: https://radicle.dev/guides/seeder

Downloads the Caddy service file and defines the reverse proxy configuration.

```bash
curl https://raw.githubusercontent.com/caddyserver/dist/master/init/caddy.service -o /etc/systemd/system/caddy.service
```

```text
seed.radicle.example {
    reverse_proxy 127.0.0.1:8080
}
```

--------------------------------

### Connect to a seed node

Source: https://radicle.dev/guides/user

Manually establish a connection to a specific seed node address.

```bash
$ rad node connect <address>
```

```bash
$ rad node connect z6MkqNZS9QWvC4wbZ8Vz4hQZ1FzN8q4XGj2KGmK9qNgQ8VWt@seed.darkstar.example:8776
```

--------------------------------

### Define a repository identity document

Source: https://radicle.dev/guides/protocol

Initializes repository metadata, delegates, and the threshold for authorization.

```json
{
  "delegates": ["did:key:z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi"],
  "threshold": 1,
  "payload": {
    "xyz.radicle.project": {
      "name": "heartwood",
      "description": "Radicle Heartwood Protocol & Stack ❤️🪵",
      "defaultBranch": "master"
    }
  }
}
```

--------------------------------

### Verify local repository state

Source: https://radicle.dev/guides/user

Check the current directory and Git status before initializing a repository.

```bash
$ pwd
/home/paxel/src/dark-star

$ git status
On branch master
Your branch is up to date with 'origin/master'.
nothing to commit, working tree clean
```

--------------------------------

### Show patch details

Source: https://radicle.dev/guides/user

Display the current status and revision history of a specific patch.

```bash
$ rad patch show e5f0a5a
...
│ ● opened by z6MkvZw…7aCGq3C (b766431) 2 hours ago                           │
│ ↑ updated to 4d0c1156f8ac7af2297d1314cd7556185cd16ae4 (80b8d42) 2 hours ago │
│ * revised by calyx in 1e0596d (25f8515) 3 minutes ago                       │
╰─────────────────────────────────────────────────────────────────────────────╯
```

--------------------------------

### Manually synchronize with the network

Source: https://radicle.dev/guides/quick-start

Force a manual synchronization if changes have not been automatically announced or fetched.

```bash
$ rad sync
```

--------------------------------

### Seed a private repository

Source: https://radicle.dev/guides/user

Configure a seed node to fetch a private repository from a specific source node.

```bash
$ rad seed rad:z3jEQE4VMzkR1UVeSLiN9E8AMtV6a --from z6MkvZwzK64f3GuDcAs6dEcje89ddfHkBjS1v9Dkh7aCGq3C
```

--------------------------------

### View allow list configuration

Source: https://radicle.dev/guides/user

The JSON structure representing the visibility allow list within a repository identity update.

```json
"allow": [
  "did:key:z6Mkgom1bTxdh9fMFxFNXFMw3SbXnma6NARdsfcFuunurCap",
  "did:key:z6MkqNZS9QWvC4wbZ8Vz4hQZ1FzN8q4XGj2KGmK9qNgQ8VWt"
]
```

--------------------------------

### View repository changes

Source: https://radicle.dev/guides/user

Displays the diff of the current changes in the repository.

```bash
$ git diff
diff --git a/README.md b/README.md
index 91b304791..70ef6efc9 100644
--- a/README.md
+++ b/README.md
@@ -58,6 +58,12 @@

+## Radicle
+
+To clone this repository on Radicle, simply run:
+
+    rad clone rad:z31hE1wco9132nedN3mm5qJjyotna
+
```

--------------------------------

### Define DNS-SD records for node discovery

Source: https://radicle.dev/guides/seeder

Set these SRV, TXT, and PTR records to enable DNS-based service discovery for your node.

```text
seed._radicle-node._tcp.radicle.example.  3600  IN  SRV  32767 32767 58776 seed.radicle.example.
seed._radicle-node._tcp.radicle.example.  3600  IN  TXT  "nid=z6MkXB…Z6sTAz"
_radicle-node._tcp.radicle.example.       3600  IN  PTR  seed._radicle-node._tcp.radicle.example.
```

--------------------------------

### Create Onion Service Directory

Source: https://radicle.dev/guides/user

Create a secure directory for storing Tor Onion Service keys and configuration.

```bash
$ sudo mkdir -m 700 /var/lib/tor/radicle
```

--------------------------------

### Show issue details

Source: https://radicle.dev/guides/user

Display the full details of a specific issue using its ID or a partial hash.

```bash
$ rad issue show 3e2f65
╭─────────────────────────────────────────────────────────────╮
│ Title   Add anomalous data from ship 897AF                  │
│ Issue   3e2f653383f0d2fe21ef4e859a25925c364c740a            │
│ Author  calyx                                               │
│ Status  open                                                │
│                                                             │
│ Before we onboard new IUI members like the Neborians, it is │
│ important we upload the data from ship 897AF. I just        │
│ reviewed the database and it seems this is missing.         │
╰─────────────────────────────────────────────────────────────╯
```

--------------------------------

### Fetch from a remote

Source: https://radicle.dev/guides/user

Updates local tracking branches from a specific Radicle remote.

```bash
$ git fetch paxel
  From rad://z3cyotNHuasWowQ2h4yF9c3tFFdvc/z6MkvZwzK64f3GuDcAs6dEcje89ddfHkBjS1v9Dkh7aCGq3C
    * [new branch]      dark-star-secrets       -> paxel/dark-star-secrets
```

--------------------------------

### Opening a Patch Output

Source: https://radicle.dev/guides/user

The console output displayed after successfully pushing a commit to open a new patch.

```text
✓ Patch e5f0a5a5adaa33c3b931235967e4930ece9bb617 opened
✓ Synced with 8 node(s)

To rad://z3cyotNHuasWowQ2h4yF9c3tFFdvc/z6MkvZwzK64f3GuDcAs6dEcje89ddfHkBjS1v9Dkh7aCGq3C
* [new reference]   HEAD -> refs/patches
```

--------------------------------

### Check current repository

Source: https://radicle.dev/guides/user

Verifies the current Radicle repository context.

```bash
$ rad .
rad:z3cyotNHuasWowQ2h4yF9c3tFFdvc
```

--------------------------------

### Clone a repository using rad clone

Source: https://radicle.dev/guides/quick-start

Fetches a repository from the network using its Repository ID (RID) and creates a local working copy.

```bash
$ rad clone rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5
✓ Seeding policy updated for rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5 with scope 'followed'
✓ Fetching rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5 from z6Mkk4R…SBiyXVM..
✓ Fetching rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5 from z6Mksmp…1DN6QSz..
✓ Creating checkout in ./heartwood..
✓ Repository successfully cloned under ./heartwood/
╭────────────────────────────────────╮
│ heartwood                          │
│ Radicle Heartwood Protocol & Stack │
│ 8 issues · 14 patches              │
╰────────────────────────────────────╯
```

--------------------------------

### Create a system user for Radicle

Source: https://radicle.dev/guides/seeder

Creates a dedicated system user and group to isolate Radicle services.

```bash
sudo groupadd --system seed
sudo useradd --system --gid seed --create-home seed
```

--------------------------------

### Retrieve node addresses via CLI

Source: https://radicle.dev/guides/seeder

Run this command as the seed user to output the node addresses for sharing.

```bash
rad node config --addresses
```

--------------------------------

### Inspect Radicle remote configuration

Source: https://radicle.dev/guides/user

Use this command to view the details of the 'rad' remote, including fetch and push URLs and branch tracking configuration.

```bash
$ git remote show rad
* remote rad
  Fetch URL: rad://z31hE1wco9132nedN3mm5qJjyotna
  Push  URL: rad://z31hE1wco9132nedN3mm5qJjyotna/z6MkvZwzK64f3GuDcAs6dEcje89ddfHkBjS1v9Dkh7aCGq3C
  HEAD branch: (unknown)
  Remote branch:
    main tracked
  Local branch configured for 'git pull':
    main merges with remote main
  Local ref configured for 'git push':
    main pushes to main (up to date)
```

--------------------------------

### Push changes to the network

Source: https://radicle.dev/guides/quick-start

Use standard Git commands to push updates to your Radicle-enabled repository.

```bash
$ git push
```

--------------------------------

### Initialize Radicle Identity

Source: https://radicle.dev/guides/quick-start

Creates a cryptographic key pair and registers a node alias.

```bash
$ rad auth
```

--------------------------------

### Display patch details

Source: https://radicle.dev/guides/user

Shows metadata, status, and commit history for a specific patch.

```bash
$ rad patch show e5f0a5a
╭────────────────────────────────────────────────────────────────────────────────╮
│ Title     Add anomalous data from ship 897AF                                   │
│ Patch     e5f0a5a5adaa33c3b931235967e4930ece9bb617                             │
│ Author    paxel (you)                                                          │
│ Head      80b8d420658834afc444a13c03f0c3ff6875a71c                             │
│ Branches  anomalous-data-897af                                                 │
│ Commits   ahead 1, behind 0                                                    │
│ Status    open                                                                 │
│                                                                                │
│ Data from ship 897AF.                                                          │
├────────────────────────────────────────────────────────────────────────────────┤
│ 80b8d42 Add anomalous data from ship 897AF                                     │
├────────────────────────────────────────────────────────────────────────────────┤
│ ● opened by paxel (you) (b766431) 58 minutes ago                               │
│ ↑ updated to 4d0c1156f8ac7af2297d1314cd7556185cd16ae4 (80b8d42) 44 minutes ago │
╰────────────────────────────────────────────────────────────────────────────────╯
```

--------------------------------

### Query the HTTP daemon API

Source: https://radicle.dev/guides/seeder

Verifies that the daemon is responding to requests via the local API.

```bash
curl http://127.0.0.1:8080/api/v1
```

--------------------------------

### Configure a Git alias for patching

Source: https://radicle.dev/guides/quick-start

Add this configuration to your .git/config to simplify the patch creation process to a single command.

```ini
[alias]
    patch = push self HEAD:refs/patches
```

--------------------------------

### Allow a specific repository

Source: https://radicle.dev/guides/seeder

Explicitly enable seeding for a specific repository, overriding a block policy.

```bash
rad seed rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5
```

--------------------------------

### Pull changes from canonical

Source: https://radicle.dev/guides/user

Updates the local working copy with changes from the canonical repository.

```bash
$ git pull
Fetching rad
From rad://z3cyotNHuasWowQ2h4yF9c3tFFdvc
  e81db74..25f8515  main       -> rad/main
Updating e81db74..25f8515
Fast-forward
...
```

--------------------------------

### Checkout a patch

Source: https://radicle.dev/guides/user

Switches to a local branch containing the patch code for review or modification.

```bash
$ rad patch checkout e5f0a5a
✓ Switched to branch patch/e5f0a5a at revision 4d0c1156f8ac7af2297d1314cd7556185cd16ae4
✓ Branch patch/e5f0a5a setup to track rad/patches/e5f0a5a5adaa33c3b931235967e4930ece9bb617
```

--------------------------------

### Restart node service

Source: https://radicle.dev/guides/seeder

Restart the service to apply configuration changes.

```bash
systemctl restart radicle-node
```

--------------------------------

### Change repository visibility to private

Source: https://radicle.dev/guides/user

Update an existing public repository to private status.

```bash
$ rad id update --title "Make private" --visibility private
```

--------------------------------

### Configure Git Alias for Patches

Source: https://radicle.dev/guides/user

Command to create a shortcut for pushing patches to the rad remote.

```bash
$ git config alias.patch 'push rad HEAD:refs/patches'
```

--------------------------------

### Verify SSH Agent Integration

Source: https://radicle.dev/guides/user

Check if the Radicle key is already loaded into the ssh-agent.

```bash
$ rad auth
✓ Radicle key already in ssh-agent
```

--------------------------------

### Synchronize node with network

Source: https://radicle.dev/guides/user

Forces the node to fetch updates from the network when local state is behind.

```bash
$ rad sync --fetch
✓ Fetching rad:z3cyotNHuasWowQ2h4yF9c3tFFdvc from z6MkrLM…ocNYPm7..
✓ Fetching rad:z3cyotNHuasWowQ2h4yF9c3tFFdvc from z6Mkg5Z…4Q8qCHw..
✓ Fetched repository from 2 seed(s)
```

--------------------------------

### Switch to the seed user

Source: https://radicle.dev/guides/seeder

Changes the current session to the dedicated seed user for further configuration.

```bash
sudo su seed
```

--------------------------------

### Configure external addresses in node configuration

Source: https://radicle.dev/guides/seeder

Add your node's public DNS name and port to the node configuration file.

```json
{
  "node": {
    ...
    "externalAddresses": ["seed.radicle.example:8776"]
  }
}
```

--------------------------------

### Tail node logs

Source: https://radicle.dev/guides/seeder

Follow the systemd journal logs for the radicle-node service in real-time.

```bash
journalctl --unit radicle-node --follow
```

--------------------------------

### Configure Git to use Radicle key for commit signing

Source: https://radicle.dev/guides/user

Sets up Git to use a Radicle SSH key for signing commits instead of GPG. Requires Git version 2.34.0 or higher.

```bash
git config user.signingKey "$(rad self --ssh-key)"
git config gpg.format ssh
git config gpg.ssh.program ssh-keygen
git config gpg.ssh.allowedSignersFile .gitsigners
git config commit.gpgsign true
```

--------------------------------

### Configure persistent peer connection

Source: https://radicle.dev/guides/user

Add a peer to the connect list in the node configuration for persistent connections.

```json
"node": {
    ...
    "connect": [
        "z6Mkhp7VUnuufpvuQ3PdysShAjL86VDRUpPpkesqiysDBGs9@odmmeotgcfx65l5hn6ejkaruvai222vs7o7tmtllszqk5xbysolfdd.onion:8776"
    ]
}
```

--------------------------------

### Edit File for Patch Update

Source: https://radicle.dev/guides/user

Opening a file in an editor to prepare changes for a patch update.

```bash
$ vi data/897af.log
```

--------------------------------

### Update repository allow list

Source: https://radicle.dev/guides/user

Grant access to specific DIDs by updating the repository identity.

```bash
$ rad id update --title "Allow Calyx and seed.darkstar.example" \
    --allow did:key:z6Mkgom1bTxdh9fMFxFNXFMw3SbXnma6NARdsfcFuunurCap \
    --allow did:key:z6MkqNZS9QWvC4wbZ8Vz4hQZ1FzN8q4XGj2KGmK9qNgQ8VWt
```

--------------------------------

### Display current seeding policy

Source: https://radicle.dev/guides/seeder

Use this command to check the current default seeding policy configured on your node.

```bash
rad config get node.seedingPolicy
```

--------------------------------

### Visualize Radicle Storage Layout

Source: https://radicle.dev/guides/protocol

Represents the hierarchical file system structure of the Radicle storage root, showing how repositories and peer namespaces are organized.

```text
<storage>                     # Storage root containing all repositories
├─ <rid>                      # Storage for first repository
│  └─ refs                    # All Git references locally stored
│     └─ namespaces           # All peer source trees or "namespaces"
│        ├─ <nid>             # First node's source tree
│        │  └─ refs           # First node's Git references
│        │     ├─ heads       # First node's branches
│        │     │   └─ master  # First node's master branch
│        │     └─ tags        # First node's tags
│        │
│        └─ <nid>             # Second node's source tree
│           ├─ refs           # Second node's references
│           └─ ...
├─ <rid>                      # Storage for second repository
│   ...
└─ <rid>                      # etc.
    ...
```

--------------------------------

### Configure Tor for Radicle

Source: https://radicle.dev/guides/user

Add the service directory and port mapping to the Tor configuration file.

```text
HiddenServiceDir /var/lib/tor/radicle
HiddenServicePort 8776
```

--------------------------------

### Set Directory Ownership for Debian

Source: https://radicle.dev/guides/user

Adjust directory permissions for the debian-tor user on Debian systems.

```bash
$ sudo chown -R debian-tor:debian-tor /var/lib/tor/radicle
```

--------------------------------

### List Radicle remotes

Source: https://radicle.dev/guides/user

Lists remotes managed by Radicle.

```bash
$ rad remote
paxel z6MkvZwzK64f3GuDcAs6dEcje89ddfHkBjS1v9Dkh7aCGq3C (fetch)
rad   (canonical upstream)                             (fetch)
rad   z6Mkgom1bTxdh9fMFxFNXFMw3SbXnma6NARdsfcFuunurCap (push)
```

--------------------------------

### View repository inbox

Source: https://radicle.dev/guides/user

Check the repository inbox to see recent activity and open issues.

```bash
$ rad inbox
╭────────────────────────────────────────────────────────────────────────────────────────────╮
│ dark-star                                                                                  │
├────────────────────────────────────────────────────────────────────────────────────────────┤
│ 004   ●   3e2f653   Add anomalous data from ship 897AF   issue   open   calyx   1 hour ago │
╰────────────────────────────────────────────────────────────────────────────────────────────╯
```

--------------------------------

### Configure selective seeding policy

Source: https://radicle.dev/guides/seeder

Set the default to block to ensure the node only seeds repositories that are explicitly allowed.

```json
{
  "node": {
    ...
    "seedingPolicy": {
      "default": "block"
    }
  }
}
```

--------------------------------

### Check synchronization status

Source: https://radicle.dev/guides/quick-start

View the replication status of your repository across different nodes in the network.

```bash
$ rad sync status
╭──────────────────────────────────────────────────────────────────╮
│ Node ID          Alias                    ?   SigRefs   Since    │
├──────────────────────────────────────────────────────────────────┤
│ (you)            alice                    ✓   a1b2c3d   3m ago   │
│ z6Mkv7G…         seed.example.xyz         ✓   a1b2c3d   2m ago   │
│ z6MkszH…         rad.example.net          ✓   a1b2c3d   2m ago   │
│ z6Mko5W…         garden.example.org       ✗   f4e5d6c   1d ago   │
╰──────────────────────────────────────────────────────────────────╯
```

--------------------------------

### Restart Tor Daemon

Source: https://radicle.dev/guides/user

Apply the new configuration by restarting the Tor service.

```bash
$ sudo systemctl restart tor
```

--------------------------------

### List patches

Source: https://radicle.dev/guides/user

Verify that the patch is no longer active after being merged.

```bash
$ rad patch
Nothing to show.
```

--------------------------------

### Set node listening port

Source: https://radicle.dev/guides/user

Configure the node to listen for incoming connections on a specific port.

```json
"node": {
    ...
    "listen": ["0.0.0.0:8776"]
}
```

--------------------------------

### Configure permissive seeding policy

Source: https://radicle.dev/guides/seeder

Set these values in your configuration to replicate all repository data encountered by the node.

```json
{
  "node": {
    ...
    "seedingPolicy": {
      "default": "allow",
      "scope": "all"
    }
  }
}
```

--------------------------------

### List Remote Branches

Source: https://radicle.dev/guides/user

Command to view remote tracking branches and their association with patches.

```bash
$ git branch --remotes
  calyx@z6Mkgom1bTxdh9fMFxFNXFMw3SbXnma6NARdsfcFuunurCap/main
  rad/main
  rad/patches/e5f0a5a5adaa33c3b931235967e4930ece9bb617
```

--------------------------------

### List Remote References

Source: https://radicle.dev/guides/user

Command to inspect the commit hashes of remote references on the rad remote.

```bash
$ git ls-remote rad
e81db74197f48cc5198d9c03cceaec955af82abf  refs/heads/main
80b8d420658834afc444a13c03f0c3ff6875a71c  refs/heads/patches/e5f0a5a5adaa33c3b931235967e4930ece9bb617
```

--------------------------------

### Configure Full Proxy Mode

Source: https://radicle.dev/guides/user

Settings for routing all traffic through Tor.

```json
"node": {
    ...
    "proxy": "127.0.0.1:9050"
}
```

```json
"node": {
    ...
    "onion": {
        "mode": "forward"
    }
}
```

--------------------------------

### Clone a private repository via a seed node

Source: https://radicle.dev/guides/user

Use the --seed flag to specify the Node ID when cloning a private repository from a trusted peer.

```bash
$ rad clone rad:z3jEQE4VMzkR1UVeSLiN9E8AMtV6a --seed z6MkqNZS9QWvC4wbZ8Vz4hQZ1FzN8q4XGj2KGmK9qNgQ8VWt
```

--------------------------------

### View Git remotes

Source: https://radicle.dev/guides/user

Displays configured Git remotes and their associated Radicle namespaces.

```bash
$ git remote -v
paxel   rad://z3cyotNHuasWowQ2h4yF9c3tFFdvc/z6MkvZwzK64f3GuDcAs6dEcje89ddfHkBjS1v9Dkh7aCGq3C (fetch)
paxel   rad://z3cyotNHuasWowQ2h4yF9c3tFFdvc/z6MkvZwzK64f3GuDcAs6dEcje89ddfHkBjS1v9Dkh7aCGq3C (push)
rad     rad://z3cyotNHuasWowQ2h4yF9c3tFFdvc (fetch)
rad     rad://z3cyotNHuasWowQ2h4yF9c3tFFdvc/z6Mkgom1bTxdh9fMFxFNXFMw3SbXnma6NARdsfcFuunurCap (push)
```

--------------------------------

### View Radicle DID

Source: https://radicle.dev/guides/quick-start

Displays the unique Decentralized Identifier for the current identity.

```bash
$ rad self --did
did:key:z6Mkux1...
```

--------------------------------

### Commit and push changes

Source: https://radicle.dev/guides/user

Stages, commits, and pushes changes to the Radicle node.

```bash
$ git add README.md
$ git commit -m "Add instruction on cloning with Radicle"
$ git push rad master
✓ Synced with 1 node(s)
To rad://z31hE1wco9132nedN3mm5qJjyotna/z6MkvZwzK64f3GuDcAs6dEcje89ddfHkBjS1v9Dkh7aCGq3C
   ecb1bf0..74fb8d2  master -> master
```

--------------------------------

### Unseed a repository

Source: https://radicle.dev/guides/user

Stops seeding a specific repository by its URI.

```bash
$ rad unseed rad:z9DV738hJpCa6aQXqvQC4SjaZvsi
```

--------------------------------

### Display issue details

Source: https://radicle.dev/guides/quick-start

Shows the metadata and content of a specific issue within a repository.

```text
╭───────────────────────────────────────────────────────────────────╮
│ Title   contributing: Feedback from the community                 │
│ Issue   b163597fae51a3f076d654294f695803dd5e221c                  │
│ Author  ade z6MkwGo…yS2aagA                                       │
│ Status  open                                                      │
│                                                                   │
│ Derived from the Zulip conversation.                              │
│                                                                   │
│ - [ ] First contribution guide                                    │
│ - [ ] "good first issues" label usage                             │
│ - [ ] Issue / Patch templates                                     │
│ - [ ] Source code overview map                                    │
│ - [ ] Increase time-to-first-feedback for new contributors        │
│ - [ ] Frequent and recurring open session for community to attend │
│ - [ ] Local CI checks                                             │
╰───────────────────────────────────────────────────────────────────╯
```

--------------------------------

### Check Node Status

Source: https://radicle.dev/guides/quick-start

Displays current node connectivity and network status.

```bash
$ rad node status
✓ Node is running with Node ID z6Mkux1… and listening on 0.0.0.0:8776.

╭────────────────────────────────────────────────────────────────────────╮
│ Node ID    Address                                    ?       Since    │
├────────────────────────────────────────────────────────────────────────┤
│ z6Mkv7G…   seed.example.xyz:8776                      ✓   ↗   3m       │
│ z6MkszH…   radicle.example.net:8776                   ✓   ↗   3m       │
│ z6Mko5W…   garden.example.org:8776                    ✗   ↗   2m       │
╰────────────────────────────────────────────────────────────────────────╯
```

--------------------------------

### Seed a Radicle repository

Source: https://radicle.dev/guides/user

Use the rad seed command to replicate a repository on your node without creating a local working copy.

```bash
$ rad seed rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5
✓ Seeding policy updated for rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5 with scope 'followed'
✓ Fetching rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5 from z6Mkk4R…SBiyXVM..
```

--------------------------------

### Configure EDITOR environment variable

Source: https://radicle.dev/guides/user

Set the EDITOR variable to the full path of your preferred editor to ensure it opens correctly when creating or editing issues.

```bash
export EDITOR=/usr/bin/vim
```

--------------------------------

### Configure onion proxy settings

Source: https://radicle.dev/guides/user

Define the onion proxy mode and address within the node configuration.

```json
"node": {
    ...
    "onion": {
        "mode": "proxy",
        "address": "127.0.0.1:9050"
    }
}
```

--------------------------------

### Extract Radicle binaries

Source: https://radicle.dev/guides/seeder

Extracts the downloaded Radicle archive into the /usr/local directory.

```bash
$ tar -xvJf <archive> --strip-components=1 -C /usr/local/
```
Tokens:
Raw