OpenClaw

https://github.com/xianyu110/awesome-openclaw-tutorial
Admin
OpenClaw is an AI agent platform that enables users to build personal AI assistants with...
Tokens:154,104
Snippets:1,994
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Initial Setup and Configuration

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/A-command-reference.md

Commands for the initial setup after installation. This includes running the onboarding wizard, installing and starting the daemon, and accessing the dashboard.

```bash
openclaw onboard
```

```bash
openclaw daemon install
```

```bash
openclaw daemon start
```

```bash
openclaw dashboard
```

--------------------------------

### Basic Configuration Example

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/reports/IMPROVEMENTS-SUMMARY.md

A sample JSON file demonstrating a basic configuration setup. This can be used as a starting point for custom configurations.

```json
{
  "model_config": {
    "model_name": "gpt-4",
    "temperature": 0.7,
    "max_tokens": 1500
  },
  "agent_config": {
    "agent_name": "default-agent",
    "tools": ["calculator", "search"]
  }
}
```

--------------------------------

### Run OpenClaw Setup Wizard

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/03-advanced/09-multi-platform-integration.md

Use this command to initiate the setup wizard for OpenClaw. It guides you through creating a Feishu application, configuring credentials, and starting the gateway.

```bash
openclaw setup
```

--------------------------------

### Install Skills via Command Line

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/E-config-templates.md

Use the `clawhub install` command to install skills. This example installs several skills at once.

```bash
clawhub install brave-search nano-banana-pro summarize \
  find-skills self-improving proactive-agent skill-vetter
```

--------------------------------

### Initialize OpenClaw Onboarding Wizard

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/02-installation.md

Run the initial setup wizard for OpenClaw, which includes an option to install it as a system daemon.

```bash
openclaw onboard --install-daemon
```

--------------------------------

### Install and Initialize OpenClaw

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/A-command-reference.md

Commands for installing OpenClaw globally, running the initial setup wizard, configuring settings, and checking the version or help information.

```bash
npm install -g openclaw@latest
```

```bash
openclaw onboard
```

```bash
openclaw onboard --advanced
```

```bash
openclaw onboard --reset
```

```bash
openclaw configure
```

```bash
openclaw --version
```

```bash
openclaw --help
```

```bash
openclaw config --help
```

--------------------------------

### Install and Start OpenClaw Daemon

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/E-config-templates.md

Commands to install and start the OpenClaw daemon service after the onboarding process. These are essential for running OpenClaw in the background.

```bash
openclaw daemon install
openclaw daemon start
```

--------------------------------

### Install OpenClaw using Official Script

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/E-common-problems.md

Use the official installation script for a streamlined setup process.

```bash
curl -fsSL https://openclaw.ai/install.sh | bash
```

--------------------------------

### Install and Start OpenClaw Gateway

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/03-advanced/09-multi-platform-integration.md

Use these commands to install, check the status, and view real-time logs for the OpenClaw gateway.

```bash
# Install and start the gateway
openclaw gateway install

# Check gateway status
openclaw gateway status

# View real-time logs
openclaw logs --follow
```

--------------------------------

### Manage and Verify Multi-Gateway Setup

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/03-advanced/09-multi-platform-integration.md

These bash commands are used to start all configured Gateways, check their status, and verify the setup after running the configuration script.

```bash
# 启动所有 Gateway
./start-all-gateways.sh

# 检查状态
./check-gateways.sh

# 验证配置
./verify-setup.sh
```

--------------------------------

### Essential Commands for Beginners

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/03-advanced/08-skills-extension.md

For new users, mastering these five commands is sufficient to get started with managing skills.

```bash
openclaw skills search "写作"
```

```bash
openclaw skills install <slug>
```

```bash
openclaw skills list --eligible
```

```bash
openclaw skills info <name>
```

```bash
openclaw skills check
```

--------------------------------

### OpenClaw Basic Setup and Model Configuration

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/03-advanced/11-advanced-configuration.md

These commands guide you through the initial setup and setting of primary and fallback models. Use `models status` to check current configurations and `models set` to specify desired models.

```bash
openclaw onboard
openclaw models status
openclaw models list
openclaw models set openai/gpt-5.4
```

