mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-06 09:20:43 +00:00
docs(tokenjuice): add bundled plugin guide (#70038)
* docs(tokenjuice): add bundled plugin guide * docs(tokenjuice): sort nav entry
This commit is contained in:
@@ -1226,6 +1226,7 @@
|
||||
"tools/pdf",
|
||||
"tools/reactions",
|
||||
"tools/thinking",
|
||||
"tools/tokenjuice",
|
||||
"tools/video-generation"
|
||||
]
|
||||
},
|
||||
|
||||
@@ -104,11 +104,12 @@ legacy `tools.bash.*` aliases normalize to the same protected exec paths.
|
||||
|
||||
Plugins can register additional tools. Some examples:
|
||||
|
||||
- [Lobster](/tools/lobster) — typed workflow runtime with resumable approvals
|
||||
- [LLM Task](/tools/llm-task) — JSON-only LLM step for structured output
|
||||
- [Music Generation](/tools/music-generation) — shared `music_generate` tool with workflow-backed providers
|
||||
- [Diffs](/tools/diffs) — diff viewer and renderer
|
||||
- [LLM Task](/tools/llm-task) — JSON-only LLM step for structured output
|
||||
- [Lobster](/tools/lobster) — typed workflow runtime with resumable approvals
|
||||
- [Music Generation](/tools/music-generation) — shared `music_generate` tool with workflow-backed providers
|
||||
- [OpenProse](/prose) — markdown-first workflow orchestration
|
||||
- [Tokenjuice](/tools/tokenjuice) — compact noisy `exec` and `bash` tool results
|
||||
|
||||
## Tool configuration
|
||||
|
||||
|
||||
76
docs/tools/tokenjuice.md
Normal file
76
docs/tools/tokenjuice.md
Normal file
@@ -0,0 +1,76 @@
|
||||
---
|
||||
title: "Tokenjuice"
|
||||
summary: "Compact noisy exec and bash tool results with an optional bundled plugin"
|
||||
read_when:
|
||||
- You want shorter `exec` or `bash` tool results in OpenClaw
|
||||
- You want to enable the bundled tokenjuice plugin
|
||||
- You need to understand what tokenjuice changes and what it leaves raw
|
||||
---
|
||||
|
||||
# Tokenjuice
|
||||
|
||||
`tokenjuice` is an optional bundled plugin that compacts noisy `exec` and `bash`
|
||||
tool results after the command has already run.
|
||||
|
||||
It changes the returned `tool_result`, not the command itself. Tokenjuice does
|
||||
not rewrite shell input, rerun commands, or change exit codes.
|
||||
|
||||
Today this applies to Pi embedded runs, where tokenjuice hooks the embedded
|
||||
`tool_result` path and trims the output that goes back into the session.
|
||||
|
||||
## Enable the plugin
|
||||
|
||||
Fast path:
|
||||
|
||||
```bash
|
||||
openclaw config set plugins.entries.tokenjuice.enabled true
|
||||
```
|
||||
|
||||
Equivalent:
|
||||
|
||||
```bash
|
||||
openclaw plugins enable tokenjuice
|
||||
```
|
||||
|
||||
OpenClaw already ships the plugin. There is no separate `plugins install`
|
||||
or `tokenjuice install openclaw` step.
|
||||
|
||||
If you prefer editing config directly:
|
||||
|
||||
```json5
|
||||
{
|
||||
plugins: {
|
||||
entries: {
|
||||
tokenjuice: {
|
||||
enabled: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
## What tokenjuice changes
|
||||
|
||||
- Compacts noisy `exec` and `bash` results before they are fed back into the session.
|
||||
- Keeps the original command execution untouched.
|
||||
- Preserves exact file-content reads and other commands that tokenjuice should leave raw.
|
||||
- Stays opt-in: disable the plugin if you want verbatim output everywhere.
|
||||
|
||||
## Verify it is working
|
||||
|
||||
1. Enable the plugin.
|
||||
2. Start a session that can call `exec`.
|
||||
3. Run a noisy command such as `git status`.
|
||||
4. Check that the returned tool result is shorter and more structured than the raw shell output.
|
||||
|
||||
## Disable the plugin
|
||||
|
||||
```bash
|
||||
openclaw config set plugins.entries.tokenjuice.enabled false
|
||||
```
|
||||
|
||||
Or:
|
||||
|
||||
```bash
|
||||
openclaw plugins disable tokenjuice
|
||||
```
|
||||
Reference in New Issue
Block a user