Skip to content

Commit aad0000

Browse files
FredrikMWoldFredrikMWold
committed
chore: imporve readme
1 parent 8d4ef37 commit aad0000

3 files changed

Lines changed: 109 additions & 10 deletions

File tree

‎README.md‎

Lines changed: 41 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,46 @@
11
# radix-tui
22

3-
A simple TUI for radix
3+
[![Go Reference](https://pkg.go.dev/badge/github.com/FredrikMWold/radix-tui.svg)](https://pkg.go.dev/github.com/FredrikMWold/radix-tui)
4+
[![Release](https://img.shields.io/github/v/release/FredrikMWold/radix-tui?sort=semver)](https://github.com/FredrikMWold/radix-tui/releases)
45

5-
## Installation
6-
the tui requires that you have the [radix-cli](https://github.com/equinor/radix-cli) installed on your system. You can install the tui by running the following commands:
6+
**keyboard-first TUI for Radix applications and pipelines**, built with [Bubble Tea](https://github.com/charmbracelet/bubbletea). Browse applications, inspect environments and recent jobs, open job details in your browser, and trigger Build & Deploy or Apply Config right from your terminal.
77

8-
#### Install radix-cli
9-
```bash
10-
go install github.com/equinor/radix-cli/cli/rx@latest
11-
```
12-
#### Install radix-tui
13-
```bash
8+
![Demo](./radix-tui-demo.gif)
9+
10+
<details>
11+
<summary><strong>Quick keys</strong></summary>
12+
13+
| Context | Key | Action |
14+
|---|---|---|
15+
| Applications | `↑`/`↓` | Move selection |
16+
| Applications | `Enter` | Select application |
17+
| Pipeline | `↑`/`↓` | Move selection |
18+
| Pipeline | `Enter` | Open job in browser |
19+
| Pipeline | `Ctrl+n` | Build & Deploy form |
20+
| Pipeline | `Ctrl+a` | Apply Config form |
21+
| Pipeline | `Ctrl+r` | Refresh application |
22+
| Anywhere | `Esc` | Back (context aware) |
23+
| Anywhere | `q`/`Ctrl+C` | Quit |
24+
25+
> Tip: The help footer updates based on what you can do in the current view.
26+
27+
</details>
28+
29+
## Features
30+
31+
- 🧭 Browse Radix applications and environments
32+
- 📊 See recent pipeline jobs with status and timestamps
33+
- ⚙️ Trigger Build & Deploy or Apply Config from dedicated forms
34+
- 🌐 Open the selected job in your default browser
35+
36+
## Install
37+
38+
Install with Go:
39+
40+
```sh
1441
go install github.com/FredrikMWold/radix-tui@latest
15-
```
42+
```
43+
44+
Or download a prebuilt binary from Releases and place it on your PATH:
45+
46+
- https://github.com/FredrikMWold/radix-tui/releases

‎radix-tui-demo.gif‎

483 KB
Loading

‎radix-tui-demo.tape‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
Output radix-tui-demo.gif
2+
3+
# Terminal appearance and environment
4+
Set FontSize 24
5+
Set FontFamily "MesloLGS NF"
6+
Set Theme "Catppuccin Mocha"
7+
Set Width 1800
8+
Set Height 900
9+
Set Padding 10
10+
Set Margin 30
11+
Set MarginFill "#674EFF"
12+
Set BorderRadius 12
13+
Set Shell zsh
14+
15+
# Build the app and set demo mode
16+
Hide
17+
Type "go build -o radix-tui ."
18+
Enter
19+
Type `export RADIX_TUI_DEMO=1`
20+
Enter
21+
Type "clear"
22+
Enter
23+
Show
24+
25+
# Launch the TUI with mocked data
26+
Type "./radix-tui"
27+
Enter
28+
Sleep 2.0s
29+
30+
# Navigate applications list and open one
31+
Down
32+
Sleep 600ms
33+
Up
34+
Sleep 600ms
35+
Enter
36+
Sleep 1.2s
37+
38+
# Browse pipeline jobs (right pane)
39+
Down
40+
Sleep 500ms
41+
Down
42+
Sleep 500ms
43+
Down
44+
Sleep 500ms
45+
Up
46+
Sleep 700ms
47+
48+
# Return to applications and pick another
49+
Escape
50+
Sleep 800ms
51+
Down
52+
Sleep 500ms
53+
Down
54+
Sleep 500ms
55+
Enter
56+
Sleep 1.2s
57+
58+
# Scroll pipeline again
59+
Down
60+
Sleep 500ms
61+
Down
62+
Sleep 500ms
63+
Up
64+
Sleep 600ms
65+
66+
# Quit the demo
67+
Type "q"
68+
Sleep 800ms

0 commit comments

Comments
 (0)