Skill: maxadc/openclaw-quickref (version 1.0.1)

--- name: openclaw-quickref description: 快速查询 OpenClaw CLI 命令、配置语法和常用模式。当用户问"怎么配置"、"命令是什么"、"配置格式"时触发。 license: MIT metadata: author: OpenClaw Expert version: 1.0.0 --- # OpenClaw 快速参考 快速查询 OpenClaw 常用命令、配置语法和最佳实践。 ## 触发条件 - 用户询问 CLI 命令用法 - 用户询问配置文件格式 - 用户询问"怎么配置 X" - 用户询问"命令是什么" - 用户需要快速参考某个功能 ## CLI 命令速查 ### Gateway 管理 ```bash openclaw gateway status # 查看状态 openclaw gateway start # 启动服务 openclaw gateway stop # 停止服务 openclaw gateway restart # 重启服务 ``` ### 插件管理 ```bash openclaw plugin list # 列出已安装插件 openclaw plugin install <pkg> # 安装插件 openclaw plugin remove <id> # 移除插件 ``` ### 配置管理 ```bash openclaw config show # 显示当前配置 openclaw config set <path> <val> # 设置配置项 openclaw config get <path> # 获取配置项 ``` ## 配置文件结构 ### openclaw.json 主配置 ```json { "providers": { "openai": { "apiKey": "${OPENAI_API_KEY}", "models": ["gpt-4", "gpt-3.5-turbo"] } }, "agents": { "default": { "model": "gpt-4", "systemPrompt": "You are a helpful assistant." } }, "skills": { "paths": ["./skills", "~/.agents/skills"] } } ``` ### 环境变量 ```bash OPENCLAW_API_KEY # Gateway API 密钥 OPENAI_API_KEY # OpenAI API 密钥 ANTHROPIC_API_KEY # Anthropic API 密钥 ``` ## 常用模式 ### 配置提供商 ```json { "providers": { "anthropic": { "apiKey": "${ANTHROPIC_API_KEY}", "baseUrl": "https://api.anthropic.com" } } } ``` ### 配置 Agent ```json { "agents": { "my-agent": { "model": "claude-3-opus", "provider": "anthropic", "systemPrompt": "Custom system prompt..." } } } ``` ### 配置 Channel ```json { "channels": { "discord": { "token": "${DISCORD_TOKEN}", "clientId": "123456789" } } } ``` ## 详细参考 更多详细信息请参阅： - CLI 命令详解：`./references/cli-reference.md` - 配置详解：`./references/config-reference.md` ## 最佳实践 1. **环境变量优先** - 敏感信息用 `${VAR_NAME}` 引用 2. **分层配置** - 全局配置 + 工作空间配置 3. **技能路径** - 使用相对路径或 `~` 扩展 4. **模型别名** - 为常用模型创建别名简化配置

path: references/cli-reference.md
content: # OpenClaw CLI 命令参考

## Gateway 命令

### 基础操作

| 命令 | 说明 |
|------|------|
| `openclaw gateway status` | 查看 Gateway 运行状态 |
| `openclaw gateway start` | 启动 Gateway 服务 |
| `openclaw gateway stop` | 停止 Gateway 服务 |
| `openclaw gateway restart` | 重启 Gateway 服务 |

### 启动选项

```bash
openclaw gateway start --help

Options:
  --config <path>    指定配置文件路径
  --port <port>      指定端口（默认自动选择）
  --daemon           以守护进程模式运行
  --log-level <level> 日志级别 (debug/info/warn/error)
```

## Session 命令

### 会话管理

| 命令 | 说明 |
|------|------|
| `openclaw session list` | 列出所有会话 |
| `openclaw session show <id>` | 显示会话详情 |
| `openclaw session delete <id>` | 删除会话 |

## Plugin 命令

### 插件管理

| 命令 | 说明 |
|------|------|
| `openclaw plugin list` | 列出已安装插件 |
| `openclaw plugin install <package>` | 安装插件 |
| `openclaw plugin remove <id>` | 移除插件 |
| `openclaw plugin update <id>` | 更新插件 |

### 安装来源

```bash
# 从 npm 安装
openclaw plugin install @openclaw/plugin-discord

# 从本地路径安装
openclaw plugin install ./my-plugin

# 从 Git 仓库安装
openclaw plugin install github:user/repo
```

## Config 命令

### 配置管理

| 命令 | 说明 |
|------|------|
| `openclaw config show` | 显示当前配置 |
| `openclaw config get <path>` | 获取配置项 |
| `openclaw config set <path> <value>` | 设置配置项 |
| `openclaw config unset <path>` | 删除配置项 |

### 配置路径示例

```bash
# 获取默认模型
openclaw config get agents.default.model

# 设置提供商 API Key
openclaw config set providers.openai.apiKey "sk-xxx"

# 设置技能路径
openclaw config set skills.paths '["./skills", "~/.agents/skills"]'
```

## Node 命令

### 节点管理