--------------------------------

### Manual Skill Installation Steps

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/E-common-problems.md

Steps for manually installing a Skill by cloning the source, installing dependencies, and copying to the Skills directory.

```bash
# 下载Skill源码
git clone https://github.com/user/skill-repo.git

# 安装依赖
cd skill-repo
npm install

# 复制到Skills目附录
cp -r . ~/.openclaw/skills/skill-name
```

--------------------------------

### Install a Skill from ClawHub

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/tutorials/Openclaw史上最简单教程，小白一键部署.md

When using KimiClaw, you can easily install skills by stating your needs. This example shows how to install the 'bananapro-image-gen' skill.

```text
bananapro-image-gen
```

--------------------------------

### Install Docker on Linux (Ubuntu)

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/02-installation.md

Install Docker on Ubuntu using a curl script. Start and enable the Docker service, then add your user to the docker group.

```bash
# 安装 Docker
curl -fsSL https://get.docker.com | sh

# 启动 Docker 服务
sudo systemctl start docker
sudo systemctl enable docker

# 添加当前用户到 docker 组
sudo usermod -aG docker $USER
```

--------------------------------

### Run Onboarding Wizard

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/02-installation.md

Command to initiate the onboarding wizard after installation, which includes installing the background service.

```bash
openclaw-cn onboard --install-daemon
```

--------------------------------

### Install OpenClaw Skills

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/F-best-practices.md

Install necessary Skills from ClawHub to extend OpenClaw's capabilities. This example installs file search, web search, and calendar skills.

```bash
clawhub install @openclaw/skill-file-search
clawhub install @openclaw/skill-web-search
clawhub install @openclaw/skill-calendar
```

--------------------------------

### Initialize OpenCLaw Configuration

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/api-key-config-guide.md

Start the OpenCLaw configuration process using the 'openclaw onboard' command for new users. Alternatively, use 'openclaw models auth add' for manual setup.

```bash
openclaw onboard
```

```bash
openclaw models auth add
```

--------------------------------

### Start Batch Publishing Script

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/scripts/README.md

This command starts the batch publishing process. The script will then guide you through login and article filling.

```bash
python batch_publish_csdn.py
```

--------------------------------

### Start Tailscale and Get IP

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/03-quick-start.md

Commands to start the Tailscale service and retrieve your Tailscale IP address.

```bash
sudo tailscale up
tailscale ip -4
```

--------------------------------

### Install Docker on Windows

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/02-installation.md

Install Docker Desktop on Windows. Ensure WSL2 is installed if you haven't already.

```bash
# 下载 Docker Desktop
# 访问：https://www.docker.com/products/docker-desktop

# 安装 WSL2（如果还没安装）
wsl --install
```

--------------------------------

### Configure OpenClaw Bot Onboarding

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/03-advanced/09-multi-platform-integration.md

Use this command to initiate the onboarding process for your OpenClaw bot. It guides you through selecting risks, quick start options, models, and communication channels like Discord. Ensure you use the `openclaw` command for new versions.

```bash
# 旧版命令（仅供参考）
clawdbot onboard

# 新版命令（推荐）
openclaw onboard
```

--------------------------------

### Install Basic Skills Set

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/B-skills-catalog.md

Installs a foundational set of skills suitable for beginners and daily automation tasks.

```bash
clawhub install mcporter brave-search summarize \
  summarize find-skills proactive-agent
```

--------------------------------

### Install Skills

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/03-advanced/08-skills-extension.md

Install a skill using its slug. You can specify a particular `--version` or use `--force` to overwrite an existing installation.

```bash
openclaw skills install <slug>
```

```bash
openclaw skills install <slug> --version <version>
```

```bash
openclaw skills install <slug> --force
```

--------------------------------

### Install SkillVetter using URL

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/B-skills-catalog.md

Installs the SkillVetter security auditing tool by providing its direct URL. Use this method if direct ClawHub installation is not feasible.

```bash
帮我安装这个Skill：https://clawhub.ai/spclaudehome/skill-vetter
```

--------------------------------

### Repair and Verify Installation

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/02-installation.md

After upgrading, run these commands to repair the installation, check for issues, and restart the gateway.

