Luigit
repositories / pi-ext

pi-ext

bugabingas pi extensions

owned by admin

extensions/rtk/README.md

Raw
Rendered preview
rtk

rtk

Keep routine command output compact so Pi can spend less context on it.

rtk demo: ordinary git calls return RTK's compact output

Use

Install rtk version 0.23.0 or later, then use Pi normally. There is nothing to invoke. When Pi runs commands through a registered shell tool, this extension asks RTK to rewrite them before execution. This includes Bash, PowerShell, or Nushell tools exposing a string command input, not only Bash. You see RTK's more compact command output in Pi, such as for git status and git log.

Prefix one command with RTK_DISABLED=1 when you need Pi to run it without RTK:

RTK_DISABLED=1 git log

If RTK is unavailable, too old, or times out, Pi runs the original command instead. When RTK offers no rewrite, some system-status commands use rtk summary; other commands run unchanged.

rtk.rewriteTimeoutMs controls how long Pi waits for RTK. The default is 2000 milliseconds. Change it only when the default does not suit your machine:

{
  "rtk": { "rewriteTimeoutMs": 5000 }
}

Installation

Reference

Setting names

Setting Environment
rtk.rewriteTimeoutMs PI_RTK_REWRITE_TIMEOUT_MS

Setting values

Setting Default Valid values Purpose
rtk.rewriteTimeoutMs 2000 Integer 1–2147483647 Command rewrite timeout: Maximum milliseconds for RTK version probes and rewrites.
<img src="assets/banner.svg" alt="rtk" height="70">

# rtk

Keep routine command output compact so Pi can spend less context on it.

![rtk demo: ordinary git calls return RTK's compact output](assets/demo.gif)

## Use

Install `rtk` version 0.23.0 or later, then use Pi normally.
There is nothing to invoke.
When Pi runs commands through a registered shell tool, this extension asks RTK to rewrite them before execution.
This includes Bash, PowerShell, or Nushell tools exposing a string `command` input, not only Bash.
You see RTK's more compact command output in Pi, such as for `git status` and `git log`.

Prefix one command with `RTK_DISABLED=1` when you need Pi to run it without RTK:

```text
RTK_DISABLED=1 git log
```

If RTK is unavailable, too old, or times out, Pi runs the original command instead.
When RTK offers no rewrite, some system-status commands use `rtk summary`; other commands run unchanged.

`rtk.rewriteTimeoutMs` controls how long Pi waits for RTK.
The default is 2000 milliseconds.
Change it only when the default does not suit your machine:

```json
{
  "rtk": { "rewriteTimeoutMs": 5000 }
}
```

[Installation](../../README.md#install)

## Reference

<!-- config:start -->
### Setting names

| Setting | Environment |
| --- | --- |
| `rtk.rewriteTimeoutMs` | `PI_RTK_REWRITE_TIMEOUT_MS` |

#### Setting values

| Setting | Default | Valid values | Purpose |
| --- | --- | --- | --- |
| `rtk.rewriteTimeoutMs` | `2000` | Integer 1–2147483647 | Command rewrite timeout: Maximum milliseconds for RTK version probes and rewrites. |
<!-- config:end -->