docs: add @openuidev/cli API reference - #348
Merged
Aditya-thesys merged 3 commits intoMar 22, 2026
Merged
Conversation
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
AbhinRustagi
force-pushed
the
docs/cli-api-reference
branch
from
March 17, 2026 08:51
731efb7 to
19e6dd9
Compare
Aditya-thesys
approved these changes
Mar 17, 2026
Aditya-thesys
left a comment
Contributor
There was a problem hiding this comment.
LG @AbhinRustagi , thanks! for updating the docs
abhithesys
approved these changes
Mar 17, 2026
abhithesys
left a comment
Contributor
There was a problem hiding this comment.
Thanks for adding the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds API reference documentation for
@openuidev/clito the docs site.The CLI currently has no dedicated reference page, leaving users without a single source of truth for available commands, flags, and options. This PR fills that gap and also establishes a foundation for the page to grow as the CLI expands — for example, to support scaffolding for frameworks beyond Next.js (Svelte, Vue, etc.).
Changes:
docs/content/docs/api-reference/cli.mdx— full API reference for@openuidev/clicoveringopenui create,openui generate, export auto-detection logic, thePromptOptionstype, and a "See also" sectionapi-reference/index.mdxto list@openuidev/cliin the package overview and Cards gridapi-reference/meta.jsonto includecliin the sidebar navTest plan
cd docs && pnpm dev— dev server starts without errors/docs/api-reference/clirenders with all sections🤖 Generated with Claude Code