mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-06 13:10:43 +00:00
docs: normalize frontmatter titles to sentence case
This commit is contained in:
Vincent Koc
@@ -3,7 +3,7 @@ summary: "Run agent turns from the CLI and optionally deliver replies to channel
|
||||
read_when:
|
||||
- You want to trigger agent runs from scripts or the command line
|
||||
- You need to deliver agent replies to a chat channel programmatically
|
||||
title: "Agent Send"
|
||||
title: "Agent send"
|
||||
---
|
||||
|
||||
`openclaw agent` runs a single agent turn from the command line without needing
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "Apply multi-file patches with the apply_patch tool"
|
||||
read_when:
|
||||
- You need structured file edits across multiple files
|
||||
- You want to document or debug patch-based edits
|
||||
title: "apply_patch Tool"
|
||||
title: "apply_patch tool"
|
||||
---
|
||||
|
||||
Apply file changes using a structured patch format. This is ideal for multi-file
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "Brave Search API setup for web_search"
|
||||
read_when:
|
||||
- You want to use Brave Search for web_search
|
||||
- You need a BRAVE_API_KEY or plan details
|
||||
title: "Brave Search"
|
||||
title: "Brave search"
|
||||
---
|
||||
|
||||
# Brave Search API
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
summary: "Fix Chrome/Brave/Edge/Chromium CDP startup issues for OpenClaw browser control on Linux"
|
||||
read_when: "Browser control fails on Linux, especially with snap Chromium"
|
||||
title: "Browser Troubleshooting"
|
||||
title: "Browser troubleshooting"
|
||||
---
|
||||
|
||||
# Browser Troubleshooting (Linux)
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "Manual logins for browser automation + X/Twitter posting"
|
||||
read_when:
|
||||
- You need to log into sites for browser automation
|
||||
- You want to post updates to X/Twitter
|
||||
title: "Browser Login"
|
||||
title: "Browser login"
|
||||
---
|
||||
|
||||
# Browser login + X/Twitter posting
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "Ephemeral side questions with /btw"
|
||||
read_when:
|
||||
- You want to ask a quick side question about the current session
|
||||
- You are implementing or debugging BTW behavior across clients
|
||||
title: "BTW Side Questions"
|
||||
title: "BTW side questions"
|
||||
---
|
||||
|
||||
`/btw` lets you ask a quick side question about the **current session** without
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- Adding a new core capability and plugin registration surface
|
||||
- Deciding whether code belongs in core, a vendor plugin, or a feature plugin
|
||||
- Wiring a new runtime helper for channels or tools
|
||||
title: "Adding Capabilities (Contributor Guide)"
|
||||
title: "Adding capabilities (contributor guide)"
|
||||
sidebarTitle: "Adding Capabilities"
|
||||
---
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- You want to enable or configure code_execution
|
||||
- You want remote analysis without local shell access
|
||||
- You want to combine x_search or web_search with remote Python analysis
|
||||
title: "Code Execution"
|
||||
title: "Code execution"
|
||||
---
|
||||
|
||||
`code_execution` runs sandboxed remote Python analysis on xAI's Responses API.
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Creating Skills"
|
||||
title: "Creating skills"
|
||||
summary: "Build and test custom workspace skills with SKILL.md"
|
||||
read_when:
|
||||
- You are creating a new custom skill in your workspace
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- You want a web search provider that requires no API key
|
||||
- You want to use DuckDuckGo for web_search
|
||||
- You need a zero-config search fallback
|
||||
title: "DuckDuckGo Search"
|
||||
title: "DuckDuckGo search"
|
||||
---
|
||||
|
||||
OpenClaw supports DuckDuckGo as a **key-free** `web_search` provider. No API
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "Elevated exec mode: run commands outside the sandbox from a sandboxed
|
||||
read_when:
|
||||
- Adjusting elevated mode defaults, allowlists, or slash command behavior
|
||||
- Understanding how sandboxed agents can access the host
|
||||
title: "Elevated Mode"
|
||||
title: "Elevated mode"
|
||||
---
|
||||
|
||||
When an agent runs inside a sandbox, its `exec` commands are confined to the
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- You want to use Exa for web_search
|
||||
- You need an EXA_API_KEY
|
||||
- You want neural search or content extraction
|
||||
title: "Exa Search"
|
||||
title: "Exa search"
|
||||
---
|
||||
|
||||
OpenClaw supports [Exa AI](https://exa.ai/) as a `web_search` provider. Exa
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "Exec tool usage, stdin modes, and TTY support"
|
||||
read_when:
|
||||
- Using or modifying the exec tool
|
||||
- Debugging stdin or TTY behavior
|
||||
title: "Exec Tool"
|
||||
title: "Exec tool"
|
||||
---
|
||||
|
||||
Run shell commands in the workspace. Supports foreground + background execution via `process`.
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- You want to use Gemini for web_search
|
||||
- You need a GEMINI_API_KEY
|
||||
- You want Google Search grounding
|
||||
title: "Gemini Search"
|
||||
title: "Gemini search"
|
||||
---
|
||||
|
||||
OpenClaw supports Gemini models with built-in
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "Grok web search via xAI web-grounded responses"
|
||||
read_when:
|
||||
- You want to use Grok for web_search
|
||||
- You need an XAI_API_KEY for web search
|
||||
title: "Grok Search"
|
||||
title: "Grok search"
|
||||
---
|
||||
|
||||
OpenClaw supports Grok as a `web_search` provider, using xAI web-grounded
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- Generating images via the agent
|
||||
- Configuring image generation providers and models
|
||||
- Understanding the image_generate tool parameters
|
||||
title: "Image Generation"
|
||||
title: "Image generation"
|
||||
---
|
||||
|
||||
The `image_generate` tool lets the agent create and edit images using your configured providers. Generated images are delivered automatically as media attachments in the agent's reply.
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- You want to understand what tools OpenClaw provides
|
||||
- You need to configure, allow, or deny tools
|
||||
- You are deciding between built-in tools, skills, and plugins
|
||||
title: "Tools and Plugins"
|
||||
title: "Tools and plugins"
|
||||
---
|
||||
|
||||
Everything the agent does beyond generating text happens through **tools**.
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "Kimi web search via Moonshot web search"
|
||||
read_when:
|
||||
- You want to use Kimi for web_search
|
||||
- You need a KIMI_API_KEY or MOONSHOT_API_KEY
|
||||
title: "Kimi Search"
|
||||
title: "Kimi search"
|
||||
---
|
||||
|
||||
OpenClaw supports Kimi as a `web_search` provider, using Moonshot web search
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "JSON-only LLM tasks for workflows (optional plugin tool)"
|
||||
read_when:
|
||||
- You want a JSON-only LLM step inside workflows
|
||||
- You need schema-validated LLM output for automation
|
||||
title: "LLM Task"
|
||||
title: "LLM task"
|
||||
---
|
||||
|
||||
`llm-task` is an **optional plugin tool** that runs a JSON-only LLM task and
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- Looking for an overview of media capabilities
|
||||
- Deciding which media provider to configure
|
||||
- Understanding how async media generation works
|
||||
title: "Media Overview"
|
||||
title: "Media overview"
|
||||
---
|
||||
|
||||
# Media Generation and Understanding
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- You want to use MiniMax for web_search
|
||||
- You need a MiniMax Coding Plan key
|
||||
- You want MiniMax CN/global search host guidance
|
||||
title: "MiniMax Search"
|
||||
title: "MiniMax search"
|
||||
---
|
||||
|
||||
OpenClaw supports MiniMax as a `web_search` provider through the MiniMax
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
summary: “Per-agent sandbox + tool restrictions, precedence, and examples”
|
||||
title: Multi-Agent Sandbox & Tools
|
||||
title: Multi-agent sandbox & tools
|
||||
read_when: “You want per-agent sandboxing or per-agent tool allow/deny policies in a multi-agent gateway.”
|
||||
status: active
|
||||
---
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- Generating music or audio via the agent
|
||||
- Configuring music generation providers and models
|
||||
- Understanding the music_generate tool parameters
|
||||
title: "Music Generation"
|
||||
title: "Music generation"
|
||||
---
|
||||
|
||||
The `music_generate` tool lets the agent create music or audio through the
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- You want to use Ollama for web_search
|
||||
- You want a key-free web_search provider
|
||||
- You need Ollama Web Search setup guidance
|
||||
title: "Ollama Web Search"
|
||||
title: "Ollama web search"
|
||||
---
|
||||
|
||||
OpenClaw supports **Ollama Web Search** as a bundled `web_search` provider.
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "PDF Tool"
|
||||
title: "PDF tool"
|
||||
summary: "Analyze one or more PDF documents with native provider support and extraction fallback"
|
||||
read_when:
|
||||
- You want to analyze PDFs from agents
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "Perplexity Search API and Sonar/OpenRouter compatibility for web_searc
|
||||
read_when:
|
||||
- You want to use Perplexity Search for web search
|
||||
- You need PERPLEXITY_API_KEY or OPENROUTER_API_KEY setup
|
||||
title: "Perplexity Search"
|
||||
title: "Perplexity search"
|
||||
---
|
||||
|
||||
# Perplexity Search API
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- You want a self-hosted web search provider
|
||||
- You want to use SearXNG for web_search
|
||||
- You need a privacy-focused or air-gapped search option
|
||||
title: "SearXNG Search"
|
||||
title: "SearXNG search"
|
||||
---
|
||||
|
||||
OpenClaw supports [SearXNG](https://docs.searxng.org/) as a **self-hosted,
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "Skills config schema and examples"
|
||||
read_when:
|
||||
- Adding or modifying skills config
|
||||
- Adjusting bundled allowlist or install behavior
|
||||
title: "Skills Config"
|
||||
title: "Skills config"
|
||||
---
|
||||
|
||||
Most skills loader/install configuration lives under `skills` in
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "Slash commands: text vs native, config, and supported commands"
|
||||
read_when:
|
||||
- Using or configuring chat commands
|
||||
- Debugging command routing or permissions
|
||||
title: "Slash Commands"
|
||||
title: "Slash commands"
|
||||
---
|
||||
|
||||
Commands are handled by the Gateway. Most commands must be sent as a **standalone** message that starts with `/`.
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- You want background/parallel work via the agent
|
||||
- You are changing sessions_spawn or sub-agent tool policy
|
||||
- You are implementing or troubleshooting thread-bound subagent sessions
|
||||
title: "Sub-Agents"
|
||||
title: "Sub-agents"
|
||||
---
|
||||
|
||||
Sub-agents are background agent runs spawned from an existing agent run. They run in their own session (`agent:<agentId>:subagent:<uuid>`) and, when finished, **announce** their result back to the requester chat channel. Each sub-agent run is tracked as a [background task](/automation/tasks).
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
summary: "Directive syntax for /think, /fast, /verbose, /trace, and reasoning visibility"
|
||||
read_when:
|
||||
- Adjusting thinking, fast-mode, or verbose directive parsing or defaults
|
||||
title: "Thinking Levels"
|
||||
title: "Thinking levels"
|
||||
---
|
||||
|
||||
# Thinking Levels (/think directives)
|
||||
|
||||
@@ -5,7 +5,7 @@ read_when:
|
||||
- Exporting a support bundle for an OpenClaw session
|
||||
- Investigating prompt context, tool calls, runtime errors, or usage metadata
|
||||
- Disabling or relocating trajectory capture
|
||||
title: "Trajectory Bundles"
|
||||
title: "Trajectory bundles"
|
||||
---
|
||||
|
||||
Trajectory capture is OpenClaw's per-session flight recorder. It records a
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- Enabling text-to-speech for replies
|
||||
- Configuring TTS providers or limits
|
||||
- Using /tts commands
|
||||
title: "Text-to-Speech"
|
||||
title: "Text-to-speech"
|
||||
---
|
||||
|
||||
# Text-to-speech (TTS)
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- Generating videos via the agent
|
||||
- Configuring video generation providers and models
|
||||
- Understanding the video_generate tool parameters
|
||||
title: "Video Generation"
|
||||
title: "Video generation"
|
||||
---
|
||||
|
||||
OpenClaw agents can generate videos from text prompts, reference images, or existing videos. Fourteen provider backends are supported, each with different model options, input modes, and feature sets. The agent picks the right provider automatically based on your configuration and available API keys.
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- You want to fetch a URL and extract readable content
|
||||
- You need to configure web_fetch or its Firecrawl fallback
|
||||
- You want to understand web_fetch limits and caching
|
||||
title: "Web Fetch"
|
||||
title: "Web fetch"
|
||||
sidebarTitle: "Web Fetch"
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Web Search"
|
||||
title: "Web search"
|
||||
sidebarTitle: "Web Search"
|
||||
summary: "web_search, x_search, and web_fetch -- search the web, search X posts, or fetch page content"
|
||||
read_when:
|
||||
|
||||
Reference in New Issue
Block a user