# biel-search

Add Biel.ai's AI assistant and documentation search to your site. Help readers find relevant pages or get answers grounded in your documentation, with links to the sources.

`biel-search` provides the web components for Biel.ai's assistant and documentation search.

## Features

* **Ask AI** button component (`<biel-button>`) to open the documentation assistant for answers with source links.
* **Documentation search** widget (`<biel-search-button>`) to find matching pages in your indexed docs, with an **Ask AI** action that sends the current query to the assistant.
* Customizable labels, colors, and layout to match your site.
* **Connect** menu to connect indexed docs to Claude Code, Codex, and other MCP clients by copying an endpoint or setup command, or opening a supported client.
* **WebMCP** tools for compatible browser agents to search and read indexed docs or request AI answers, when enabled in your project's MCP settings.

## Quickstart

For detailed documentation, visit [Biel.ai docs](https://docs.biel.ai/).

## Support

For questions, issues, or feature requests, refer to our [support page](https://biel.ai/support).

## License

This software is released under the [MIT License](LICENSE).

Use of the hosted Biel.ai service is additionally governed by our
[Terms and conditions](https://biel.ai/terms).

## Development dependencies

Use the packageManager-pinned Yarn 4.7.0 with the committed yarn.lock and node-modules linker. Run `corepack yarn install --immutable`, then `corepack yarn build`. Yarn is the canonical dependency graph; package-lock.json was removed to prevent npm from installing a different graph. Install published widget packages with your application's package manager as usual.

Validated development runtime: Node 18.20.8, TypeScript 5.5.4, Jest 29.7.0, Stencil 4.45.2 and Puppeteer 24.43.1. Puppeteer 25 and Mermaid 12 require Node 22.12, so they need a separate compatibility change. See [dependency triage](docs/dependency-triage.md) for remaining advisories, bundled libraries and the next review date.

## Repository documentation

See [the documentation index](docs/README.md) for architecture, prop generation,
testing and dated dependency reviews. [AGENTS.md](AGENTS.md) defines the repository
workflow for ChatGPT and Codex.