summaryrefslogtreecommitdiff
path: root/docs/usage.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2026-03-13 22:22:38 +0200
committerPaul Buetow <paul@buetow.org>2026-03-13 22:22:38 +0200
commit8ae4be9684a58d44985e5b5ee5e90f74555b2dde (patch)
tree06029d949bdd549c835855d4b158e3234e277094 /docs/usage.md
parent4d0f11822c1cdf4c51028bde8881756941314821 (diff)
release: v0.22.0v0.22.0
Diffstat (limited to 'docs/usage.md')
-rw-r--r--docs/usage.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/docs/usage.md b/docs/usage.md
index f4f4850..e7b59a8 100644
--- a/docs/usage.md
+++ b/docs/usage.md
@@ -81,8 +81,11 @@ Process text via the configured LLM:
- `cat SOMEFILE.txt | hexai`
- `hexai 'some prompt text here'`
- `cat SOMEFILE.txt | hexai 'some prompt text here'` (stdin and arg are concatenated)
+- `hexai --tps-simulation 12-18` to simulate model output speed without calling a provider
-Defaults: concise answers. If the prompt asks for commands, Hexai outputs only commands. Add the word `explain` to request a verbose explanation. Exit codes: `0` success, `1` provider/config error, `2` no input.
+Defaults: concise answers. If the prompt asks for commands, Hexai outputs only commands. Add the word `explain` to request a verbose explanation. Exit codes: `0` success, `1` provider/config error, `2` no input`.
+
+`--tps-simulation` accepts either a fixed rate such as `20` or a range such as `12-18`. It streams positional arguments, piped stdin, or built-in placeholder text when no input is provided, so you can preview perceived model latency without needing a real provider or local hardware.
### Examples
@@ -101,6 +104,12 @@ hexai 'install ripgrep on macOS'
# Verbose explanation
hexai 'install ripgrep on macOS and explain'
+
+# Simulate 12-18 tokens per second with placeholder text
+hexai --tps-simulation 12-18
+
+# Simulate how a file would feel when streamed back by a model
+cat SOMEFILE.txt | hexai --tps-simulation 20
```
## Hexai Action (TUI)