https://github.com/radicle-dev/radicle-cli

Radicle CLI
https://github.com/radicle-dev/radicle-cli

Last synced: 7 days ago
JSON representation

Radicle CLI

• Host: GitHub
• URL: https://github.com/radicle-dev/radicle-cli
• Owner: radicle-dev
• License: gpl-3.0
• Archived: true
• Created: 2021-07-19T11:12:56.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-03-27T20:36:00.000Z (over 1 year ago)
• Last Synced: 2024-08-01T15:35:42.049Z (3 months ago)
• Language: Rust
• Homepage: https://app.radicle.network/alt-clients.radicle.eth/radicle-cli
• Size: 1.25 MB
• Stars: 87
• Watchers: 9
• Forks: 25
• Open Issues: 53
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
⚠️ **Notice**: Development of the Radicle CLI has moved to the [Heartwood repository](https://github.com/radicle-dev/heartwood). This repository is being deprecated.

---

# Radicle CLI

> ✨ Command-line tooling for Radicle.

## Documentation

See the [getting started guide](https://radicle.xyz/get-started.html) for setup and usage instructions.

## Contributing

The Radicle CLI is still under development. Contributions are always welcome! Please check the [contributing page](https://app.radicle.xyz/seeds/clients.radicle.xyz/rad:git:hnrkmg77m8tfzj4gi4pa4mbhgysfgzwntjpao/tree/cc80d84ea5be6466647777224c1131b2e0ad11c8/CONTRIBUTING.md) if you want to help.

## Installation

### 📦 From source

You can install the Radicle CLI and supporting tools by running the

following command from inside this repository:

    cargo install --path cli --force --locked

Or directly from our seed node:

    cargo install radicle-cli --force --locked --git https://seed.alt-clients.radicle.xyz/radicle-cli.git

> **Note**

> It's recommended to install release builds since development builds may be incompatible with the network.

### 🐳 From Dockerfile

Alternatively you can build the Radicle CLI docker `rad` by running the

following command from inside this repository:

    docker build . -t rad

And then to use it:

    docker run -it --rm rad --help

> **Note**

> It's recommended to install release builds since development builds may be incompatible with the network.

### 🐧 From APT (Debian/Ubuntu)

First, download the package signing key:

    curl -fsSL https://europe-west6-apt.pkg.dev/doc/repo-signing-key.gpg | gpg --dearmor | sudo tee /usr/share/keyrings/radicle-archive-keyring.gpg > /dev/null

Then update your sources list with the radicle repository by creating a registry file:

    echo "deb [arch=amd64 signed-by=/usr/share/keyrings/radicle-archive-keyring.gpg] https://europe-west6-apt.pkg.dev/projects/radicle-services radicle-cli main" | sudo tee -a /etc/apt/sources.list.d/radicle-registry.list

Then update the package list and install `radicle-cli`:

    sudo apt update

    sudo apt install radicle-cli

### 🍺 From Homebrew

    brew tap --force-auto-update radicle/cli https://pine.radicle.garden/radicle-cli-homebrew.git

    brew install radicle-cli

### 🐧 From AUR (Arch)

We provide an [AUR package](https://aur.archlinux.org/packages/radicle-cli-bin) containing precompiled

binaries.  In order to use it, you can follow the [official installation

instructions](https://wiki.archlinux.org/title/Arch_User_Repository#Installing_and_upgrading_packages), or use

any of the [AUR Helpers](https://wiki.archlinux.org/title/AUR_helpers) available.