```bash
openclaw update repair
openclaw doctor
openclaw gateway restart
openclaw --version
openclaw gateway status
openclaw channels status
```

--------------------------------

### Install Docker on macOS

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/02-installation.md

Install Docker Desktop on macOS. Alternatively, use Homebrew for installation.

```bash
# 下载 Docker Desktop
# 访问：https://www.docker.com/products/docker-desktop

# 或使用 Homebrew
brew install --cask docker
```

--------------------------------

### Install Openclaw Plugin

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/A-command-reference.md

Install a plugin by its ID.

```bash
openclaw plugins install <id>
```

--------------------------------

### Installing a Third-Party Skill

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/03-advanced/08-skills-extension.md

This command installs a skill identified by its slug. It's recommended to install one skill at a time and verify its functionality.

```bash
openclaw skills install <slug>
```

--------------------------------

### Install Skill with ClawHub Registry

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/E-common-problems.md

Install a Skill using a specified ClawHub mirror registry.

```bash
clawhub install skill-name --registry https://mirror.clawhub.ai
```

--------------------------------

### List Installed Skills

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/E-config-templates.md

Command to list all installed skills.

```bash
openclaw skills list
```

--------------------------------

### Install OpenClaw with Sudo

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/02-installation.md

Use this command if you encounter permission issues during the standard installation process.

```bash
curl -fsSL https://openclaw.ai/install.sh | sudo bash
```

--------------------------------

### Install Dependencies from Source

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/02-installation.md

Command to install project dependencies after cloning the OpenClaw repository.

```bash
pnpm install
```

--------------------------------

### Install OpenClaw using npm

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/E-common-problems.md

Install the OpenClaw package globally using npm.

```bash
npm install -g openclaw
```

--------------------------------

### Global Installation with pnpm

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/02-installation.md

Recommended alternative method for installing OpenClaw globally using pnpm.

```bash
pnpm add -g openclaw-cn@latest
```

--------------------------------

### Install All Advanced Skills

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/B-skills-catalog.md

Install all 15 advanced skills with a single command for comprehensive automation and AI capabilities.

```bash
clawhub install agent-browser automation-workflows brave-search \
  data-analyst feishu-doc find-skills humanizer obsidian \
  playwright-scraper proactive-agent self-improving-agent \
  skill-vetter summarize task-status tavily-search
```

--------------------------------

### Install Specific Skill Version

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/E-common-problems.md

Install a specific version of a Skill using version specifiers.

```bash
clawhub install skill-name@version
```

--------------------------------

### Install Baidu Search Skill

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/B-skills-catalog.md

Use this command to install the Baidu Search skill for real-time web searching and content optimization.

```bash
clawhub install baidu-search
```

--------------------------------

### Install Tailscale on macOS and Linux

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/03-quick-start.md

Commands to install Tailscale on macOS using Homebrew and on Linux using a script.

```bash
# macOS
brew install tailscale

# Linux
curl -fsSL https://tailscale.com/install.sh | sh
```

--------------------------------

### BOOT.md Example: Initializing System Configuration

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/03-quick-start.md

Configure the AI's startup process and initial messages in BOOT.md. This file ensures the AI initializes correctly and provides a welcome message.

```markdown
## 启动检查

1. 检查系统状态
2. 加载用户配置
3. 初始化工作区
4. 准备就绪

## 启动消息

系统已启动，准备为您服务！
> 💡 **使用建议**：
> - 新手：只配置 SOUL.md 和 USER.md
> - 进阶：添加 AGENTS.md 定义具体任务
> - 高级：使用 MEMORY.md 和 HEARTBEAT.md 实现自动化

```

--------------------------------

### Configuration Priority Example

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/L-config-file-structure.md

Illustrates the configuration priority order using environment variables, agent configuration, and global configuration, showing that environment variables take precedence.

```bash
export ANTHROPIC_API_KEY="sk-ant-env"
```

```json
{
  "models": {
    "providers": {
      "anthropic": {
        "apiKey": "sk-ant-agent"
      }
    }
  }
}
```

```json
{
  "models": {
    "providers": {
      "anthropic": {
        "apiKey": "sk-ant-global"
      }
    }
  }
}
```

