From b016f808dada54a0525ed68bd03165f1475346bd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Orhun=20Parmaks=C4=B1z?= Date: Wed, 20 Mar 2024 13:10:18 +0300 Subject: [PATCH] docs: add rattler-build-tui documentation --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index db47bd20..fa259784 100644 --- a/README.md +++ b/README.md @@ -344,3 +344,28 @@ IF %ERRORLEVEL% NEQ 0 exit 1 ninja install --verbose ``` + +### 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 | +| ----------------------------------------------------------------- | ------------------------------------------------ | +| Enter | Build package | +| j/k | Next/previous package | +| up, down, left, right | Scroll logs | +| e | Edit recipe (via `$EDITOR`) | +| c, : | Open command prompt (available commands: `edit`) | +| q, ctrl-c, esc, | Quit |