bird docs search
Usage
代码示例
bird docs search [flags]Description
Search the Bird documentation by keyword and get the most relevant sections, each with a deep link and the page's slug. Use this to answer how-to and reference questions about Bird (email sending, sending domains, dedicated IPs, the API, SDKs, the CLI, and the MCP server) instead of guessing. Snippets are previews, not answers: to answer, read the whole page with docs_read on the slug of the one or two results you pick (highlights returns the matching passages if you only need to confirm relevance first). Do not try to read every result in full. If you can spawn a subagent, delegate the read: give it the question plus the slug and have it return only the answer and the source URL, so your own context stays focused. Public; no authentication required.
Examples
代码示例
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. |
| --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 | Read a documentation page |