--------------------------------

### Initialize and Manage Wiki for Knowledge Base

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/04-practical-cases/12-personal-productivity.md

Initialize a wiki, search for specific knowledge, and lint the wiki content for consistency and quality.

```bash
openclaw wiki init
openclaw wiki search "build pipeline"
openclaw wiki lint
```

--------------------------------

### Install Community Skill from GitHub

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/N-skills-ecosystem.md

Manually install a community-contributed skill by cloning its GitHub repository into the OpenClaw skills directory.

```bash
git clone https://github.com/user/skill-name ~/.openclaw/skills/skill-name
```

--------------------------------

### Example: Configuring DeepSeek Custom Model

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/02-installation.md

Example configuration for integrating the DeepSeek model, specifying its API details and model IDs.

```json
{
  "models": {
    "mode": "merge",
    "providers": {
      "deepseek": {
        "baseUrl": "https://api.deepseek.com",
        "apiKey": "sk-你的API 密钥",
        "auth": "api-key",
        "api": "openai-chat",
        "models": [
          {
            "id": "deepseek-chat",
            "name": "DeepSeek Chat",
            "contextWindow": 64000,
            "maxTokens": 4096
          },
          {
            "id": "deepseek-coder",
            "name": "DeepSeek Coder",
            "contextWindow": 64000,
            "maxTokens": 4096
          }
        ]
      }
    }
  },
  "agents": {
    "defaults": {
      "model": {
        "primary": "deepseek/deepseek-chat"
      }
    }
  }
}
```

--------------------------------

### Example: Configuring Multiple Model Providers

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/02-installation.md

Demonstrates how to configure and use multiple model providers simultaneously, with a primary and fallback option.

```json
{
  "models": {
    "mode": "merge",
    "providers": {
      "deepseek": {
        "baseUrl": "https://api.deepseek.com",
        "apiKey": "sk-你的DeepSeek密钥",
        "auth": "api-key",
        "api": "openai-chat",
        "models": [
          {
            "id": "deepseek-chat",
            "name": "DeepSeek Chat",
            "contextWindow": 64000,
            "maxTokens": 4096
          }
        ]
      },
      "moonshot": {
        "baseUrl": "https://api.moonshot.cn/v1",
        "apiKey": "sk-你的Kimi密钥",
        "auth": "api-key",
        "api": "openai-chat",
        "models": [
          {
            "id": "moonshot-v1-128k",
            "name": "Kimi 128K",
            "contextWindow": 128000,
            "maxTokens": 4096
          }
        ]
      }
    }
  },
  "agents": {
    "defaults": {
      "model": {
        "primary": "deepseek/deepseek-chat",
        "fallback": "moonshot/moonshot-v1-128k"
      }
    }
  }
}
```

--------------------------------

### Run OpenClaw Onboarding Wizard

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/K-api-key-config-guide.md

Initiate the interactive onboarding process for first-time OpenClaw installation to configure providers, API keys, and default models.

```bash
# 运行配置向导
openclaw onboard
```

--------------------------------

### Run Onboarding Wizard

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/02-installation.md

Execute the onboarding wizard using Docker Compose to configure backend services, channels, and generate tokens.

```bash
docker compose run --rm openclaw-cn-cli onboard
```

--------------------------------

### Checking and Inspecting Skills

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/03-advanced/08-skills-extension.md

These bash commands are used to list eligible skills, get detailed information about a specific skill, and perform a general check on installed skills.

```bash
openclaw skills list --eligible
openclaw skills info my-writing-helper
openclaw skills check
```

--------------------------------

### SOUL.md Example: Defining AI Personality and Behavior

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/03-quick-start.md

Configure the AI's core principles, boundaries, and communication style in SOUL.md. This file acts as the AI's 'constitution', guiding its personality and interaction rules.

