Radish alpha
h
heartwood
Radicle Heartwood Protocol & Stack
Radicle
Git (anonymous pull)
Log in to clone via SSH
Commits ›
cli/completion: static shell completion for `rad`
✗ CI failure Fintan Halpenny committed 6 months ago
commit 6e3fdea50f2827dda9549439f8e226d0c88bdfb5
parent 7ccdd4c810355ca2fe50243f1074229ccc191032
1 passed 4 failed (5 total) View logs
5 files changed +103 -31
modified Cargo.lock
@@ -478,6 +478,15 @@ dependencies = [
]



[[package]]
+ 
name = "clap_complete"
+ 
version = "4.5.60"
+ 
source = "registry+https://github.com/rust-lang/crates.io-index"
+ 
checksum = "8e602857739c5a4291dfa33b5a298aeac9006185229a700e5810a3ef7272d971"
+ 
dependencies = [
+ 
 "clap",
+ 
]
+
+ 
[[package]]

name = "clap_derive"

version = "4.5.41"

source = "registry+https://github.com/rust-lang/crates.io-index"
@@ -2819,6 +2828,7 @@ dependencies = [
 "anyhow",

 "chrono",

 "clap",
+ 
 "clap_complete",

 "dunce",

 "human-panic",

 "itertools",
modified README.md
@@ -53,6 +53,47 @@ Or directly from our seed node:
        --git https://seed.radicle.xyz/z3gqcJUoA1n9HaHKufZs5FCSGazv5.git \

        crates/radicle-cli crates/radicle-node crates/radicle-remote-helper
+ 
## `rad` Shell Completions
+
+ 
A `rad completion` subcommand is provided to generate static completions for your favorite shell.
+
+ 
### Bash
+
+ 
```
+ 
echo 'source <(rad completion bash)' >> ~/.bashrc
+ 
```
+
+ 
### Zsh
+
+ 
```
+ 
echo 'source <(rad completion zsh)' >> ~/.zshrc
+ 
```
+
+ 
### Fish
+
+ 
```
+ 
rad completion fish > ~/.config/fish/completions/rad.fish
+ 
```
+
+ 
### PowerShell
+
+ 
```
+ 
Add-Content $PROFILE "`nInvoke-Expression (rad completion powershell | Out-String)"
+ 
```
+
+ 
### Elvish
+
+ 
Add to `~/.elvish/rc.elv` (or `~/.config/elvish/rc.elv`)
+ 
```
+ 
eval (rad completion elvish | slurp)
+ 
```
+
+ 
Or save to a file and source it
+ 
```
+ 
rad completion elvish > ~/.elvish/lib/rad.elv
+ 
echo 'use rad' >> ~/.elvish/rc.elv
+ 
```
+ 


## Running



*Systemd* unit files are provided for the node under the `/systemd` folder.
modified crates/radicle-cli/Cargo.toml
@@ -17,6 +17,7 @@ path = "src/main.rs"
anyhow = "1"

chrono = { workspace = true, features = ["clock", "std"] }

clap = { version = "4.5.44", features = ["derive"] }
+ 
clap_complete = "4.5"

dunce = { workspace = true }

human-panic.workspace = true

itertools.workspace = true
modified crates/radicle-cli/examples/rad-help.md
@@ -12,36 +12,37 @@ Do you have feedback?
Usage: rad <COMMAND>



Commands:
- 
  auth      Manage identities and profiles
- 
  block     Block repositories or nodes from being seeded or followed
- 
  checkout  Checkout a repository into the local directory
- 
  clean     Remove all remotes from a repository
- 
  clone     Clone a Radicle repository
- 
  config    Manage your local Radicle configuration
- 
  debug     Write out information to help debug your Radicle node remotely
- 
  follow    Manage node follow policies
- 
  fork      Create a fork of a repository
- 
  id        Manage repository identities
- 
  inbox     Manage your Radicle notifications
- 
  init      Initialize a Radicle repository
- 
  inspect   Inspect a Radicle repository
- 
  issue     Manage issues
- 
  ls        List repositories
- 
  node      Control and query the Radicle Node
- 
  patch     Manage patches
- 
  path      Display the Radicle home path
- 
  publish   Publish a repository to the network
- 
  remote    Manage a repository's remotes
- 
  seed      Manage repository seeding policies
- 
  self      Show information about your identity and device
- 
  stats     Displays aggregated repository and node metrics
- 
  sync      Sync repositories to the network
- 
  unblock   Unblock repositories or nodes to allow them to be seeded or followed
- 
  unfollow  Unfollow a peer
- 
  unseed    Remove repository seeding policies
- 
  watch     Wait for some state to be updated
- 
  version   Print the version information of the CLI
- 
  help      Print this message or the help of the given subcommand(s)
+ 
  auth        Manage identities and profiles
+ 
  block       Block repositories or nodes from being seeded or followed
+ 
  checkout    Checkout a repository into the local directory
+ 
  clean       Remove all remotes from a repository
+ 
  clone       Clone a Radicle repository
+ 
  config      Manage your local Radicle configuration
+ 
  debug       Write out information to help debug your Radicle node remotely
+ 
  follow      Manage node follow policies
+ 
  fork        Create a fork of a repository
+ 
  id          Manage repository identities
+ 
  inbox       Manage your Radicle notifications
+ 
  init        Initialize a Radicle repository
+ 
  inspect     Inspect a Radicle repository
+ 
  issue       Manage issues
+ 
  ls          List repositories
+ 
  node        Control and query the Radicle Node
+ 
  patch       Manage patches
+ 
  path        Display the Radicle home path
+ 
  publish     Publish a repository to the network
+ 
  remote      Manage a repository's remotes
+ 
  seed        Manage repository seeding policies
+ 
  self        Show information about your identity and device
+ 
  stats       Displays aggregated repository and node metrics
+ 
  sync        Sync repositories to the network
+ 
  unblock     Unblock repositories or nodes to allow them to be seeded or followed
+ 
  unfollow    Unfollow a peer
+ 
  unseed      Remove repository seeding policies
+ 
  watch       Wait for some state to be updated
+ 
  version     Print the version information of the CLI
+ 
  completion  Print static completion information for a given shell
+ 
  help        Print this message or the help of the given subcommand(s)



Options:

  -h, --help
modified crates/radicle-cli/src/main.rs
@@ -7,7 +7,7 @@ use std::{io::ErrorKind, process};
use anyhow::anyhow;

use clap::builder::styling::AnsiColor;

use clap::builder::Styles;
- 
use clap::{Parser, Subcommand};
+ 
use clap::{CommandFactory as _, Parser, Subcommand};



use radicle::version::Version;

use radicle_cli::commands::*;
@@ -98,6 +98,12 @@ enum Command {
        json: bool,

    },
+ 
    /// Print static completion information for a given shell
+ 
    Completion {
+ 
        /// The type of shell to provide static completions for
+ 
        shell: clap_complete::Shell,
+ 
    },
+ 


    #[command(external_subcommand)]

    External(Vec<OsString>),

}
@@ -176,10 +182,23 @@ fn run_command(command: Command, ctx: impl term::Context) -> Result<(), anyhow::
        Command::Unseed(args) => unseed::run(args, ctx),

        Command::Watch(args) => watch::run(args, ctx),

        Command::Version { json } => write_version(json),
+ 
        Command::Completion { shell } => {
+ 
            print_completions(shell, &mut CliArgs::command());
+ 
            Ok(())
+ 
        }

        Command::External(args) => ExternalCommand::new(args).run(),

    }

}
+ 
fn print_completions<G: clap_complete::Generator>(generator: G, cmd: &mut clap::Command) {
+ 
    clap_complete::generate(
+ 
        generator,
+ 
        cmd,
+ 
        cmd.get_name().to_string(),
+ 
        &mut io::stdout(),
+ 
    );
+ 
}
+ 


struct ExternalCommand {

    command: OsString,

    args: Vec<OsString>,