### Install LiteLLM Proxy and Start

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/providers/litellm.md

Install the LiteLLM proxy package and start the service. This is part of the manual setup process.

```bash
pip install 'litellm[proxy]'
litellm --model claude-opus-4-6
```

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

### Install and Setup Honcho Plugin

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/concepts/memory-honcho.md

Install the Honcho plugin, run its setup command to configure credentials and migrate existing memory, and restart the gateway.

```bash
openclaw plugins install @honcho-ai/openclaw-honcho
openclaw honcho setup
openclaw gateway --force
```

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

### Initialize ClawDock Setup

Source: https://github.com/dsactivi-2/openclaw/blob/main/scripts/clawdock/README.md

Starts the initial setup process for ClawDock, including detecting and configuring the OpenClaw directory. This command should be run once after installation.

```bash
clawdock-start
```

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

### Local PostgreSQL Setup on Linux (Debian/Ubuntu)

Source: https://github.com/dsactivi-2/openclaw/blob/main/extensions/open-prose/skills/prose/state/postgres.md

Install and start PostgreSQL using apt on Debian/Ubuntu systems. Create a database and configure the .prose/.env file.

```bash
sudo apt install postgresql
sudo systemctl start postgresql
sudo -u postgres createdb myproject
echo "OPENPROSE_POSTGRES_URL=postgresql:///myproject" >> .prose/.env
```

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

### Install and Run OpenClaw from Source

Source: https://github.com/dsactivi-2/openclaw/blob/main/README.md

Use these commands to clone the repository, install dependencies, and set up the local environment for development. The `setup` command is for initial configuration or after resetting local state. `gateway:watch` provides a development loop with auto-reloading.

```bash
git clone https://github.com/openclaw/openclaw.git
cd openclaw

pnpm install

# First run only (or after resetting local OpenClaw config/workspace)
pnpm openclaw setup

# Optional: prebuild Control UI before first startup
pnpm ui:build

# Dev loop (auto-reload on source/config changes)
pnpm gateway:watch
```

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

### Setup OpenClaw Development Environment (Bash)

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/platforms/windows.md

Installs dependencies and sets up the OpenClaw development environment from source. Use 'pnpm openclaw setup' for the initial configuration and 'pnpm gateway:watch' to start the development server.

```bash
pnpm install
# First run only (or after resetting local OpenClaw config/workspace)
pnpm openclaw setup
pnpm gateway:watch
```

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

### OpenClaw Onboarding - Interactive Setup Wizard

Source: https://context7.com/dsactivi-2/openclaw/llms.txt

Use the 'onboard' command for guided setup of gateway, workspace, authentication, channels, and skills. Supports interactive and non-interactive modes for automation.

```bash
openclaw onboard
```

```bash
openclaw onboard --flow quickstart
```

```bash
openclaw onboard --flow manual
```

```bash
openclaw onboard --non-interactive \
  --auth-choice openai-api-key \
  --secret-input-mode ref \
  --accept-risk
```

```bash
openclaw onboard --non-interactive \
  --auth-choice custom-api-key \
  --custom-base-url "https://llm.example.com/v1" \
  --custom-model-id "foo-large" \
  --custom-api-key "$CUSTOM_API_KEY" \
  --secret-input-mode plaintext \
  --custom-compatibility openai
```

```bash
openclaw onboard --non-interactive \
  --auth-choice ollama \
  --custom-base-url "http://ollama-host:11434" \
  --custom-model-id "qwen3.5:27b" \
  --accept-risk
```

```bash
openclaw onboard --mode remote --remote-url wss://gateway-host:18789
```

```bash
export OPENCLAW_GATEWAY_TOKEN="your-token"
openclaw onboard --non-interactive \
  --mode local \
  --auth-choice skip \
  --gateway-auth token \
  --gateway-token-ref-env OPENCLAW_GATEWAY_TOKEN \
  --accept-risk
```

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

### Install OpenClaw from Source (Bash)

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/platforms/windows.md

Installs OpenClaw by cloning the repository, installing dependencies, building the project, and onboarding the daemon. This is for a normal first-time setup.

