Files
radicle-explorer/desktop/README.md
T
Daniel Norman 068263a272 desktop: Register releases with radicle-artifact
- Add a register phase after tag, like httpd's build/register
- Record the DMG, deb and AppImage in the release of the tag, with
  their files.radicle.dev URLs and sha256
- Move the Zulip announcement into its own announce phase
- Document how to install rad-artifact in README.md
2026-11-10 13:32:16 +01:00

117 lines
3.2 KiB
Markdown

# Radicle Desktop
This desktop application lets you interact with [Radicle][rad], a peer-to-peer
code collaboration and publishing stack.
It lives in the `desktop/` folder of the radicle-gui repository, next to the
Radicle web explorer. Install dependencies at the repository root, and run all
other commands below from `desktop/`.
## Installation
See [radicle.dev/desktop#install](https://radicle.dev/desktop#install).
### From source
**Prerequisites:**
- [Node.js][nod] (24 or higher) and [npm][npm]
- [Rust][rus] toolchain (1.77 or higher)
- [Tauri system dependencies][tau]
On Windows, NPM's script shell must be set to a POSIX compatible shell such as
[Git Bash][gfw]:
```
npm config set script-shell "C:\\Program Files\\git\\bin\\bash.exe"
```
Run the following commands to build the desktop app locally:
```
git clone https://seed.radicle.dev/z4V1sjrXqjvFdnCUbxPFqd5p4DtH5.git radicle-gui
cd radicle-gui
npm ci -w desktop
cd desktop
npm run tauri build
```
Then run one of the builds that the script outputs at the end.
## Development
To start the app in development mode with hot reload:
```
npm run dev
```
To log how long every backend command takes, for performance work, set
`VITE_LOG_INVOKE_TIMINGS=true`. Each call then prints
`[invoke] <command> <ms>ms` to the browser console (visible at debug level):
```
VITE_LOG_INVOKE_TIMINGS=true npm run dev
```
A dev build uses its own identifier, so it runs next to an installed release,
and it never registers itself as the handler for `rad:` links. On Linux and
Windows, open a link in it by starting the dev binary a second time with the
link as its argument, while `npm run dev` is running:
```
target/dev-without-assertions/radicle-desktop rad:z4V1sjrXqjvFdnCUbxPFqd5p4DtH5
```
On macOS links only reach app bundles. Quit the installed app, then build and
open a debug bundle:
```
npm run tauri build -- --debug --bundles app
```
## Releasing
The release tag is signed with your Radicle key. Set up Git to sign with it:
```
git config set gpg.format ssh
git config set user.signingKey "$(rad self --ssh-key)"
```
The `register` phase records each release file, its download URL and its
`sha256` in the release of the tag with radicle-artifact. Install it with:
```
curl -sSf https://files.radicle.dev/releases/radicle-artifact/install | sh
```
Releases are driven by an interactive, phased script. Start one with:
```
scripts/release --phase prep --version X.Y.Z
```
Each phase does its mechanical work, then prints the manual tasks for its gate
and the exact flag to resume with. List the phases and see the configuration
with `scripts/release --list` and `scripts/release --help`. Releases are tagged
`releases/desktop/<version>`.
## Getting in touch
To get in touch with the maintainers, sign up to our [official chat on
Zulip][zul].
## License
The UI is distributed under the terms of GPLv3. See [LICENSE][lic] for details.
[gfw]: https://gitforwindows.org
[lic]: ./LICENSE
[rad]: https://radicle.dev
[nod]: https://nodejs.org
[npm]: https://www.npmjs.com
[rus]: https://www.rust-lang.org/
[tau]: https://v2.tauri.app/start/prerequisites/#system-dependencies
[zul]: https://radicle.zulipchat.com/#narrow/stream/444463-desktop