Skip to content

Commit

Permalink
docs: add rattler-build-tui documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
orhun committed Mar 20, 2024
1 parent 2a34928 commit b016f80
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -344,3 +344,28 @@ IF %ERRORLEVEL% NEQ 0 exit 1
ninja install --verbose
```
</details>

### Terminal User Interface (TUI)

`rattler-build` offers a terminal user interface for building multiple packages and viewing the logs.

![rattler-build-tui](https://github.com/prefix-dev/rattler-build/assets/24392180/52138fd0-3c53-4028-a2c8-3099222c368a)

To launch the TUI, run the `build` command with the `--tui` flag as shown below:

```shell
$ rattler-build build -r recipe.yml --tui
```

> [!NOTE] > `rattler-build-tui` is gated behind the `tui` feature flag to avoid extra dependencies. Build the project with `--features tui` arguments to enable the TUI functionality.

#### Key Bindings

| Key | Action |
| ----------------------------------------------------------------- | ------------------------------------------------ |
| <kbd>Enter</kbd> | Build package |
| <kbd>j</kbd>/<kbd>k</kbd> | Next/previous package |
| <kbd>up</kbd>, <kbd>down</kbd>, <kbd>left</kbd>, <kbd>right</kbd> | Scroll logs |
| <kbd>e</kbd> | Edit recipe (via `$EDITOR`) |
| <kbd>c</kbd>, <kbd>:</kbd> | Open command prompt (available commands: `edit`) |
| <kbd>q</kbd>, <kbd>ctrl-c</kbd>, <kbd>esc</kbd>, | Quit |

0 comments on commit b016f80

Please sign in to comment.