mirror of
https://github.com/nearai/ironclaw.git
synced 2026-09-03 08:06:01 +08:00
3.0 KiB
3.0 KiB
title, description
| title | description |
|---|---|
| Local | Use IronClaw locally via terminal or browser |
By default, IronClaw provides two local interfaces for chatting with your agent:
- Terminal UI (TUI): chat directly in your terminal
- Web Gateway: chat in your browser over a local HTTP server
Terminal UI
Simply run ironclaw and the TUI will launch in your terminal. Use the keyboard shortcuts below to navigate and chat with your agent.
| Key | Action |
|---|---|
Enter |
Send message |
Shift+Enter |
New line in composer |
Ctrl+C |
Quit |
Ctrl+L |
Clear screen |
Tab |
Focus next element |
Esc |
Cancel or back |
Up/Down |
Scroll history |
Configuration
| Option | Default | Description |
|---|---|---|
CLI_ENABLED |
true |
Enable or disable the Terminal UI |
Web Gateway
| Option | Default | Description |
|---|---|---|
GATEWAY_HOST |
127.0.0.1 |
Host interface for the Web Gateway |
GATEWAY_PORT |
3000 |
Port used by the Web Gateway |
GATEWAY_ENABLED |
true |
Enable or disable the Web Gateway |
GATEWAY_AUTH_TOKEN |
auto-generated | Auth token required to open the Web UI |
Authentication
By default, IronClaw generates an auth token at startup and prints it in logs. To use a stable token across restarts:
export GATEWAY_AUTH_TOKEN="your-secure-token-here"
Generate one:
openssl rand -hex 32
API endpoints
The Web Gateway also exposes local endpoints:
| Endpoint | Description |
|---|---|
GET /api/status |
Server status |
POST /api/chat |
Send message |
GET /api/jobs |
List jobs |
GET /api/memory |
Search memory |
Network access
Use localhost-only access (recommended):
export GATEWAY_HOST=127.0.0.1
Use LAN access:
export GATEWAY_HOST=0.0.0.0