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. To install the CLI, see Install the CLI.

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.

lk docs <command> [options]

Subcommands:

overview: Get a complete overview of the documentation site and table of contents.
search [QUERY]: Search the documentation by keyword.
get-page PATH [PATH...]: Fetch one or more documentation pages as markdown.
code-search [QUERY]: Search code across LiveKit GitHub repositories.
changelog IDENTIFIER: Get recent releases and changelog entries for a LiveKit SDK or package.
list-sdks: List all LiveKit SDK repositories with their package names.
pricing-info: Get LiveKit Cloud pricing information.
submit-feedback [FEEDBACK]: Submit constructive feedback on the LiveKit documentation.

Options for docs:

--json (alias -j): Output as JSON instead of markdown.

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"

lk docs search [options] [QUERY]

Options for search:

--query QUERY (alias -q): Search QUERY text. Can also be passed as a positional argument.
--page PAGE (alias -p): PAGE number for pagination, starting at 0.
--hits-per-page N: Return N results per page (1-50). Default: 20.

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.

lk docs get-page PATH [PATH...]
# or
lk docs get-pages PATH [PATH...]

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

# 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

Note

Auto-generated SDK reference pages (such as /reference/client-sdk-js or /reference/python) are hosted externally and can't be fetched with this command.

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

lk docs code-search [options] [QUERY]

Options for code-search:

--query QUERY (alias -q): QUERY to search for. Use code identifiers, not natural language.
--repo REPO (alias -r): Target REPO (for example, livekit/agents) or ALL to search everywhere. Default: ALL.
--language LANGUAGE (alias -l): LANGUAGE filter (for example, Python, TypeScript).
--scope SCOPE: Search SCOPE: content, filename, or both. Default: content.
--limit N: Return at most N results (1-50). Default: 20.
--full-file: Return full file contents instead of snippets.

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

lk docs changelog [options] IDENTIFIER

Options for changelog:

--releases N: Fetch N releases (1-20). Default: 2.
--skip N: Skip N releases, for pagination.

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

pricing-info

Get LiveKit Cloud pricing information including plans, feature comparison matrix, inference model pricing, and calculator assumptions.

lk docs pricing-info

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"

lk docs submit-feedback [options] [FEEDBACK]

Options for submit-feedback:

--page PAGE: The docs PAGE the feedback is about (for example, /agents/build/tools).
--feedback TEXT (alias -f): Feedback TEXT (max 1024 characters). Can also be passed as a positional argument.
--agent AGENT: Identity of the AGENT submitting feedback (for example, "Cursor", "Claude Code").
--model ID: Model ID used by the agent (for example, "gpt-5", "claude-4.5-sonnet").

Typical workflow

A typical workflow for exploring the documentation:

Start with an overview of the docs site:
```
lk docs overview
```
Search for a topic:
```
lk docs search "voice agents"
```
Fetch a specific page to read the full content:
```
lk docs get-page /agents/start/voice-ai
```

Search for code examples across LiveKit repositories:

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