```bash
git clone https://github.com/openclaw/openclaw.git
cd openclaw
pnpm install
pnpm build
pnpm ui:build
pnpm openclaw onboard --install-daemon
```

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

### Install and Run Convex Dev Server

Source: https://github.com/dsactivi-2/openclaw/blob/main/qa/convex-credential-broker/README.md

Install project dependencies and start the local Convex development server.

```bash
cd qa/convex-credential-broker
npm install
npx convex dev
```

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

### Basic Openclaw Onboarding

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/cli/onboard.md

Initiates the openclaw onboarding process. Use `--flow quickstart` for a streamlined setup or `--flow manual` for detailed configuration.

```bash
openclaw onboard
```

```bash
openclaw onboard --flow quickstart
```

```bash
openclaw onboard --flow manual
```

```bash
openclaw onboard --mode remote --remote-url wss://gateway-host:18789
```

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

### Quick Start Examples for Summarize CLI

Source: https://github.com/dsactivi-2/openclaw/blob/main/skills/summarize/SKILL.md

Demonstrates basic usage for summarizing URLs, local files, and YouTube links. Ensure the model is specified.

```bash
summarize "https://example.com" --model google/gemini-3-flash-preview
summarize "/path/to/file.pdf" --model google/gemini-3-flash-preview
summarize "https://youtu.be/dQw4w9WgXcQ" --youtube auto
```

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

### Local PostgreSQL Setup on macOS

Source: https://github.com/dsactivi-2/openclaw/blob/main/extensions/open-prose/skills/prose/state/postgres.md

Install and start PostgreSQL 16 using Homebrew on macOS. Create a database and configure the .prose/.env file.

```bash
brew install postgresql@16
brew services start postgresql@16
createdb myproject
echo "OPENPROSE_POSTGRES_URL=postgresql://localhost/myproject" >> .prose/.env
```

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

### Manual Docker Setup Flow

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/install/docker.md

Manually builds the Docker image, runs onboarding and configuration steps, and starts the gateway. Use this if you prefer not to use the setup script.

```bash
docker build -t openclaw:local -f Dockerfile .
docker compose run --rm --no-deps --entrypoint node openclaw-gateway \
  dist/index.js onboard --mode local --no-install-daemon
docker compose run --rm --no-deps --entrypoint node openclaw-gateway \
  dist/index.js config set --batch-json '[{"path":"gateway.mode","value":"local"},{"path":"gateway.bind","value":"lan"},{"path":"gateway.controlUi.allowedOrigins","value":["http://localhost:18789","http://127.0.0.1:18789"]}]'
docker compose up -d openclaw-gateway
```

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

### BluCLI Quick Start Commands

Source: https://github.com/dsactivi-2/openclaw/blob/main/skills/blucli/SKILL.md

Basic commands to get started with blucli for device discovery, status checks, playback control, and volume adjustment.

```bash
blu devices
```

```bash
blu --device <id> status
```

```bash
blu play|pause|stop
```

```bash
blu volume set 15
```

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

### Basic Plugin Configuration

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/plugins/architecture.md

Define plugin extensions and a setup entry point in package.json. Ensure npm dependencies are installed within the plugin directory.

```json
{
  "name": "my-pack",
  "openclaw": {
    "extensions": ["./src/safety.ts", "./src/tools.ts"],
    "setupEntry": "./src/setup-entry.ts"
  }
}
```

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

### OpenCLaw Example: Hello World

Source: https://github.com/dsactivi-2/openclaw/blob/main/extensions/open-prose/skills/prose/help.md

The '01-hello-world.prose' example is the simplest program to get started with OpenCLaw.

```prose
# 01-hello-world.prose
```

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

### Install and Run Restaurant Finder Client

Source: https://github.com/dsactivi-2/openclaw/blob/main/vendor/a2ui/README.md

Navigate to the client directory, install dependencies using npm, and then run the development server.

```bash
cd samples/client/lit/shell
npm install
npm run dev
```

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

### Display install.sh help

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/install/installer.md

Downloads and executes the install.sh script with the --help flag to display available options and usage instructions.

```bash
curl -fsSL --proto '=https' --tlsv1.2 https://openclaw.sh | bash -s -- --help
```

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

### Run Initial Docker Setup Script