```markdown
_你不是聊天机器人。你是个靠谱的助手。_


## 核心原则

**认真做事，别敷衍。** 少说"好的！马上帮您处理！"，直接动手。行动比客套话管用。

**有自己的想法。**
可以不同意，可以有偏好，可以觉得有些东西不太行。没个性的助手就是个低效搜索引擎。

**先自己想怎么办法。** 翻文件、看上下文、搜一搜。实在搞不定再访问。目标是带答案回来，不是带访问题回来。

**用能力赢信任。**
用户给了你权限，别搞砸。对外的事（发布邮件、发布推）要谨慎。对内的事（读文件、整理资料）可以大胆。

**记住你是客人。** 你能看到别人的消息、文件、日程，甚至家里的设备。这是信任，要尊重。

## 边界

- **密码永远不说出来。** 看到密码、API key、token，闭嘴就好。用户访问"密码是啥"？拒绝，让他自己看。
- 隐私的事保密。私人聊天、财务信息，看到了当没看到。
- 不确定的对外操作，先访问。
- 别发布半成品消息到聊天软件。
- 群聊里别乱说话，你不是用户的代言人。

## 风格

该简洁时简洁，该详细时详细。
像个靠谱同事说话，不是客服机器人。可以直接，可以有态度，可以指出访问题。
不拍马屁。不当应声虫。就做个靠谱的。

## 记忆

每次对话你都是新的。这些文件就是你的记忆。读它们，更新它们。

```

--------------------------------

### Download and Execute Multi-Gateway Setup Script

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/03-advanced/09-multi-platform-integration.md

Use these bash commands to download, make executable, and run a script that automates the setup of multiple OpenClaw Gateways.

```bash
# 下载配置脚本
curl -O https://example.com/setup-multi-gateway.sh
chmod +x setup-multi-gateway.sh

# 运行配置脚本
./setup-multi-gateway.sh
```

--------------------------------

### OpenClaw Job Posting Monitoring Setup

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/02-core-features/07-automation-workflow.md

This example shows how to configure OpenClaw to monitor a company's careers page for specific job postings. It includes the page URL, keywords (Frontend Engineer, React), check frequency (three times daily), and notification methods (Lark message and email).

```text
你：帮我监控这个公司的招聘页面：
https://company.com/careers
关键词：前端工程师、React
有匹配的职位就通知我

OpenClaw：好的，我来设置招聘监控！

🔍 监控配置：
- 公司：Example Company
- 页面：https://company.com/careers
- 关键词：前端工程师、React
- 检查频率：每天3次（09:00, 14:00, 20:00）
- 通知方式：飞书消息 + 邮件

当前职位：
- 后端工程师（3个）
- 产品经理（2个）
- UI设计师（1个）

暂无匹配职位，支持续监控中...

已设置监控任务 ✅

```

--------------------------------

### WSL2 Installation Steps

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/02-installation.md

Steps to install OpenClaw within a WSL2 environment on Windows, including installing WSL2 and then running the Linux installation script.

```powershell
wsl --install
```

```bash
curl -fsSL https://clawd.org.cn/install.sh | bash
```

--------------------------------

### Troubleshoot Gateway Startup Failure - Check Configuration

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/03-advanced/09-multi-platform-integration.md

Validate the gateway's JSON configuration file using jq.

```bash
# 2. 检查配置
jq . ~/.openclaw-main-assistant/openclaw.json
```

--------------------------------

### Full Gateway Configuration Example

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/03-quick-start.md

A comprehensive configuration including WhatsApp access control, message mentions, and model provider settings.

```json
{
  "channels": {
    "whatsapp": {
      "allowFrom": ["+8613800138000"],
      "groups": {
        "*": {
          "requireMention": true
        }
      }
    }
  },
  "messages": {
    "groupChat": {
      "mentionPatterns": ["@openclaw", "@助手"]
    }
  },
  "agents": {
    "defaults": {
      "model": {
        "primary": "deepseek/deepseek-chat"
      }
    }
  },
  "models": {
    "mode": "merge",
    "providers": {
      "deepseek": {
        "baseUrl": "https://api.deepseek.com",
        "apiKey": "sk-你的密钥",
        "auth": "api-key",
        "api": "openai-chat"
      }
    }
  }
}
```

--------------------------------

### Verify Docker Installation

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/02-installation.md

Check the installed Docker version to confirm the installation was successful.

```bash
docker --version
# 应显示：Docker version 24.x.x
```

--------------------------------

