Skip to content

The Open Standard for Generative UI

2.2 KB
Raw Blame

OpenUI cookbooks

Runnable examples for the Cookbooks docs. Read a cookbook for the walkthrough, then run or adapt its example here.

Cookbook Example Docs
Conversational analytics Next.js, OpenUI Gateway, and SQLite Explore Formula 1 lap times through conversation
Document comparison Next.js, OpenUI Gateway, OpenAI embeddings, and SQLite Compare annual reports with cited evidence
Booking assistant Next.js, OpenUI Gateway, and trivago's MCP server Book a stay with adaptive forms

Run an example

Open its directory and follow its README for prerequisites, data preparation, credentials, and development commands. Each example is standalone and uses published OpenUI packages.

Contribute a cookbook

  • Put the example in examples/cookbooks/<name>/ and its cookbook page in docs/content/docs/cookbooks/<name>.mdx.
  • Link the example's README to the cookbook page and the page to the example's source.
  • Register the example in examples/examples.json, this catalog, and the examples catalog.
  • Follow the example maintenance contract, including a credential-free verify command.
  • Update the example and its cookbook page in the same pull request.

Cookbooks use the existing examples:install, examples:verify, and examples:update scripts. The repository's example build and dependency-update workflows discover these examples automatically.