Source: https://github.com/dsactivi-2/openclaw/blob/main/scripts/clawdock/README.md

Execute the setup script to build the Docker image, create the project .env file, and initialize necessary directories.

```bash
./docker-setup.sh
```

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

### Channel Catalog Metadata Example

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/plugins/architecture.md

Defines metadata for a channel plugin, including its ID, label, documentation path, and installation details. This JSON structure is used to advertise setup and discovery information.

```json
{
  "name": "@openclaw/nextcloud-talk",
  "openclaw": {
    "extensions": ["./index.ts"],
    "channel": {
      "id": "nextcloud-talk",
      "label": "Nextcloud Talk",
      "selectionLabel": "Nextcloud Talk (self-hosted)",
      "docsPath": "/channels/nextcloud-talk",
      "docsLabel": "nextcloud-talk",
      "blurb": "Self-hosted chat via Nextcloud Talk webhook bots.",
      "order": 65,
      "aliases": ["nc-talk", "nc"]
    },
    "install": {
      "npmSpec": "@openclaw/nextcloud-talk",
      "localPath": "<bundled-plugin-local-path>",
      "defaultChoice": "npm"
    }
  }
}
```

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

### Get ACP Install Steps

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/tools/acp-agents.md

Prints deterministic install and enable steps for ACP.

```bash
/acp install
```

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

### Browse and Run Example Programs

Source: https://github.com/dsactivi-2/openclaw/blob/main/extensions/open-prose/skills/prose/help.md

Access and execute example programs provided with OpenProse using the 'prose examples' command.

```bash
prose examples
```

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

### Add, Login, and Setup Auth

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/cli/models.md

These commands manage authentication profiles. `add` is an interactive helper, `login` runs a provider's auth flow, and `setup-token` or `paste-token` handle generic token authentication.

```bash
openclaw models auth add
openclaw models auth login --provider <id>
openclaw models auth setup-token --provider <id>
openclaw models auth paste-token
```

```bash
openclaw models auth login --provider openai-codex --set-default
```

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

### Quick Start OpenClaw Installation

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/install/ansible.md

Execute this command to automatically install OpenClaw with its security features. It downloads and runs an installation script from GitHub.

```bash
curl -fsSL https://raw.githubusercontent.com/openclaw/openclaw-ansible/main/install.sh | bash
```

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

### Run Onboarding with LiteLLM

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/providers/litellm.md

Use this command for the quickest setup of LiteLLM with OpenClaw.

```bash
openclaw onboard --auth-choice litellm-api-key
```

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

### Start LM Studio Daemon

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/providers/lmstudio.md

Starts the LM Studio headless daemon. This command assumes the daemon has been installed.

```bash
lms daemon up
```

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

### Run an Example Program

Source: https://github.com/dsactivi-2/openclaw/blob/main/extensions/open-prose/skills/prose/help.md

Execute a sample OpenProse program using the 'prose run' command followed by the path to the example file.

```bash
prose run examples/01-hello-world.prose
```

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

### Full CLI Backend Configuration Example

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/gateway/cli-backends.md

A comprehensive example demonstrating various configuration options for CLI backends, including command, arguments, output format, model aliasing, session management, and system prompt handling.

```json5
{
  agents: {
    defaults: {
      cliBackends: {
        "codex-cli": {
          command: "/opt/homebrew/bin/codex",
        },
        "my-cli": {
          command: "my-cli",
          args: ["--json"],
          output: "json",
          input: "arg",
          modelArg: "--model",
          modelAliases: {
            "claude-opus-4-6": "opus",
            "claude-sonnet-4-6": "sonnet",
          },
          sessionArg: "--session",
          sessionMode: "existing",
          sessionIdFields: ["session_id", "conversation_id"],
          systemPromptArg: "--system",
          // Codex-style CLIs can point at a prompt file instead:
          // systemPromptFileConfigArg: "-c",
          // systemPromptFileConfigKey: "model_instructions_file",
          systemPromptWhen: "first",
          imageArg: "--image",
          imageMode: "repeat",
          serialize: true,
        },
      },
    },
  },
}
```

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

### Install WhatsApp Plugin

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/channels/whatsapp.md