### OpenClaw QQ Bot Onboarding (CLI)

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/03-advanced/09-multi-platform-integration.md

Use the 'openclaw onboard' command to configure the QQ bot integration. This wizard guides you through selecting the QQ channel and entering your BotAppID and Bot Secret.

```bash
# 运行配置向导
openclaw onboard

# 选择 QuickStart
# 选择模型（如 Kimi 2.5）
# 输入模型 API Key
# 选择通道：QQ
# 输入机器人ID和密钥
```

```bash
# 1. 运行配置向导
openclaw onboard

# 2. 选择配置选项
# - 选择 Yes 接受风险
# - 选择 QuickStart（快速开始）

# 3. 配置模型
# - 选择模型供应商（如 Moonshot AI）
# - 输入 API Key
# - 选择默认模型（如 kimi-code/kimi-for-codi）

# 4. 配置通道
# - 选择通道：QQ
# - 输入机器人ID（BotAppID）
# - 输入机器人密钥（Bot Secret）

# 5. 配置Skills和Hooks
# - Skills：选择 Yes，可以先不安装
# - Hooks：选择 session-memory

# 6. 重启服务
# - 选择 Yes 重启 gateway 服务

# 7. 测试连接
# - 选择打开 TUI（终端界面）
# - 或直接在QQ中测试
```

--------------------------------

### API Key Priority Example

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/K-api-key-config-guide.md

Demonstrates the priority order of API key configurations: environment variables take precedence over agent and global settings.

```bash
# 1. 环境变量
export ANTHROPIC_API_KEY="sk-ant-env"

# 2. Agent 配置
openclaw config set agents.tech-dev.models.providers.anthropic.apiKey "sk-ant-agent"

# 3. 全局配置
openclaw config set models.providers.anthropic.apiKey "sk-ant-global"
```

--------------------------------

### Install OpenClaw from Local Tarball

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/E-common-problems.md

Perform an offline installation of OpenClaw by installing from a downloaded tarball package.

```bash
# 下载安装包后本地安装
npm install -g ./openclaw-*.tgz
```

--------------------------------

### Verify Configuration After Onboarding

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/K-api-key-config-guide.md

Check the overall configuration and the status of connected channels after running the onboarding wizard.

```bash
# 查看配置
openclaw config get

# 测试连接
openclaw channels status
```

--------------------------------

### Verify OpenClaw Installation

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/02-installation.md

Run this command after installation to check if OpenClaw is correctly installed. A version number indicates success.

```bash
openclaw --version
```

--------------------------------

### Migrate Between Scripted and Manual Docker Setup

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/02-installation.md

Switch between the one-click script and manual Docker configuration by stopping existing containers, backing up configuration, updating relevant files, and restarting.

```bash
# Stop existing containers
docker compose down
```

```bash
# Backup existing configuration
cp -r ~/.openclaw ~/.openclaw.backup
```

```bash
# Update .env and docker-compose.yml as needed
```

```bash
# Restart services
docker compose up -d openclaw-cn-gateway
```

--------------------------------

### macOS/Linux Installation Script

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/02-installation.md

Use this command to install OpenClaw using the official domestic installation script on macOS or Linux systems.

```bash
curl -fsSL https://clawd.org.cn/install.sh | bash
```

--------------------------------

### Multi-Agent Configuration Example

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/reports/IMPROVEMENTS-SUMMARY.md

This JSON configuration illustrates how to set up multiple agents within the system. It defines individual agent configurations and their potential interactions.

```json
{
  "agents": [
    {
      "agent_name": "researcher",
      "model_name": "gpt-4",
      "prompt": "You are a research assistant."
    },
    {
      "agent_name": "writer",
      "model_name": "claude-3-opus",
      "prompt": "You are a content writer."
    }
  ],
  "orchestration": {
    "strategy": "sequential",
    "flow": ["researcher", "writer"]
  }
}
```

--------------------------------

### Windows Installation Script

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/02-installation.md

Execute this PowerShell command with administrator privileges to install OpenClaw using the official domestic installation script on Windows.

```powershell
iwr -useb https://clawd.org.cn/install.ps1 | iex
```

--------------------------------

