> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lukan.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI Reference

> Essential commands for daily Lukan Agent usage.

## Main Command

```
lukan [options]
```

### Options

| Option                     | Description                                                                                                                    |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `-p, --provider <name>`    | Model provider (nebius, anthropic, fireworks, github-copilot, openai-codex, zai, ollama-cloud, openai-compatible, lukan-cloud) |
| `-m, --model <name>`       | Model name                                                                                                                     |
| `--max-tokens <n>`         | Max output tokens                                                                                                              |
| `--ui <mode>`              | UI mode: `ink` (default), `readline`, `web`                                                                                    |
| `--desktop`                | Launch in desktop mode (Tauri)                                                                                                 |
| `--session <id>`           | Resume a session by ID                                                                                                         |
| `-c, --continue`           | Continue the most recent session                                                                                               |
| `-b, --browser`            | Enable browser control tools                                                                                                   |
| `--browser-cdp <url>`      | CDP endpoint URL for browser tools                                                                                             |
| `--browser-visible`        | Launch Chrome with visible window                                                                                              |
| `--browser-profile`        | Use default Chrome profile                                                                                                     |
| `--browser-allow-internal` | Allow navigation to internal/private URLs                                                                                      |

## Setup Commands

| Command                           | Description                                            |
| --------------------------------- | ------------------------------------------------------ |
| `lukan setup`                     | Interactive setup wizard (provider, API key, timezone) |
| `lukan doctor`                    | Show configuration and diagnostic info                 |
| `lukan update`                    | Self-update to latest version                          |
| `lukan update --daily`            | Install from the unstable/daily channel                |
| `lukan models [provider] [model]` | List and select models                                 |
| `lukan copilot-auth`              | Authenticate with GitHub Copilot (OAuth device flow)   |
| `lukan codex-auth`                | Authenticate with OpenAI Codex                         |
| `lukan google-auth`               | Authenticate with Google Workspace                     |

## Config Commands

```bash theme={null}
lukan config get [key]           # Get config value (or all)
lukan config set <key> <value>   # Set config value
lukan config timezone            # Select timezone interactively
lukan config vision              # Select vision model
```

## Plugin Commands

```bash theme={null}
lukan plugin list                # List installed plugins
lukan plugin install <path>      # Install a plugin from local path
lukan plugin list-remote         # List plugins available from registry
lukan plugin remove <name>       # Remove a plugin
lukan plugin start <name>        # Start a plugin process
lukan plugin stop <name>         # Stop a plugin gracefully
lukan plugin status              # Show status of all plugins
lukan plugin logs <name>         # View plugin logs
lukan plugin config <name>       # Manage plugin configuration
lukan plugin exec <name> <cmd>   # Execute a plugin command
```

Plugins can also register CLI aliases. For example, the WhatsApp plugin registers `lukan wa` and the Email plugin registers `lukan mail`.

## Skill Commands

```bash theme={null}
lukan skill list                 # List available skills
lukan skill remove <name>        # Remove a skill
lukan skill env <name>           # Manage skill environment variables
```

## Sandbox Commands

```bash theme={null}
lukan sandbox status             # Show sandbox status
lukan sandbox on                 # Enable OS-level sandboxing
lukan sandbox off                # Disable sandboxing
lukan sandbox setup              # Install and configure bwrap
lukan sandbox uninstall          # Remove sandbox configuration
```

## Worker Commands

```bash theme={null}
lukan worker list                # List all workers
lukan worker add                 # Create worker interactively
lukan worker remove <id>         # Delete a worker
lukan worker pause <id>          # Pause a worker
lukan worker resume <id>         # Resume a worker
lukan worker runs <id>           # Show recent runs
```

## Daemon Commands

```bash theme={null}
lukan daemon start               # Start the worker daemon
lukan daemon stop                # Stop the worker daemon
lukan daemon status              # Show daemon status
```

## Relay Commands

```bash theme={null}
lukan login                      # Authenticate with Lukan Relay
lukan login --remote             # Remote/headless authentication
lukan logout                     # Disconnect from Relay
lukan relay status               # Show relay connection status
lukan relay disconnect           # Disconnect active relay session
```

## WhatsApp Commands (Plugin)

