Radicle
Build on Radicle
Read public repositories with a plain fetch('rad:…'), and write issues and comments as the user with window.radicle. A full forge client needs no server.
On this page
If the user enables it, Freedom Browser runs a Radicle node inside the
browser. Pages use it in two ways: the rad: URL scheme
for reads, and window.radicle for everything that needs
consent. Canopy, a GitHub-style forge served from Swarm, is built exactly
this way.
Reads and writes#
Reads: rad: URLs
Any page, including one served from bzz://, can fetch() repository metadata, trees, files, commits, issues and patches as JSON from the user's own node. No prompt, no connection, no API key.
rad: fetch
Writes: window.radicle
Seed and sync repositories, disclose the user's Radicle identity, and write issues, comments, issue state changes and patch comments, each gated by the user's consent and scoped to the page's origin.
window.radicle
Start here#
Radicle repos and issues
Read a repository, get it onto the user's node, and write issues and comments as the user.
window.radicle reference
Provider object, events, errors, permission tiers, input rules and every method.
rad: URLs reference
URL forms, routes, pagination and filters, and error bodies.
Two guides apply to Swarm as well and live in the Overview tab: Permissions and identity and Errors and node readiness.
Related demos#
Canopy
A GitHub-style forge for the Radicle network, served from Swarm and powered by the user's own node.
rad: fetch window.radicle
radicle-index-service, which indexes the Radicle network and publishes the index to Swarm, is listed under ecosystem tooling.