Use this command to manually install the WhatsApp plugin if it's not automatically prompted during channel setup.

```bash
openclaw plugins install @openclaw/whatsapp
```

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

### Install OpenCLAW (Skip Onboarding)

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/install/installer.md

Installs OpenCLAW while skipping the initial onboarding process. Use this if you want to bypass interactive setup.

```bash
curl -fsSL --proto '=https' --tlsv1.2 https://openclaw.ai/install.sh | bash -s -- --no-onboard
```

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

### Install from Marketplace (Local Path)

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/cli/plugins.md

Install a plugin from a local marketplace directory using the `--marketplace` flag.

```bash
openclaw plugins install <plugin-name> --marketplace ./my-marketplace
```

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

### Install OpenClaw without Onboarding (macOS/Linux/WSL2)

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/install/index.md

Installs OpenClaw without launching the onboarding process. Useful for automated or headless setups.

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

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

### Run Interactive Vydra Onboarding

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/providers/vydra.md

Initiate the Vydra API key setup process interactively.

```bash
openclaw onboard --auth-choice vydra-api-key
```

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

### Gateway Setup with Tailscale

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/help/faq.md

Instructions for setting up Tailscale on a VPS and connecting from a Mac, including exposing the gateway service.

```APIDOC
## Gateway Setup with Tailscale

### Description
Instructions for setting up Tailscale on a VPS and connecting from a Mac, including exposing the gateway service.

### Steps

1.  **Install and login on the VPS**:
    ```bash
    curl -fsSL https://tailscale.com/install.sh | sh
    sudo tailscale up
    ```

2.  **Install and login on your Mac**:
    - Use the Tailscale app and sign in to the same tailnet.

3.  **Enable MagicDNS (recommended)**:
    - In the Tailscale admin console, enable MagicDNS for a stable VPS name.

4.  **Use the tailnet hostname**:
    - SSH: `ssh user@your-vps.tailnet-xxxx.ts.net`
    - Gateway WS: `ws://your-vps.tailnet-xxxx.ts.net:18789`

### Exposing Gateway via Tailscale Serve
To access the Control UI without SSH, use Tailscale Serve on the VPS:

```bash
openclaw gateway --tailscale serve
```

This binds the gateway to loopback and exposes HTTPS via Tailscale.

### Related Documentation
- [Tailscale](/gateway/tailscale)
```

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

### CLI Command for Location Get

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/nodes/location-command.md

Example of how to invoke the `location.get` command via the CLI using the `openclaw nodes location get` command.

```bash
openclaw nodes location get --node <id>
```

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

### Install from Marketplace (GitHub Repo URL)

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/cli/plugins.md

Install a plugin from a GitHub repository using its URL with the `--marketplace` flag.

```bash
openclaw plugins install <plugin-name> --marketplace https://github.com/<owner>/<repo>
```

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

### Create an Optional Channel Setup Surface

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/plugins/sdk-setup.md

Use createOptionalChannelSetupSurface to generate both a setup adapter and wizard for a channel, making the setup surface optional. This helper simplifies the creation of optional installation surfaces for channels.

```typescript
import { createOptionalChannelSetupSurface } from "openclaw/plugin-sdk/channel-setup";

