Skip to content

docs: add @openuidev/cli API reference - #348

Merged
Aditya-thesys merged 3 commits into
thesysdev:mainfrom
AbhinRustagi:docs/cli-api-reference
Mar 22, 2026
Merged

docs: add @openuidev/cli API reference#348
Aditya-thesys merged 3 commits into
thesysdev:mainfrom
AbhinRustagi:docs/cli-api-reference

Conversation

@AbhinRustagi

@AbhinRustagi AbhinRustagi commented Mar 17, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds API reference documentation for @openuidev/cli to 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:

  • Adds docs/content/docs/api-reference/cli.mdx — full API reference for @openuidev/cli covering openui create, openui generate, export auto-detection logic, the PromptOptions type, and a "See also" section
  • Updates api-reference/index.mdx to list @openuidev/cli in the package overview and Cards grid
  • Updates api-reference/meta.json to include cli in the sidebar nav

Test plan

  • cd docs && pnpm dev — dev server starts without errors
  • /docs/api-reference/cli renders with all sections
  • Sidebar shows "CLI" under API Reference
  • Cards on the API Reference index link to the CLI page correctly

🤖 Generated with Claude Code

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

@Aditya-thesys Aditya-thesys left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LG @AbhinRustagi , thanks! for updating the docs

@abhithesys abhithesys left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding the docs.

@Aditya-thesys Aditya-thesys self-assigned this Mar 20, 2026
@Aditya-thesys
Aditya-thesys merged commit a498d6c into thesysdev:main Mar 22, 2026
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants