Chuyển đến nội dung chính

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Bắt đầu nhanh

​
Chế độ Gateway

  1. Khởi động Gateway.
openclaw gateway
  1. Mở TUI.
openclaw tui
  1. Nhập một tin nhắn và nhấn Enter.
Gateway từ xa: 
openclaw tui --url ws://<host>:<port> --token <gateway-token>
Dùng --password nếu Gateway của bạn dùng xác thực bằng mật khẩu.

​
Chế độ cục bộ

Chạy TUI không cần Gateway: 
openclaw chat
# or
openclaw tui --local
Ghi chú:
  • openclaw chat và openclaw terminal là bí danh cho openclaw tui --local.
  • --local không thể kết hợp với --url, --token hoặc --password.
  • Chế độ cục bộ dùng trực tiếp môi trường chạy tác nhân nhúng. Hầu hết công cụ cục bộ hoạt động, nhưng các tính năng chỉ có ở Gateway sẽ không khả dụng.
  • openclaw và openclaw crestodian cũng dùng shell TUI này, với Crestodian làm phần phụ trợ trò chuyện cài đặt và sửa chữa cục bộ.

​
Những gì bạn thấy

  • Phần đầu: URL kết nối, tác nhân hiện tại, phiên hiện tại.
  • Nhật ký trò chuyện: tin nhắn của người dùng, phản hồi của trợ lý, thông báo hệ thống, thẻ công cụ.
  • Dòng trạng thái: trạng thái kết nối/chạy (đang kết nối, đang chạy, đang truyền phát, nhàn rỗi, lỗi).
  • Phần chân: trạng thái kết nối + tác nhân + phiên + mô hình + think/fast/verbose/trace/reasoning + số lượng token + deliver.
  • Đầu vào: trình soạn thảo văn bản có tự động hoàn thành.

​
Mô hình tư duy: tác nhân + phiên

  • Tác nhân là các slug duy nhất (ví dụ main, research). Gateway cung cấp danh sách này.
  • Phiên thuộc về tác nhân hiện tại.
  • Khóa phiên được lưu dưới dạng agent:<agentId>:<sessionKey>.
    • Nếu bạn nhập /session main, TUI mở rộng thành agent:<currentAgent>:main.
    • Nếu bạn nhập /session agent:other:main, bạn chuyển rõ ràng sang phiên tác nhân đó.
  • Phạm vi phiên:
    • per-sender (mặc định): mỗi tác nhân có nhiều phiên.
    • global: TUI luôn dùng phiên global (bộ chọn có thể trống).
  • Tác nhân + phiên hiện tại luôn hiển thị trong phần chân.

​
Gửi + phân phối

  • Tin nhắn được gửi đến Gateway; phân phối đến nhà cung cấp bị tắt theo mặc định.
  • Bật phân phối:
    • /deliver on
    • hoặc bảng Cài đặt
    • hoặc khởi động bằng openclaw tui --deliver

​
Bộ chọn + lớp phủ

  • Bộ chọn mô hình: liệt kê các mô hình khả dụng và đặt ghi đè cho phiên.
  • Bộ chọn tác nhân: chọn một tác nhân khác.
  • Bộ chọn phiên: chỉ hiển thị các phiên của tác nhân hiện tại.
  • Cài đặt: bật/tắt phân phối, mở rộng đầu ra công cụ và hiển thị suy nghĩ.

​
Phím tắt bàn phím

  • Enter: gửi tin nhắn
  • Esc: hủy lần chạy đang hoạt động
  • Ctrl+C: xóa đầu vào (nhấn hai lần để thoát)
  • Ctrl+D: thoát
  • Ctrl+L: bộ chọn mô hình
  • Ctrl+G: bộ chọn tác nhân
  • Ctrl+P: bộ chọn phiên
  • Ctrl+O: bật/tắt mở rộng đầu ra công cụ
  • Ctrl+T: bật/tắt hiển thị suy nghĩ (tải lại lịch sử)

​
Lệnh slash

Cốt lõi:
  • /help
  • /status
  • /agent <id> (hoặc /agents)
  • /session <key> (hoặc /sessions)
  • /model <provider/model> (hoặc /models)
Điều khiển phiên:
  • /think <off|minimal|low|medium|high>
  • /fast <status|on|off>
  • /verbose <on|full|off>
  • /trace <on|off>
  • /reasoning <on|off|stream>
  • /usage <off|tokens|full>
  • /elevated <on|off|ask|full> (bí danh: /elev)
  • /activation <mention|always>
  • /deliver <on|off>
Vòng đời phiên:
  • /new hoặc /reset (đặt lại phiên)
  • /abort (hủy lần chạy đang hoạt động)
  • /settings
  • /exit
Chỉ trong chế độ cục bộ:
  • /auth [provider] mở luồng xác thực/đăng nhập của nhà cung cấp bên trong TUI.
Các lệnh slash Gateway khác (ví dụ /context) được chuyển tiếp đến Gateway và hiển thị dưới dạng đầu ra hệ thống. Xem Lệnh slash.

​
Lệnh shell cục bộ

  • Thêm tiền tố ! vào một dòng để chạy lệnh shell cục bộ trên máy chủ TUI.
  • TUI hỏi một lần cho mỗi phiên để cho phép thực thi cục bộ; nếu từ chối, ! vẫn bị tắt trong phiên đó.
  • Lệnh chạy trong một shell mới, không tương tác, trong thư mục làm việc của TUI (không có cd/env bền vững).
  • Lệnh shell cục bộ nhận OPENCLAW_SHELL=tui-local trong môi trường của chúng.
  • Một ! đơn lẻ được gửi như tin nhắn bình thường; khoảng trắng ở đầu không kích hoạt thực thi cục bộ.