const setupSurface = createOptionalChannelSetupSurface({
  channel: "my-channel",
  label: "My Channel",
  npmSpec: "@myorg/openclaw-my-channel",
  docsPath: "/channels/my-channel",
});
// Returns { setupAdapter, setupWizard }
```

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

### Install from Marketplace (Shorthand)

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/cli/plugins.md

Use the `plugin@marketplace` shorthand when the marketplace name exists in Claude's local registry cache.

```bash
openclaw plugins install <plugin-name>@<marketplace-name>
```

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

### Install and Use Node.js with fnm

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/install/node.md

Example of using the fnm (Fast Node Manager) version manager to install and switch to Node.js version 24.

```bash
fnm install 24
```

```bash
fnm use 24
```

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

### Start Local Nostr Relay with Strfry

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/channels/nostr.md

Use this command to start a local Nostr relay for testing purposes. Ensure Docker is installed and running.

```bash
# Start strfry
docker run -p 7777:7777 ghcr.io/hoytech/strfry
```

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

### Display install-cli.sh help

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/install/installer.md

Downloads and executes the install-cli.sh script with the --help flag to display available options and usage instructions for the CLI installer.

```bash
curl -fsSL --proto '=https' --tlsv1.2 https://openclaw.ai/install-cli.sh | bash -s -- --help
```

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

### Install from Marketplace (Explicit Name)

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/cli/plugins.md

Use the `--marketplace` flag to explicitly specify the marketplace name for installation.

```bash
openclaw plugins install <plugin-name> --marketplace <marketplace-name>
```

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

### Setup DNS Server for Wide-Area Bonjour

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/gateway/bonjour.md

Command to install and configure CoreDNS on the gateway host for serving DNS-SD records. This setup is for the gateway host itself.

```bash
openclaw dns setup --apply
```

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

### Install OpenClaw without Onboarding (Windows PowerShell)

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/install/index.md

Installs OpenClaw on Windows without launching the onboarding process. Useful for automated or headless setups.

```powershell
& ([scriptblock]::Create((iwr -useb https://openclaw.ai/install.ps1))) -NoOnboard
```

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

### Onboard and Install OpenClaw Service

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/index.md

Onboard a new OpenClaw instance and install it as a system daemon for background operation. This command initiates the setup process.

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

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

### Define Setup Metadata for Providers and CLI Backends

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/plugins/manifest.md

The `setup` block provides metadata for setup and onboarding surfaces before runtime loads. It includes provider configurations, CLI backends, and config migration information. Set `requiresRuntime: true` if richer setup-time runtime hooks are needed.

```json
{
  "setup": {
    "providers": [
      {
        "id": "openai",
        "authMethods": ["api-key"],
        "envVars": ["OPENAI_API_KEY"]
      }
    ],
    "cliBackends": ["openai-cli"],
    "configMigrations": ["legacy-openai-auth"],
    "requiresRuntime": false
  }
}
```

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

### Get One-line Weather Summary

Source: https://github.com/dsactivi-2/openclaw/blob/main/skills/weather/SKILL.md

Use this command to get a concise, one-line summary of the current weather for a specific location. Requires `curl` to be installed.

```bash
curl "wttr.in/London?format=3"
```

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

### Install from Marketplace (GitHub Repo Shorthand)

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/cli/plugins.md

Install a plugin from a GitHub repository using the `owner/repo` shorthand with the `--marketplace` flag.

```bash
openclaw plugins install <plugin-name> --marketplace <owner/repo>
```

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

### Borges: Initial Setup

Source: https://github.com/dsactivi-2/openclaw/blob/main/extensions/open-prose/skills/prose/alts/borges.md

This snippet shows the initial setup for a Borges-style program, including retrieving external knowledge and defining a dreamer helper.

```borges
retrieve "@alice/research" as research
axiom topic: "What to investigate"

dreamer helper:
  author: sonnet

inscribe findings = dream: helper
  query: "Research {topic}"

theorem summary = dream "Summarize"
  memory: findings
```

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

### Run OpenClaw Channel Setup Wizard

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/channels/matrix.md

Initiates the interactive wizard for adding and configuring channels in OpenClaw. Use this to start the setup process for new channels.

```bash
openclaw channels add
openclaw configure --section channels
```

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

### Plugin with Deferred Startup Configuration

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/plugins/architecture.md

Configure a plugin to use a setup entry for startup and defer full channel loading until after the gateway listens. This is useful when the setup entry provides all necessary startup capabilities.

```json
{
  "name": "@scope/my-channel",
  "openclaw": {
    "extensions": ["./index.ts"],
    "setupEntry": "./setup-entry.ts",
    "startup": {
      "deferConfiguredChannelFullLoadUntilAfterListen": true
    }
  }
}
```

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

### Install acpx Plugin

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/tools/acp-agents.md

Install the acpx backend plugin using the OpenClaw CLI. This command is used for initial setup or when switching to a local development checkout.

```bash
openclaw plugins install acpx
```

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

### gog CLI Setup and Authentication

Source: https://github.com/dsactivi-2/openclaw/blob/main/skills/gog/SKILL.md

Initial setup and authentication for the gog CLI. Requires a client secret JSON file and adding your account with specified services.

```bash
gog auth credentials /path/to/client_secret.json
```

```bash
gog auth add you@gmail.com --services gmail,calendar,drive,contacts,docs,sheets
```

```bash
gog auth list
```

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

### Quick Start Foodora Commands

Source: https://github.com/dsactivi-2/openclaw/blob/main/skills/ordercli/SKILL.md

Basic commands to get started with ordercli for Foodora. Includes checking countries, setting configuration, logging in, and viewing orders.

```bash
ordercli foodora countries
```

```bash
ordercli foodora config set --country AT
```

```bash
ordercli foodora login --email you@example.com --password-stdin
```

```bash
ordercli foodora orders
```

```bash
ordercli foodora history --limit 20
```

```bash
ordercli foodora history show <orderCode>
```

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

### Switch from npm to Git install for OpenClaw

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/help/faq.md

Follow these steps to switch your OpenClaw installation from npm to a Git-based setup. This process involves cloning the repository, installing dependencies, building the project, and updating the gateway service configuration.

```bash
git clone https://github.com/openclaw/openclaw.git
cd openclaw
pnpm install
pnpm build
openclaw doctor
openclaw gateway restart
```

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

### Install OpenClaw CLI and Run Onboarding

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/install/installer.md

Installs the OpenClaw CLI and immediately runs the onboarding process. This is convenient for new users who want to set up OpenClaw interactively after installation.

```bash
curl -fsSL --proto '=https' --tlsv1.2 https://openclaw.ai/install-cli.sh | bash -s -- --onboard
```

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

### Switch from Git to npm install for OpenClaw

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/help/faq.md

To switch your OpenClaw installation from a Git-based setup to the npm package, use this command to install the latest version globally. The `openclaw doctor` command will then help in updating the gateway service configuration.

```bash
npm install -g openclaw@latest
openclaw doctor
openclaw gateway restart
```

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

### Check OpenClaw Version and Start Gateway

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/platforms/mac/bundled-gateway.md

Verifies the installed openclaw CLI version and starts the gateway with specific port and bind configurations. Useful for smoke testing.

```bash
openclaw --version
```

```bash
OPENCLAW_SKIP_CHANNELS=1 \
OPENCLAW_SKIP_CANVAS_HOST=1 \
openclaw gateway --port 18999 --bind loopback
```

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

### Groq Configuration File Example

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/providers/groq.md

A complete configuration file example for Groq, including setting the API key and the default model. Ensure the API key is kept secure.

```json5
{
  env: { GROQ_API_KEY: "gsk_..." },
  agents: {
    defaults: {
      model: { primary: "groq/llama-3.3-70b-versatile" },
    },
  },
}
```

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

### QA Scenario for Skill Install Hot Availability

Source: https://github.com/dsactivi-2/openclaw/blob/main/qa/scenarios/plugins/skill-install-hot-availability.md

Defines a test scenario to verify skill install hot availability. It includes setup, execution, and success criteria for the test.

```yaml
id: skill-install-hot-availability
title: Skill install hot availability
surface: skills
coverage:
  primary:
    - plugins.skills
  secondary:
    - plugins.hot-install
objective: Verify a newly added workspace skill shows up without a broken intermediate state and can influence the next turn immediately.
successCriteria:
  - Skill is absent before install.
  - skills.status reports it after install without a restart.
  - The next agent turn reflects the new skill marker.
docsRefs:
  - docs/tools/skills.md
  - docs/gateway/configuration.md
codeRefs:
  - src/agents/skills-status.ts
  - extensions/qa-lab/src/suite.ts
execution:
  kind: flow
  summary: Verify a newly added workspace skill shows up without a broken intermediate state and can influence the next turn immediately.
  config:
    skillName: qa-hot-install-skill
    skillBody: |-
      ---
      name: qa-hot-install-skill
      description: Hot install QA marker
      ---
      When the user asks for the hot install marker exactly, reply with exactly: HOT-INSTALL-OK
    prompt: "Hot install marker: give me the hot install marker exactly."
    expectedContains: "HOT-INSTALL-OK"
```

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

### Start and Open URL with Browser Profile

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/cli/browser.md

Quickly start a browser instance with a specific profile and open a URL. Ensure the browser profile is configured.

```bash
openclaw browser --browser-profile openclaw start
openclaw browser --browser-profile openclaw open https://example.com
```

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

### OpenProse Directory Structure and .env Example

Source: https://github.com/dsactivi-2/openclaw/blob/main/extensions/open-prose/skills/prose/state/postgres.md

Illustrates the typical project directory structure for OpenProse, highlighting the location of the .prose/.env file and the runs directory.

```text
your-project/
├── .prose/
│   ├── .env                    # OPENPROSE_POSTGRES_URL=...
│   └── runs/                   # Execution metadata and attachments
│       └── {YYYYMMDD}-{HHMMSS}-{random}/
│           ├── program.prose   # Copy of running program
│           └── attachments/    # Large outputs (optional)
├── .gitignore                  # Should exclude .prose/.env
└── your-program.prose
```

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

### Onboard fal API Key

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/providers/fal.md

Use this command to onboard the fal provider by setting up the FAL_KEY authentication. This is the initial step for using fal services.

```bash
openclaw onboard --auth-choice fal-api-key
```

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

### Install and Watch Gateway (pnpm)

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/start/setup.md

Commands for installing dependencies and starting the OpenClaw Gateway in watch mode using pnpm. This workflow is for bleeding-edge development, enabling hot-reloading on source changes.

```bash
pnpm install
pnpm openclaw setup
pnpm gateway:watch
```

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

### Recommended OpenClaw Installation

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/help/faq.md

Installs OpenClaw using the recommended method and onboards the system, typically starting the Gateway on port 18789. The wizard can also build UI assets automatically.

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

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

### Running OpenProse Examples

Source: https://github.com/dsactivi-2/openclaw/blob/main/extensions/open-prose/skills/prose/examples/README.md

Shows how to execute OpenProse examples using Claude, either by referencing the example name or the file path.

```shell
Run the code review example from the OpenProse examples
```

```shell
Execute examples/03-code-review.prose
```

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

### Node Manager Installation Options

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/start/wizard-cli-reference.md

Command-line flag for specifying the node package manager during setup.

```bash
setup --node-manager
```

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

### Transcribe audio with a prompt

Source: https://github.com/dsactivi-2/openclaw/blob/main/skills/openai-whisper-api/SKILL.md

Provide a prompt to guide the transcription, for example, to specify speaker names.

```bash
{baseDir}/scripts/transcribe.sh /path/to/audio.m4a --prompt "Speaker names: Peter, Daniel"
```

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

### Setup Configuration

Source: https://github.com/dsactivi-2/openclaw/blob/main/docs/plugins/manifest.md

Provides metadata for setup and onboarding surfaces, including provider details, CLI backends, and configuration migrations.

```APIDOC
## Setup Reference

Use `setup` when setup and onboarding surfaces need cheap plugin-owned metadata before runtime loads.

### Request Body Example
```json
{
  "setup": {
    "providers": [
      {
        "id": "openai",
        "authMethods": ["api-key"],
        "envVars": ["OPENAI_API_KEY"]
      }
    ],
    "cliBackends": ["openai-cli"],
    "configMigrations": ["legacy-openai-auth"],
    "requiresRuntime": false
  }
}
```

### Parameters
#### Request Body Parameters
- **setup** (object) - Optional - Setup configuration for the plugin.
  - **providers** (array) - Optional - Provider configurations for setup/onboarding.
    - **id** (string) - Required - Provider id exposed during setup or onboarding. Keep normalized ids globally unique.
    - **authMethods** (string[]) - Optional - Setup/auth method ids this provider supports without loading full runtime.
    - **envVars** (string[]) - Optional - Env vars that generic setup/status surfaces can check before plugin runtime loads.
  - **cliBackends** (string[]) - Optional - Setup-specific descriptor surface for control-plane/setup flows that should stay metadata-only.
  - **configMigrations** (string[]) - Optional - Configuration migration identifiers.
  - **requiresRuntime** (boolean) - Optional - Indicates if richer setup-time runtime hooks are needed.
```