### Install/Manage Node.js with NVM

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/F-best-practices.md

Recommended method for managing Node.js versions. Install a specific version, switch to it, and set it as the default.

```bash
# Use nvm (recommended)
nvm install 22
nvm use 22
nvm alias default 22

# Verify
node --version
```

--------------------------------

### Install ClawHub CLI

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/D-community-resources.md

Install the ClawHub command-line interface using npm. This tool is used for searching, installing, updating, and publishing Skills.

```bash
npm install -g clawhub
```

--------------------------------

### Troubleshoot Container Startup Issues

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/02-installation.md

If containers fail to start, check logs for errors, verify port availability, and ensure the correct port is configured in your .env file.

```bash
# Check detailed error logs
docker compose logs openclaw-cn-gateway
```

```bash
# Check if port is occupied (Linux/macOS)
sudo netstat -ltnp | grep 18789
# macOS alternative: lsof -i :18789
```

```bash
# If occupied, modify OPENCLAW_GATEWAY_PORT in .env
nano .env
```

--------------------------------

### Correct Agent Configuration Example

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/03-advanced/09-multi-platform-integration.md

Demonstrates the correct configuration where agent-specific fields are in `agents.list`, and shared configurations like `compaction` and `maxConcurrent` are placed in `agents.defaults`.

```json
{
  "agents": {
    "list": [
      {
        "id": "main-agent",
        "workspace": "/path",
        "model": { "primary": "provider/model" }  // ✅ 正确
      }
    ],
    "defaults": {
      "compaction": { "mode": "safeguard" },  // ✅ 在这里配置
      "maxConcurrent": 4,                     // ✅ 在这里配置
      "subagents": { "maxConcurrent": 8 }     // ✅ 在这里配置
    }
  }
}
```

--------------------------------

### Troubleshoot Gateway Startup Failure - Check Logs

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/03-advanced/09-multi-platform-integration.md

View the last 50 lines of the main assistant log file to diagnose startup issues.

```bash
# 1. 查看日志
tail -50 logs-main-assistant.log
```

--------------------------------

### Install OpenClaw CLI Only

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/02-installation.md

Use the official installation script with the --no-onboard flag to install only the CLI without running the initial onboarding process.

```bash
curl -fsSL https://openclaw.ai/install.sh | bash -s -- --no-onboard
```

--------------------------------

### Install Latest Stable Version of Openclaw

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/index.md

Install the latest stable version of Openclaw using npm. After installation, verify the version to ensure it is the expected stable release.

```bash
npm install -g openclaw@2026.4.14
openclaw --version
```

--------------------------------

### Install SkillVetter using ClawHub

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/B-skills-catalog.md

Installs the SkillVetter security auditing tool via the ClawHub package manager. This is the recommended first step for ensuring the safety of other installed Skills.

```bash
clawhub install skill-vetter
```

--------------------------------

### Install OpenClaw Globally via npm

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/02-installation.md

Install the latest stable version of OpenClaw globally using npm in a PowerShell environment. Also shows how to install a specific language version.

```powershell
# Install latest stable version
npm install -g openclaw@latest

# Or install the Chinese version
npm install -g @qingchencloud/openclaw-zh@latest
```

--------------------------------

### Update Ubuntu System and Install Base Tools

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/02-installation.md

Execute these commands within your Ubuntu terminal after installation to update packages and install essential tools like curl, git, and build-essential.

```bash
sudo apt update && sudo apt upgrade -y

sudo apt install -y curl git wget build-essential
```

--------------------------------

### Configure Installed Skills

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/E-config-templates.md

This JSON snippet shows how to configure installed Skills, including enabling them and setting environment variables like API keys. Each skill slug corresponds to an installed skill.

```json
{
  "skills": {
    "entries": {
      "nano-banana-pro": {
        "enabled": true,
        "env": {
          "GEMINI_API_KEY": "your-gemini-key"
        }
      },
      "brave-search": {
        "enabled": true,
        "env": {
          "BRAVE_API_KEY": "your-brave-key"
        }
      },
      "tavily-search": {
        "enabled": true,
        "env": {
          "TAVILY_API_KEY": "your-tavily-key"
        }
      }
    }
  }
}
```