​
Sửa cấu hình từ TUI cục bộ

Dùng chế độ cục bộ khi cấu hình hiện tại đã xác thực thành công và bạn muốn tác nhân nhúng kiểm tra cấu hình đó trên cùng máy, so sánh với tài liệu, và giúp sửa độ lệch mà không phụ thuộc vào Gateway đang chạy. Nếu openclaw config validate đã thất bại, hãy bắt đầu bằng openclaw configure hoặc openclaw doctor --fix trước. openclaw chat không bỏ qua cơ chế bảo vệ cấu hình không hợp lệ. Vòng lặp điển hình:
  1. Khởi động chế độ cục bộ:
openclaw chat
  1. Hỏi tác nhân điều bạn muốn kiểm tra, ví dụ:
So sánh cấu hình xác thực gateway của tôi với tài liệu và đề xuất bản sửa nhỏ nhất.
  1. Dùng lệnh shell cục bộ để lấy bằng chứng và xác thực chính xác:
!openclaw config file
!openclaw docs gateway auth token secretref
!openclaw config validate
!openclaw doctor
  1. Áp dụng các thay đổi hẹp bằng openclaw config set hoặc openclaw configure, rồi chạy lại !openclaw config validate.
  2. Nếu Doctor đề xuất một lần di chuyển hoặc sửa chữa tự động, hãy xem lại và chạy !openclaw doctor --fix.
Mẹo:
  • Ưu tiên openclaw config set hoặc openclaw configure thay vì chỉnh sửa thủ công openclaw.json.
  • openclaw docs "<query>" tìm kiếm chỉ mục tài liệu trực tiếp từ cùng máy.
  • openclaw config validate --json hữu ích khi bạn muốn lỗi lược đồ có cấu trúc và lỗi SecretRef/khả năng phân giải.

​
Đầu ra công cụ

  • Lệnh gọi công cụ hiển thị dưới dạng thẻ với đối số + kết quả.
  • Ctrl+O chuyển đổi giữa chế độ xem thu gọn/mở rộng.
  • Trong khi công cụ chạy, các cập nhật một phần truyền phát vào cùng thẻ.

​
Màu terminal

  • TUI giữ văn bản thân phản hồi của trợ lý ở màu chữ mặc định của terminal để cả terminal nền tối và nền sáng đều dễ đọc.
  • Nếu terminal của bạn dùng nền sáng và tự động phát hiện sai, hãy đặt OPENCLAW_THEME=light trước khi khởi chạy openclaw tui.
  • Để buộc dùng bảng màu tối gốc thay vào đó, hãy đặt OPENCLAW_THEME=dark.

​
Lịch sử + truyền phát

  • Khi kết nối, TUI tải lịch sử mới nhất (mặc định 200 tin nhắn).
  • Phản hồi truyền phát được cập nhật tại chỗ cho đến khi hoàn tất.
  • TUI cũng lắng nghe sự kiện công cụ của tác nhân để hiển thị thẻ công cụ phong phú hơn.

​
Chi tiết kết nối

  • TUI đăng ký với Gateway dưới dạng mode: "tui".
  • Các lần kết nối lại hiển thị thông báo hệ thống; khoảng trống sự kiện được hiển thị trong nhật ký.

​
Tùy chọn

  • --local: Chạy với môi trường chạy tác nhân nhúng cục bộ
  • --url <url>: URL WebSocket Gateway (mặc định theo cấu hình hoặc ws://127.0.0.1:<port>)
  • --token <token>: Token Gateway (nếu cần)
  • --password <password>: Mật khẩu Gateway (nếu cần)
  • --session <key>: Khóa phiên (mặc định: main, hoặc global khi phạm vi là toàn cục)
  • --deliver: Phân phối phản hồi của trợ lý đến nhà cung cấp (mặc định tắt)
  • --thinking <level>: Ghi đè mức suy nghĩ cho các lần gửi
  • --message <text>: Gửi tin nhắn ban đầu sau khi kết nối
  • --timeout-ms <ms>: Thời gian chờ tác nhân tính bằng ms (mặc định theo agents.defaults.timeoutSeconds)
  • --history-limit <n>: Số mục lịch sử cần tải (mặc định 200)
Khi bạn đặt --url, TUI không quay về cấu hình hoặc thông tin xác thực môi trường. Hãy truyền rõ ràng --token hoặc --password. Thiếu thông tin xác thực rõ ràng là một lỗi. Trong chế độ cục bộ, không truyền --url, --token hoặc --password.

​
Khắc phục sự cố

Không có đầu ra sau khi gửi tin nhắn:
  • Chạy /status trong TUI để xác nhận Gateway đã kết nối và đang nhàn rỗi/bận.
  • Kiểm tra nhật ký Gateway: openclaw logs --follow.
  • Xác nhận tác nhân có thể chạy: openclaw status và openclaw models status.
  • Nếu bạn mong đợi tin nhắn trong kênh trò chuyện, hãy bật phân phối (/deliver on hoặc --deliver).

​
Khắc phục sự cố kết nối

  • disconnected: đảm bảo Gateway đang chạy và --url/--token/--password của bạn chính xác.
  • Không có tác nhân trong bộ chọn: kiểm tra openclaw agents list và cấu hình định tuyến của bạn.
  • Bộ chọn phiên trống: có thể bạn đang ở phạm vi toàn cục hoặc chưa có phiên nào.

​
Liên quan