```bash theme={null}
lukan whatsapp                   # Start WhatsApp channel
lukan wa on                      # Enable WhatsApp
lukan wa off                     # Disable and stop daemon
lukan wa start                   # Start as background daemon
lukan wa stop                    # Stop daemon
lukan wa restart                 # Restart daemon
lukan wa status                  # Show configuration
lukan wa auth                    # Scan QR code to authenticate
lukan wa logout                  # Delete WhatsApp session
lukan wa allow <number>          # Whitelist a phone number
lukan wa deny <number>           # Remove from whitelist
lukan wa group add|remove|list   # Manage allowed groups
lukan wa groups                  # List available groups from bridge
lukan wa prefix [value]          # Get or set command prefix
lukan wa model                   # Select model interactively
lukan wa tools list|add|remove|reset   # Manage allowed tools
lukan wa dir list|add|remove|clear|on|off  # Manage allowed directories
lukan wa logs [-f] [-n <n>]      # Show daemon logs
```

## Email Commands (Plugin)

```bash theme={null}
lukan email                      # Start Email channel
lukan mail on                    # Enable Email
lukan mail off                   # Disable Email
lukan mail setup gmail|outlook <email>  # Setup with preset
lukan mail allow <email>         # Whitelist an email
lukan mail deny <email>          # Remove from whitelist
lukan mail prefix [value]        # Get or set subject prefix filter
lukan mail tools list|add|remove|reset  # Manage allowed tools
lukan mail status                # Show configuration
lukan mail test                  # Test SMTP and IMAP connections
```

## In-Chat Commands

These commands work inside a chat session:

| Command                                              | Description                                   |
| ---------------------------------------------------- | --------------------------------------------- |
| `/model [model]`                                     | Open model picker or switch directly          |
| `/resume`                                            | Resume a saved session (opens session picker) |
| `/clear`                                             | Clear context and start fresh                 |
| `/compact`                                           | Manually compact conversation                 |
| `/memories [activate\|deactivate\|show\|add <text>]` | Manage project memory                         |
| `/gmemory [show\|add <text>\|clear]`                 | Manage global memory                          |
| `/checkpoints`                                       | Open checkpoint viewer                        |
| `/skills`                                            | List available skills                         |
| `/events [clear]`                                    | Switch to Event Agent view or clear events    |
| `/workers`                                           | Browse workers and their runs                 |
| `/bg`                                                | List background processes                     |
| `/bg kill <pid>`                                     | Kill background process                       |
| `/bg logs <pid>`                                     | View process output                           |
| `!<command>`                                         | Execute shell command, add output to context  |
| `/exit`                                              | Exit lukan                                    |

## Keyboard Shortcuts

### Chat Input

| Key                    | Action                                                    |
| ---------------------- | --------------------------------------------------------- |
| `Enter`                | Submit message                                            |
| `Tab`                  | Autocomplete command                                      |
| `Up/Down`              | Navigate suggestions or history                           |
| `Escape`               | Cancel processing / clear input / open checkpoints        |
| `Shift+Tab`            | Cycle permission mode (manual -> auto -> skip -> planner) |
| `Ctrl+A`               | Move cursor to start                                      |
| `Ctrl+E`               | Move cursor to end                                        |
| `Ctrl+C`               | Exit lukan                                                |
| `Alt+B`                | Send running Bash command to background                   |
| `Alt+E`                | Toggle between Main and Event Agent views                 |
| `Alt+L`                | Open/close unified event picker                           |
| `Alt+A`                | Toggle auto/manual event forwarding mode                  |
| `Alt+M`                | Show memory viewer overlay                                |
| `Alt+P`                | Toggle tool picker overlay                                |
| `Alt+S`                | Toggle subagent picker overlay                            |
| `Alt+T`                | Toggle task panel visibility                              |
| `F9`                   | Open/minimize embedded terminal modal                     |
| `Ctrl+Shift+F9`        | Close and kill the terminal                               |
| `Ctrl+Up/Down`         | Scroll terminal up/down                                   |
| `Ctrl+PageUp/PageDown` | Half-page scroll in terminal                              |

### Session Picker

| Key       | Action            |
| --------- | ----------------- |
| `Up/Down` | Navigate sessions |
| `Enter`   | Select session    |
| `Space`   | Mark for deletion |
| `Alt+A`   | Toggle select all |
| `Alt+X`   | Delete marked     |
| `Escape`  | Close             |

### Checkpoint Viewer

| Key       | Action                      |
| --------- | --------------------------- |
| `Up/Down` | Navigate checkpoints        |
| `Enter`   | View diff / restore options |
| `Escape`  | Back / close                |
