Mirrors/openclaw
1
0
Fork 0
mirror of https://github.com/openclaw/openclaw.git synced 2026-05-01 06:05:05 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
c4e5ca8625177f17e9e36330c9c256fb7bb2a900
openclaw/docs/cli/tui.md
fuller-stack-dev 561f2e52c7 docs(tui): document local config repair flow (#69995) (thanks @fuller-stack-dev) 
* docs(tui): document local config repair flow

* docs(tui): clarify local TUI examples

* docs(config): gate local TUI repair flow

* docs(tui): fix local repair docs

---------

Co-authored-by: Ayaan Zaidi <hi@obviy.us>
2026-04-22 11:42:59 +05:30

2.1 KiB
Raw Blame History

summary, read_when, title
summary read_when title
CLI reference for `openclaw tui` (Gateway-backed or local embedded terminal UI)
You want a terminal UI for the Gateway (remote-friendly)
You want to pass url/token/session from scripts
You want to run the TUI in local embedded mode without a Gateway
You want to use openclaw chat or openclaw tui --local
tui

openclaw tui

Open the terminal UI connected to the Gateway, or run it in local embedded mode.

Related:

  • TUI guide: TUI

Notes:

  • chat and terminal are aliases for openclaw tui --local.
  • --local cannot be combined with --url, --token, or --password.
  • tui resolves configured gateway auth SecretRefs for token/password auth when possible (env/file/exec providers).
  • When launched from inside a configured agent workspace directory, TUI auto-selects that agent for the session key default (unless --session is explicitly agent:<id>:...).
  • Local mode uses the embedded agent runtime directly. Most local tools work, but Gateway-only features are unavailable.
  • Local mode adds /auth [provider] inside the TUI command surface.

Examples

openclaw chat
openclaw tui --local
openclaw tui
openclaw tui --url ws://127.0.0.1:18789 --token <token>
openclaw tui --session main --deliver
openclaw chat --message "Compare my config to the docs and tell me what to fix"
# when run inside an agent workspace, infers that agent automatically
openclaw tui --session bugfix

Config repair loop

Use local mode when the current config already validates and you want the embedded agent to inspect it, compare it against the docs, and help repair it from the same terminal:

If openclaw config validate is already failing, use openclaw configure or openclaw doctor --fix first. openclaw chat does not bypass the invalid- config guard.

openclaw chat

Then inside the TUI:

!openclaw config file
!openclaw docs gateway auth token secretref
!openclaw config validate
!openclaw doctor

Apply targeted fixes with openclaw config set or openclaw configure, then rerun openclaw config validate. See TUI and Config.

Reference in New Issue View Git Blame Copy Permalink