Skip to content

docs: Add missing flags for openui create in cli.mdx documentation #725

Description

@ChinmayMhatre

The CLI documentation page for openui create (docs/content/docs/api-reference/cli.mdx) is missing several important flags that were recently added to the main branch. Specifically, the -t, --template, --api-key, --auth, and --no-install flags are fully implemented in the CLI code and documented in packages/openui-cli/README.md, but they are missing from the official cli.mdx documentation page.

To Reproduce Steps to reproduce the behavior:

Go to the OpenUI CLI documentation page (docs/content/docs/api-reference/cli.mdx or the live site at /docs/api-reference/cli).

Scroll down to the "Options" table under the openui create section.
Notice that flags like -t, --template, --api-key, --auth, and --no-install are completely missing from the table.
Compare this against packages/openui-cli/README.md or by running npx @openuidev/cli@latest create --help in the terminal, where these flags are correctly documented and actively used.

Expected behavior: The cli.mdx documentation should remain perfectly in sync with the CLI's actual supported flags and the README.md file. The missing flags should be added to the Options table, the "What it does" section should mention template-specific .env behavior, and the example commands should demonstrate template-based scaffolding.

Additional context: This discrepancy has been resolved in the add-missing-cli-flags branch by syncing the missing flag documentation, the template-specific .env instructions, and the updated examples directly from packages/openui-cli/README.md over to docs/content/docs/api-reference/cli.mdx.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions