/radicle-vscode-extension

A VS Code extension bringing support for the Radicle network to your IDE.

Primary LanguageTypeScriptApache License 2.0Apache-2.0

radicle-screenshot

Radicle VS Code Extension

Visual Studio Marketplace Version Visual Studio Marketplace Installs rad: - z2BdUVZFvHdxRfdtGJQdSH2kyXNM6

A VS Code extension bringing support for the Radicle network to your IDE.

Radicle is a GitHub alternative bringing familiar features like Pull Requests, Issues, etc, via a peer-to-peer, free and open-source network built on top of Git.

NOTE: The extension currently offers partial support for the latest version of the Radicle CLI (codename "Heartwood"). Support for Radicle Patches is under active development and further features like Issues are next on the pipeline.

Features

See the latest, as well as upcoming, updates in the πŸ—’οΈ Change Log.

  • πŸ–²οΈ Radicle Commands everywhere you need them
  • πŸ“‹ Patches View offers a glance at the status of code changes in your project
  • πŸ“‘ Patch Detail View offers in-depth information for a specific patch
  • πŸ” Integrated Authentication eases your Radicle Identity management
  • πŸ“₯ Cloning of seeded Radicle projects
  • πŸ—ΊοΈ Onboarding Flow with tips tuned to whichever state your Workspace is in when starting out
  • πŸ•΅οΈβ€β™‚οΈ Troubleshooting Flow helping you point the extension to a Radicle CLI binary (if it didn't already auto-resolve)
  • πŸŽ›οΈ Configurable via VS Code's native Settings
  • πŸ“œ Integrated Logging including Radicle CLI's command output

Integrated Radicle Commands

  • Run common Radicle commands with dedicated buttons from within the main extension View

    Buttons to execute Radicle commands in the main extension View

  • Run Radicle commands from within VS Code's Command Palette

    Execute Radicle commands from within VS Code's Command Palette

  • Sync with the Radicle network with a dedicated button among the native Source Control View's title buttons (above commit message input)

    Sync with the Radicle network with a dedicated button among the native Source Control View's title buttons (above commit message input)

  • Find Radicle commands grouped as a "Radicle" submenu inside the native Source Control View's three-dot-menu

    Find Radicle commands grouped as a "Radicle" submenu inside the native Source Control View's three-dot-menu

Patches View

Browse Radicle Patches, check out their associated git branches and inspect their file changes and diffs.

screenshot of Radicle Patches view

Patch Detail View

Inspect all details you'd want to know about a patch including discussions, details of a specific revision as well as all events that took place during the lifetime of the patch.

Patch detail view

Integrated Authentication

  • Create a new Radicle identity, if none exists in your configured Radicle home directory

    Create new identity

  • Unlock an existing identity

    Unlock existing identity

  • De-authenticate your currently unlocked identity

    de-authenticate identity

Cloning

  • Invoke the CLI's rad clone command from the Command Palette

    rad clone listed in command palette

  • Select from a filterable list of projects that your Radicle node is seeding

    rad clone listed projects

  • Open the newly cloned repo in another VS Code window with a single click

    rad clone success

Onboarding Flow

  • No folder opened in Workspace

    no folder opened in Workspace

  • Non-git-initialized folder opened in Workspace

    Non-git-initialized folder opened in Workspace

  • Non-radicle-initialized repo opened in Workspace

    Non-radicle-initialized repo opened in Workspace

Troubleshooting Flow

Troubleshooting Flow

Configurable

Set environment variables for the Radicle CLI and more from VS Code's settings

Extension configurations

Integrated Logging

Integrated logging

Contributing

Please see the Contribution Guide.