Docs search

Overview

The lk docs command provides full access to the LiveKit documentation directly from your terminal. It's powered by the LiveKit Docs MCP server and supports browsing, searching, fetching pages, code search, and changelog access.

All commands output markdown by default. Use the --json flag on any command for structured JSON output.

Output modes

Every lk docs command supports two output modes:

• Markdown (default) — Human-readable output optimized for terminal display and coding agents. More concise and token-efficient.
• JSON (--json) — Structured output for programmatic use, scripting, and integration with other tools.

# Markdown (default)
lk docs search "voice agents"

# JSON
lk docs search "voice agents" --json

JSON mode is useful when you need to parse results in a script or pipe structured data to another program. The default markdown mode is recommended for interactive use and coding agents, as it's more concise and consumes fewer tokens.

Commands

The lk docs subcommand includes the following commands.

overview

Get a complete overview of the documentation site with a full table of contents and page descriptions. This is a good starting point for browsing the docs.

lk docs overview

search

Search the documentation by keyword. Returns page titles, hierarchical placement, and content snippets. Use lk docs get-page to fetch the full content of any result.

lk docs search "voice agents"

Search should be used alongside lk docs overview for browsing, not as a replacement. The search index covers a large amount of content, so combine search with direct page fetching for best results.

get-page

Fetch one or more documentation pages and render them as markdown. Accepts relative paths from the docs site or GitHub URLs from public LiveKit repositories.

# Fetch a single page
lk docs get-page /agents/start/voice-ai-quickstart

# Fetch multiple pages
lk docs get-page /agents/build/tools /agents/build/vision

# Fetch from a GitHub URL
lk docs get-page https://github.com/livekit/agents/blob/main/README.md

code-search

Search code across public LiveKit GitHub repositories. Use code identifiers like class names, function names, and method calls rather than natural language descriptions.

# Search across all repos
lk docs code-search "class AgentSession"

# Search a specific repo
lk docs code-search "def on_enter" --repo livekit/agents

# Filter by language and get full file contents
lk docs code-search "@function_tool" --language Python --full-file

changelog

Get recent releases and changelog entries for a LiveKit SDK or package.

# By repository ID
lk docs changelog livekit/agents

# By package identifier
lk docs changelog pypi:livekit-agents

# Fetch more releases
lk docs changelog npm:@livekit/components-react --releases 5

list-sdks

List all LiveKit SDK repositories with their package names. Useful for cross-referencing dependencies and finding the right SDK.

lk docs list-sdks

submit-feedback

Submit constructive feedback on the LiveKit documentation. Do not include any personal or proprietary information.

# General feedback
lk docs submit-feedback "The voice agents quickstart needs a Node.js example"

# Feedback for a specific page
lk docs submit-feedback --page /agents/build/tools "Missing info about error handling"

Typical workflow

A typical workflow for exploring the documentation:

1. Start with an overview of the docs site:

   lk docs overview

2. Search for a topic:

   lk docs search "voice agents"

3. Fetch a specific page to read the full content:

   lk docs get-page /agents/start/voice-ai-quickstart

4. Search for code examples across LiveKit repositories:

   lk docs code-search "class AgentSession" --repo livekit/agents