bird docs search
Usage
Code example
bird docs search <q> [flags]Description
Search the documentation by keyword and return ranked sections with deep links, page slugs, and matching snippets. Use bird docs read with a result's slug to fetch the full page. Set contents to highlights to include matching passages. This operation requires no authentication.
Examples
Code example
bird docs search <q>Options
| Name | Description |
|---|---|
| --contents | How much of each matching section to return. snippet (the default) returns a short preview; highlights additionally returns the passages that match the query. For the full text, fetch a result's markdown_url. Possible values: snippet, highlights. |
| --limit <n> | Maximum number of results to return (1–25). |
| --locale | Documentation locale to search, as a language-region code such as en-us. Defaults to en-us when omitted or unavailable. |
| --response-schema | Print the fields this command returns, then exit |
Related
| Name | Description |
|---|---|
| bird docs read | Get a documentation page |
Related resources
Continue with the documentation, guides and examples for this topic. Resources are in English.
Watch the guideSetting up your coding agentUnderstand the conceptWhat is an MCP server, and how does an agent use one to send messages?Explore the capabilityCoding agentsFollow the learning pathBuild with AI agents
Get an implementation brief