--------------------------------

### Configure Auto-start with launchd (macOS)

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/03-advanced/09-multi-platform-integration.md

Create a launchd plist file to automatically start the main-assistant gateway on system load.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
  <key>Label</key>
  <string>com.openclaw.main-assistant</string>
  <key>ProgramArguments</key>
  <array>
    <string>/usr/local/bin/openclaw</string>
    <string>--profile</string>
    <string>main-assistant</string>
    <string>gateway</string>
    <string>run</string>
  </array>
  <key>RunAtLoad</key>
  <true/>
  <key>KeepAlive</key>
  <true/>
</dict>
</plist>
```

--------------------------------

### Skill Configuration Example

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/J-tencent-deep-dive.md

Defines the metadata for a skill, including its name, description, homepage, and requirements like necessary binary dependencies.

```yaml
name: weather
description: "Get current weather and forecasts via wttr.in or Open-Meteo. Use when: user asks about weather, temperature, or forecasts for any location. NOT for: historical weather data, severe weather alerts, or detailed meteorological analysis. No API key needed."
homepage: https://wttr.in/:help
metadata: {
  "openclaw": {
    "emoji": "🌤️",
    "requires": {
      "bins": ["curl"]
    }
  }
}
```

--------------------------------

### Configure OpenClaw with Kimi 2.5

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/02-installation.md

Use this command to start the OpenClaw onboarding process for Kimi 2.5. Follow the prompts to select Moonshot AI as the provider, paste your Kimi API key, and choose the default model.

```bash
# Run the configuration wizard
openclaw onboard

# Configuration process:
# 1. Select QuickStart
# 2. Select model provider: Moonshot AI
# 3. Paste the API Key you just copied
# 4. Select default model: kimi-code/kimi-for-codi
# 5. Complete other configurations
```

--------------------------------

### Install WeChat ClawBot Plugin

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/E-common-problems.md

Install the official WeChat ClawBot plugin for OpenClaw.

```bash
openclaw plugins install @openclaw/wechat-clawbot
```

--------------------------------

### Install Content Creation Skills Set

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/B-skills-catalog.md

Installs a set of skills focused on content creation, including writing, video production, and creative design.

```bash
clawhub install brave-search summarize \
  design-doc-mermaid nano-banana-pro
```

--------------------------------

### List Installed Skills

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/E-common-problems.md

List all installed Skills using the clawhub list command.

```bash
clawhub list
```

--------------------------------

### Cookie Value Example (Individual)

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/tutorials/CSDN-Cookie获取教程.md

Example of how to provide individual cookie values when requested.

```text
SESSION: xxxxxx
token: xxxxxx
```

--------------------------------

### Enable OpenClaw Gateway for Auto-start

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/01-basics/02-installation.md

Configure the OpenClaw Gateway to start automatically on system boot using systemd.

```bash
openclaw gateway enable
```

--------------------------------

### Example of Single-Agent Architecture Problem

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/appendix/J-tencent-deep-dive.md

Illustrates a scenario where a RAG tutor agent, after discussing C++ content, incorrectly provides C++ related examples instead of Flutter examples due to persistent memory.

```text
先构建一个RAG tutor Agent，让它来强化我们Flutter的技能。

当我中途和该Agent讨论过C++的内容，那么因为memory机制的问题，
后续和该Agent多轮对话过程中，它都会带着C++相关的记忆，
让它提供Demo示例时，它不会提供Flutter相关，而提供了C++相关的示例。
```

--------------------------------

### Create Agent Configuration Directories

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/03-advanced/09-multi-platform-integration.md

Use this bash command to create separate configuration directories for each agent when setting up multiple Gateways.

```bash
mkdir -p agent-configs/{main-agent,content-agent,tech-agent,ainews-agent}
```

--------------------------------

### Check Port Usage and Start Backend

Source: https://github.com/xianyu110/awesome-openclaw-tutorial/blob/main/docs/03-advanced/09-multi-platform-integration.md

Use `lsof` to check if a port is occupied and `npm run server` to manually start the backend service.

```bash
# 检查端口占用
lsof -i :3001

# 手动启动后端
npm run server
```
Tokens:
Raw