| 命令 | 说明 |
|------|------|
| `openclaw node list` | 列出已配对节点 |
| `openclaw node pair` | 生成配对码 |
| `openclaw node unpair <id>` | 解除配对 |

## 工具命令

### 开发调试

| 命令 | 说明 |
|------|------|
| `openclaw version` | 显示版本信息 |
| `openclaw help` | 显示帮助 |
| `openclaw <cmd> --help` | 显示命令帮助 |

---

最后更新：2026-03-13

path: references/config-reference.md
content: # OpenClaw 配置参考

## 配置文件位置

OpenClaw 按以下顺序查找配置文件：

1. `--config` 命令行参数指定的路径
2. `./openclaw.json` - 当前工作目录
3. `~/.openclaw/openclaw.json` - 用户配置目录

## 完整配置结构

```json
{
  "providers": { ... },
  "models": { ... },
  "agents": { ... },
  "channels": { ... },
  "skills": { ... },
  "security": { ... },
  "storage": { ... }
}
```

## providers 配置

### OpenAI

```json
{
  "providers": {
    "openai": {
      "apiKey": "${OPENAI_API_KEY}",
      "baseUrl": "https://api.openai.com/v1",
      "models": ["gpt-4", "gpt-4-turbo", "gpt-3.5-turbo"]
    }
  }
}
```

### Anthropic

```json
{
  "providers": {
    "anthropic": {
      "apiKey": "${ANTHROPIC_API_KEY}",
      "baseUrl": "https://api.anthropic.com",
      "models": ["claude-3-opus", "claude-3-sonnet"]
    }
  }
}
```

### 自定义提供商

```json
{
  "providers": {
    "my-custom": {
      "apiKey": "${MY_API_KEY}",
      "baseUrl": "https://api.example.com/v1",
      "headers": {
        "X-Custom-Header": "value"
      }
    }
  }
}
```

## models 配置

### 模型别名

```json
{
  "models": {
    "fast": "gpt-3.5-turbo",
    "smart": "gpt-4",
    "creative": "claude-3-opus"
  }
}
```

### 模型参数覆盖

```json
{
  "models": {
    "gpt-4": {
      "temperature": 0.7,
      "maxTokens": 4096
    }
  }
}
```

## agents 配置

### 默认 Agent

```json
{
  "agents": {
    "default": {
      "model": "gpt-4",
      "provider": "openai",
      "systemPrompt": "You are a helpful assistant.",
      "temperature": 0.7
    }
  }
}
```

### 自定义 Agent

```json
{
  "agents": {
    "coder": {
      "model": "claude-3-opus",
      "provider": "anthropic",
      "systemPrompt": "You are an expert programmer...",
      "skills": ["coding-agent"],
      "tools": ["read", "write", "exec", "web_search"]
    }
  }
}
```

### Agent 选项

| 选项 | 类型 | 说明 |
|------|------|------|
| `model` | string | 使用的模型 |
| `provider` | string | 提供商名称 |
| `systemPrompt` | string | 系统提示 |
| `temperature` | number | 温度参数 (0-1) |
| `maxTokens` | number | 最大 token 数 |
| `skills` | string[] | 启用的技能 |
| `tools` | string[] | 允许的工具 |
| `metadata` | object | 自定义元数据 |

## channels 配置

### Discord

```json
{
  "channels": {
    "discord": {
      "token": "${DISCORD_TOKEN}",
      "clientId": "123456789",
      "guildId": "987654321",
      "permissions": {
        "allowlist": ["user_id_1", "role_id_2"]
      }
    }
  }
}
```

### Telegram

```json
{
  "channels": {
    "telegram": {
      "token": "${TELEGRAM_TOKEN}",
      "allowedChats": ["chat_id_1", "chat_id_2"]
    }
  }
}
```

## skills 配置

### 技能路径

```json
{
  "skills": {
    "paths": [
      "./skills",
      "./.agents/skills",
      "~/.agents/skills"
    ],
    "disabled": ["unwanted-skill"]
  }
}
```

## security 配置

### 安全选项

```json
{
  "security": {
    "elevated": {
      "allowlist": ["allowed_command_1", "allowed_command_2"]
    },
    "policy": {
      "network": "allowlist",
      "filesystem": "sandbox"
    }
  }
}
```

## storage 配置

### 存储选项

```json
{
  "storage": {
    "sessions": "./data/sessions",
    "logs": "./data/logs",
    "cache": "./data/cache"
  }
}
```

## 环境变量

| 变量 | 说明 |
|------|------|
| `OPENCLAW_API_KEY` | Gateway API 密钥 |
| `OPENCLAW_PORT` | Gateway 端口 |
| `OPENCLAW_CONFIG` | 配置文件路径 |
| `OPENAI_API_KEY` | OpenAI API 密钥 |
| `ANTHROPIC_API_KEY` | Anthropic API 密钥 |

---

最后更新：2026-03-13

Security scan verdicts — ClawScan: clean | static analysis: clean | VirusTotal: clean | SkillSpector: clean (LOW)