Skip to content

docs: add missing flags to cli reference#726

Merged
vishxrad merged 2 commits into
thesysdev:mainfrom
ChinmayMhatre:add-missing-cli-flags
Jul 9, 2026
Merged

docs: add missing flags to cli reference#726
vishxrad merged 2 commits into
thesysdev:mainfrom
ChinmayMhatre:add-missing-cli-flags

Conversation

@ChinmayMhatre

Copy link
Copy Markdown
Contributor

What

This PR syncs the openui create documentation in cli.mdx with the actual flags supported by the CLI (which are already fully implemented and documented in packages/openui-cli/README.md). Several newer flags regarding template selection, OpenUI Cloud authentication, and installation behavior were missing from the official website documentation.

Changes

  • Added missing -t, --template, --api-key, --auth, and --no-install flags to the cli.mdx Options table.
  • Expanded the "What it does" section to clarify how the CLI handles template selection.
  • Added a "Template-specific .env" section detailing the differences between the openui-chat and openui-cloud setups.
  • Updated the example commands to demonstrate scaffolding with specific templates and authentication methods.

Test Plan

Verified that the markdown formatting renders correctly and strictly mirrors the existing, accurate README.md documentation.

  • Not applicable (explain why)
  • Verified locally

Checklist

  • I linked a related issue, if applicable
  • I updated docs/README when needed
  • I considered backwards compatibility

@ChinmayMhatre ChinmayMhatre force-pushed the add-missing-cli-flags branch from 264fe3c to dff2d7a Compare July 7, 2026 08:40
@ChinmayMhatre

Copy link
Copy Markdown
Contributor Author

Resolves #725

vishxrad
vishxrad previously approved these changes Jul 9, 2026

@vishxrad vishxrad 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.

Good catch! Thanks for this pr.

@vishxrad vishxrad merged commit 24db326 into thesysdev:main Jul 9, 2026
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.

2 participants