Docs Search

Use vsdk docs to search VideoSDK documentation and read documentation pages as Markdown directly from your terminal.

Find supported SDKs

Before searching the documentation, list the SDKs supported by the CLI:

vsdk docs sdks

Use an SDK name from this list when running a documentation search.

Search the documentation

Use vsdk docs search to find documentation relevant to your question.

Provide your question and the SDK you want to search. For example, the following command searches the React documentation for information about starting HLS:

vsdk docs search "start HLS" --sdk react

If you leave out --sdk in a terminal, the CLI asks which SDK to search. Without a terminal it cannot ask, so the command exits with code 1.

Example output

1  Start HLS
   https://docs.videosdk.live/react/guide/interactive-live-streaming/integrate-hls/start-hls
   Using VideoSDK to do the interactive livestreaming.

Additional results and help text may also be displayed.

Search options

Use the following options to refine your search or open the first result in your browser:

Option	Short	Description
--sdk <sdk>	-s	SDK to search, such as react, flutter, or android.
--version <version>	—	Search a specific SDK version, exact or as a range such as 3.x.
--limit <count>	-n	Number of results to display.
--open	—	Open the first search result in your browser.

For example, search the React documentation and open the first result:

vsdk docs search "start HLS" --sdk react --open

To search an older version of an SDK, pass --version. The following command searches the Flutter 3.x documentation:

vsdk docs search "join meeting" --sdk flutter --version 3.x

If the SDK has no such version, the CLI lists the versions that are available.

Read a documentation page

Use vsdk docs get to read a documentation page as Markdown, including its code examples.

Copy the URL from a search result and pass it to the command:

vsdk docs get "https://docs.videosdk.live/react/guide/interactive-live-streaming/integrate-hls/start-hls"

Example Markdown output

The output includes the documentation page and its code examples. The … indicates omitted content.

Source: https://docs.videosdk.live/react/guide/interactive-live-streaming/integrate-hls/start-hls (version 1.x.x)

…

## Starting HLS

…

```js
const config = {
  // Layout Configuration
  layout: {
    type: "GRID", // "SPOTLIGHT" | "SIDEBAR", Default: "GRID"
    priority: "SPEAKER", // "PIN", Default: "SPEAKER"
    gridSize: 4, // MAX: 25
  },
…
```

Read by page path

You can also provide the documentation page path without the domain:

vsdk docs get /react/guide/interactive-live-streaming/integrate-hls/start-hls

Read a specific section

To read a specific section of a documentation page, append the section's heading fragment to the page path or URL.

If the path or URL contains #, wrap it in quotes so your shell handles the fragment correctly:

vsdk docs get "/react/guide/interactive-live-streaming/integrate-hls/start-hls#starting-hls"

Use with coding agents

You can instruct AI coding agents to search the VideoSDK documentation before writing or modifying VideoSDK code.

Add the following instructions to your AGENTS.md or CLAUDE.md file:

## VideoSDK

Before writing or changing VideoSDK code:

1. Search the documentation:
   `vsdk docs search "<question>" --sdk <sdk> --json`

2. Read the most relevant result:
   `vsdk docs get "<url>"`

Use `--version <version>`, for example `--version 3.x`, when the project uses an older SDK version.

Replace <question>, <sdk>, and <url> with the relevant values for your project.

tip

Use --json with documentation searches when integrating the CLI with coding agents or scripts. It returns structured search results that are easier to process programmatically.

The documentation commands also accept the options shared by every command, such as --json, --quiet and --help. See Global options.

Errors

When using --json, successful results are returned as a single JSON object on stdout. Errors are returned as a single JSON object on stderr and include the corresponding exit code. For what each code means, see Errors and exit codes.

JSON error example

The following example shows an error returned when an SDK name is not provided:

{
  "error": {
    "name": "CliError",
    "message": "Which SDK? Pass --sdk",
    "code": 1,
    "hint": "One of: react, javascript, react-native, flutter, android, ios, python, server, api, prebuilt, telephony, unity, cpp, iot"
  }
}

For the documentation commands, a search that finds nothing is not an error and exits 0. If the documentation server cannot be reached, the command exits with code 2.

Send documentation feedback

Use vsdk docs feedback to report missing, incorrect, or broken documentation results.

vsdk docs feedback "The Flutter HLS guide is missing the stop step"

For feedback about a specific search, include the original query with --about and the SDK with --sdk:

vsdk docs feedback "Search returned React pages" \
  --about "start HLS" \
  --sdk flutter \
  --bug

Use --bug when reporting something that is broken rather than suggesting an improvement.

Feedback options

Option	Description
--about <query>	Search query to use when reproducing the issue.
--sdk <sdk>	SDK used for the search.
--rating <rating>	Rate the result as excellent, good, average, poor, or bad. Prompts in a terminal and defaults to average otherwise.
--bug	Mark the feedback as a bug report rather than a suggestion.

Get help

To view the available documentation commands:

vsdk docs --help

To view the options for one of them, such as search:

vsdk docs search --help