Radish alpha
r
radicle-tui
Radicle terminal user interface
Radicle
Git (anonymous pull)
Log in to clone via SSH
Commits ›
Major update to README
Erik Kundt committed 2 years ago
commit 33f9f3584a351892a4008dfe7042590847c5fba5
parent a3c67ff95d252d017930af0a3a9f531cac34d060
2 files changed +46 -11
modified README.md
@@ -1,14 +1,14 @@
# radicle-tui
- 
*Radicle terminal user interfaces*
+ 
_Radicle terminal user interfaces_



## Installation



**Requirements**
- 
* *Linux* or *Unix* based operating system.
- 
* Git 2.34 or later
- 
* OpenSSH 9.1 or later with `ssh-agent`
+ 
- _Linux_ or _Unix_ based operating system.
+ 
- Git 2.34 or later
+ 
- OpenSSH 9.1 or later with `ssh-agent`



### 📦 From source
@@ -23,11 +23,50 @@ Or directly from our seed node:


    cargo install --force --locked --git https://seed.radicle.xyz/z39mP9rQAaGmERfUMPULfPUi473tY.git
- 
This will install `rad-tui`. You can execute it by running `rad tui`.
+ 
This will install `rad-tui`. You can execute it by running `rad tui`. All available commands can be shown by running `rad tui --help`.
- 
## Commands
+ 
## Interfaces
- 
All available commands can be shown by running `rad tui --help`.
+ 
The Radicle terminal interfaces are designed to be modular and to integrate well with the existing Radicle CLI. Right now, they are meant to be called from other programs that will collect and process their output.
+
+ 
### Usage
+
+ 
#### Patches
+
+ 
Select a patch and an operation, return both formatted as `rad` command:
+
+ 
```
+ 
$ rad tui patch select
+ 
rad patch show 546443226b300484a97a2b2d7c7000af6e8169ba (stderr)
+ 
```
+
+ 
Same as above:
+
+ 
```
+ 
$ rad tui patch select --operation
+ 
rad patch show 546443226b300484a97a2b2d7c7000af6e8169ba (stderr)
+ 
```
+
+ 
Select a patch and an operation, return both as JSON:
+
+ 
```
+ 
$ rad tui patch select --operation --json
+ 
{ "operation": "show", "id": "546443226b300484a97a2b2d7c7000af6e8169ba" } (stderr)
+ 
```
+
+ 
Select a patch only and return its id:
+
+ 
```
+ 
$ rad tui patch select --id
+ 
546443226b300484a97a2b2d7c7000af6e8169ba (stderr)
+ 
```
+
+ 
Select a patch only and return its id as JSON:
+
+ 
```
+ 
$ rad tui patch select --id --json
+ 
{ "operation": "null", "id": "546443226b300484a97a2b2d7c7000af6e8169ba" } (stderr)
+ 
```



## License
deleted out.txt
@@ -1,4 +0,0 @@
- 
   Compiling radicle-tui v0.1.0 (/home/erikli/projects/radicle/dev/radicle-tui)
- 
    Finished dev [unoptimized + debuginfo] target(s) in 4.38s
- 
     Running `target/debug/rad-tui patch select --operation`
- 
rad patch checkout 534e768883ac507f3ec1f4f9da67623486cd0657