@@ -461,6 +461,50 @@ The above simulates 5 concurrent rooms, where each room has:
461461Once the specified duration is over (or if the load test is manually stopped), the load test statistics will be displayed in the form of a table.
462462
463463
464+ ## Browsing documentation
465+
466+ The CLI includes a built-in `lk docs` command that lets you search and browse the LiveKit documentation directly from the terminal. It' s powered by the [LiveKit docs MCP server](https://docs.livekit.io/mcp) using the official [MCP Go SDK](https://github.com/modelcontextprotocol/go-sdk).
467+
468+ ` ` ` shell
469+ # Get a complete overview of the docs site
470+ lk docs overview
471+
472+ # Search the docs
473+ lk docs search " voice agents"
474+
475+ # Fetch a specific page as markdown
476+ lk docs get-page /agents/start/voice-ai-quickstart
477+
478+ # Search code across LiveKit GitHub repos
479+ lk docs code-search " class AgentSession" --repo livekit/agents
480+
481+ # Get recent releases for an SDK
482+ lk docs changelog pypi:livekit-agents
483+
484+ # List all LiveKit SDKs
485+ lk docs list-sdks
486+
487+ # Submit feedback on the docs
488+ lk docs submit-feedback --page /agents/build/tools " Missing info about error handling"
489+ ` ` `
490+
491+ Run ` lk docs --help` for full details on each subcommand.
492+
493+ # ## Development options
494+
495+ For development against staging or preview deployments of the docs MCP server, two hidden flags are available on the ` lk docs` command:
496+
497+ - ` --server-url URL` : Override the MCP server endpoint (default: ` https://docs.livekit.io/mcp/` )
498+ - ` --vercel-header VALUE` : Set the ` x-vercel-protection-bypass` header, required for accessing private Vercel preview deployments
499+
500+ ` ` ` shell
501+ # Use a staging server
502+ lk docs --server-url https://docs-staging.example.com/mcp/ search " agents"
503+
504+ # Access a private Vercel preview deploy
505+ lk docs --server-url https://docs-abc123.vercel.app/mcp/ --vercel-header < token> overview
506+ ` ` `
507+
464508# # Additional notes
465509
466510# ## Parameter precedence
@@ -514,12 +558,14 @@ valid | livekit-cli | server-sdk-go | server constraint | explanation
514558< br/><table>
515559< thead><tr><th colspan=" 2" > LiveKit Ecosystem< /th></tr></thead>
516560< tbody>
517- <tr><td>LiveKit SDKs</td><td><a href="https://github.com/livekit/client-sdk-js">Browser</a> · <a href="https://github.com/livekit/client-sdk-swift">iOS/macOS/visionOS</a> · <a href="https://github.com/livekit/client-sdk-android">Android</a> · <a href="https://github.com/livekit/client-sdk-flutter">Flutter</a> · <a href="https://github.com/livekit/client-sdk-react-native">React Native</a> · <a href="https://github.com/livekit/rust-sdks">Rust</a> · <a href="https://github.com/livekit/node-sdks">Node.js</a> · <a href="https://github.com/livekit/python-sdks">Python</a> · <a href="https://github.com/livekit/client-sdk-unity">Unity</a> · <a href="https://github.com/livekit/client-sdk-unity-web">Unity (WebGL)</a> · <a href="https://github.com/livekit/client-sdk-esp32">ESP32</a></td></tr><tr></tr>
518- <tr><td>Server APIs</td><td><a href="https://github.com/livekit/node-sdks">Node.js</a> · <a href="https://github.com/livekit/server-sdk-go">Golang</a> · <a href="https://github.com/livekit/server-sdk-ruby">Ruby</a> · <a href="https://github.com/livekit/server-sdk-kotlin">Java/Kotlin</a> · <a href="https://github.com/livekit/python-sdks">Python</a> · <a href="https://github.com/livekit/rust-sdks">Rust</a> · <a href="https://github.com/agence104/livekit-server-sdk-php">PHP (community)</a> · <a href="https://github.com/pabloFuente/livekit-server-sdk-dotnet">.NET (community)</a></td></tr><tr></tr>
561+ < tr><td> Agents SDKs< /td><td><a href=" https://github.com/livekit/agents" > Python< /a> · < a href=" https://github.com/livekit/agents-js" > Node.js< /a></td></tr><tr></tr>
562+ < tr><td> LiveKit SDKs< /td><td><a href=" https://github.com/livekit/client-sdk-js" > Browser< /a> · < a href=" https://github.com/livekit/client-sdk-swift" > Swift< /a> · < a href=" https://github.com/livekit/client-sdk-android" > Android< /a> · < a href=" https://github.com/livekit/client-sdk-flutter" > Flutter< /a> · < a href=" https://github.com/livekit/client-sdk-react-native" > React Native< /a> · < a href=" https://github.com/livekit/rust-sdks" > Rust< /a> · < a href=" https://github.com/livekit/node-sdks" > Node.js< /a> · < a href=" https://github.com/livekit/python-sdks" > Python< /a> · < a href=" https://github.com/livekit/client-sdk-unity" > Unity< /a> · < a href=" https://github.com/livekit/client-sdk-unity-web" > Unity (WebGL)< /a> · < a href=" https://github.com/livekit/client-sdk-esp32" > ESP32< /a> · < a href=" https://github.com/livekit/client-sdk-cpp" > C++< /a></td></tr><tr></tr>
563+ < tr><td> Starter Apps< /td><td><a href=" https://github.com/livekit-examples/agent-starter-python" > Python Agent< /a> · < a href=" https://github.com/livekit-examples/agent-starter-node" > TypeScript Agent< /a> · < a href=" https://github.com/livekit-examples/agent-starter-react" > React App< /a> · < a href=" https://github.com/livekit-examples/agent-starter-swift" > SwiftUI App< /a> · < a href=" https://github.com/livekit-examples/agent-starter-android" > Android App< /a> · < a href=" https://github.com/livekit-examples/agent-starter-flutter" > Flutter App< /a> · < a href=" https://github.com/livekit-examples/agent-starter-react-native" > React Native App< /a> · < a href=" https://github.com/livekit-examples/agent-starter-embed" > Web Embed< /a></td></tr><tr></tr>
519564< tr><td> UI Components< /td><td><a href=" https://github.com/livekit/components-js" > React< /a> · < a href=" https://github.com/livekit/components-android" > Android Compose< /a> · < a href=" https://github.com/livekit/components-swift" > SwiftUI< /a> · < a href=" https://github.com/livekit/components-flutter" > Flutter< /a></td></tr><tr></tr>
520- <tr><td>Agents Frameworks</td><td><a href="https://github.com/livekit/agents">Python</a> · <a href="https://github.com/livekit/agents-js">Node.js</a> · <a href="https://github.com/livekit/agent-playground">Playground</a></td></tr><tr></tr>
521- <tr><td>Services</td><td><a href="https://github.com/livekit/livekit">LiveKit server</a> · <a href="https://github.com/livekit/egress">Egress</a> · <a href="https://github.com/livekit/ingress">Ingress</a> · <a href="https://github.com/livekit/sip">SIP</a></td></tr><tr></tr>
522- <tr><td>Resources</td><td><a href="https://docs.livekit.io">Docs</a> · <a href="https://github.com/livekit-examples">Example apps</a> · <a href="https://livekit.io/cloud">Cloud</a> · <a href="https://docs.livekit.io/home/self-hosting/deployment">Self-hosting</a> · <b>CLI</b></td></tr>
565+ < tr><td> Server APIs< /td><td><a href=" https://github.com/livekit/node-sdks" > Node.js< /a> · < a href=" https://github.com/livekit/server-sdk-go" > Golang< /a> · < a href=" https://github.com/livekit/server-sdk-ruby" > Ruby< /a> · < a href=" https://github.com/livekit/server-sdk-kotlin" > Java/Kotlin< /a> · < a href=" https://github.com/livekit/python-sdks" > Python< /a> · < a href=" https://github.com/livekit/rust-sdks" > Rust< /a> · < a href=" https://github.com/agence104/livekit-server-sdk-php" > PHP (community)< /a> · < a href=" https://github.com/pabloFuente/livekit-server-sdk-dotnet" > .NET (community)< /a></td></tr><tr></tr>
566+ < tr><td> Resources< /td><td><a href=" https://docs.livekit.io" > Docs< /a> · < a href=" https://docs.livekit.io/mcp" > Docs MCP Server< /a> · < b> CLI< /b> · < a href=" https://cloud.livekit.io" > LiveKit Cloud< /a></td></tr><tr></tr>
567+ < tr><td> LiveKit Server OSS< /td><td><a href=" https://github.com/livekit/livekit" > LiveKit server< /a> · < a href=" https://github.com/livekit/egress" > Egress< /a> · < a href=" https://github.com/livekit/ingress" > Ingress< /a> · < a href=" https://github.com/livekit/sip" > SIP< /a></td></tr><tr></tr>
568+ < tr><td> Community< /td><td><a href=" https://community.livekit.io" > Developer Community< /a> · < a href=" https://livekit.io/join-slack" > Slack< /a> · < a href=" https://x.com/livekit" > X< /a> · < a href=" https://www.youtube.com/@livekit_io" > YouTube< /a></td></tr>
523569< /tbody>
524570< /table>
525571< ! --END_REPO_NAV-->
0 commit comments