fix: update docs

Author: AbhinRustagi

docs/content/docs/api-reference/cli.mdx

@@ -58,7 +58,7 @@ openui create [options]
 | `-n, --name <string>`             | Project name (interactive default: `openui-agent`)                            |
 | `-t, --template <template>`       | AI backend: `openui-cloud` (recommended) or `openui-self-hosted`              |
 | `--backend-framework <framework>` | Backend integration: `default`, `langgraph`, `vercel-ai-sdk`, or `vercel-eve` |
-| `-e, --example <example>`         | Scaffold a featured example instead of a starter template                     |
+| `-e, --example <example>`         | Scaffold any example from the OpenUI Repository    |
 | `--api-key <key>`                 | OpenUI Cloud API key; skips sign-in for the Cloud setup                       |
 | `--auth <method>`                 | Cloud auth method: `oauth` or `skip`; `manual` is deprecated                  |
 | `--skill`                         | Install the OpenUI agent skill for AI coding assistants                       |
@@ -69,7 +69,7 @@ openui create [options]
 | `--no-interactive`                | Fail instead of prompting for missing input                                   |
 | `--agent-name <name>`             | Declare the invoking coding-agent slug (default: `unknown`)                   |
 
-When run interactively (default), the CLI prompts for any missing options, including a starter template or featured example, then asks whether to start the development server after installing dependencies with the detected package manager. The start prompt defaults to yes; answering no preserves the existing install-and-exit behavior and prints the `cd` and dev commands. For most prototypes and evaluations, start with **OpenUI Cloud, the recommended default**: hosted models, managed conversation history and streaming, built-in tools, and ready-to-use reports and presentations without operating the model, storage, or artifact infrastructure. Choose **self-hosted** when owning the OpenAI-compatible provider, AI route, and persistence is a requirement. Choose a **feature example** when you want a FastAPI, shadcn/ui, React Native, Mastra, or other integration listed in `examples/examples.json`.
+When run interactively (default), the CLI prompts for any missing options, including a starter template or featured example, then asks whether to start the development server after installing dependencies with the detected package manager. The start prompt defaults to yes; answering no preserves the existing install-and-exit behavior and prints the `cd` and dev commands. For most prototypes and evaluations, start with **OpenUI Cloud, the recommended default**: hosted models, managed conversation history and streaming, built-in tools, and ready-to-use reports and presentations without operating the model, storage, or artifact infrastructure. Choose **self-hosted** when owning the OpenAI-compatible provider, AI route, and persistence is a requirement.
 
 In non-interactive mode, dependencies are installed without starting the long-running development server. Pass `--immediate` to install, start, and open the app, or `--no-install` to scaffold only.
 
@@ -100,9 +100,9 @@ For Cloud LangGraph and Vercel AI SDK variants, the framework owns orchestration
 
 Every framework overlay includes a `get_weather` example backed by Open-Meteo. Ask “What’s the weather in Berlin?” to verify the selected framework’s native multi-step tool loop.
 
-**Feature examples**
+**Examples**
 
-Interactive `openui create` lists starter templates and featured examples in one prompt. The featured list is prefetched at runtime from [`examples/examples.json`](https://github.com/thesysdev/openui/blob/main/examples/examples.json) — edit that file to change what the CLI offers. `--example` cannot be combined with `--template` or `--backend-framework`. Examples are copied from a local OpenUI checkout when available, otherwise checked out from GitHub. Workspace and catalog dependencies are rewritten to `latest`.
+Interactive `openui create` lists starter templates and featured examples in one prompt. `--example` cannot be combined with `--template` or `--backend-framework`.
 
 | Value          | Demonstrates                                                   |
 | -------------- | -------------------------------------------------------------- |
@@ -142,9 +142,10 @@ pnpx @openuidev/cli@latest create --name my-app --template openui-self-hosted --
 pnpx @openuidev/cli@latest create --name my-app --template openui-self-hosted --backend-framework vercel-ai-sdk
 pnpx @openuidev/cli@latest create --name my-app --template openui-self-hosted --backend-framework vercel-eve
 
-# Select a featured example
+# Select an example
 pnpx @openuidev/cli@latest create --name my-app --example shadcn
 pnpx @openuidev/cli@latest create --name my-app --example mastra
+pnpx @openuidev/cli@latest create --name my-app --example vue
 
 # Non-interactive
 pnpx @openuidev/cli@latest create --no-interactive --name my-app --template openui-cloud --auth skip
@@ -170,9 +171,10 @@ bunx @openuidev/cli@latest create --name my-app --template openui-self-hosted --
 bunx @openuidev/cli@latest create --name my-app --template openui-self-hosted --backend-framework vercel-ai-sdk
 bunx @openuidev/cli@latest create --name my-app --template openui-self-hosted --backend-framework vercel-eve
 
-# Select a featured example
+# Select an example
 bunx @openuidev/cli@latest create --name my-app --example shadcn
 bunx @openuidev/cli@latest create --name my-app --example mastra
+bunx @openuidev/cli@latest create --name my-app --example vue
 
 # Non-interactive
 bunx @openuidev/cli@latest create --no-interactive --name my-app --template openui-cloud --auth skip
@@ -198,9 +200,10 @@ yarn dlx @openuidev/cli@latest create --name my-app --template openui-self-hoste
 yarn dlx @openuidev/cli@latest create --name my-app --template openui-self-hosted --backend-framework vercel-ai-sdk
 yarn dlx @openuidev/cli@latest create --name my-app --template openui-self-hosted --backend-framework vercel-eve
 
-# Select a featured example
+# Select an example
 yarn dlx @openuidev/cli@latest create --name my-app --example shadcn
 yarn dlx @openuidev/cli@latest create --name my-app --example mastra
+yarn dlx @openuidev/cli@latest create --name my-app --example vue
 
 # Non-interactive
 yarn dlx @openuidev/cli@latest create --no-interactive --name my-app --template openui-cloud --auth skip
@@ -226,9 +229,10 @@ npx @openuidev/cli@latest create --name my-app --template openui-self-hosted --b
 npx @openuidev/cli@latest create --name my-app --template openui-self-hosted --backend-framework vercel-ai-sdk
 npx @openuidev/cli@latest create --name my-app --template openui-self-hosted --backend-framework vercel-eve
 
-# Select a featured example
+# Select an example
 npx @openuidev/cli@latest create --name my-app --example shadcn
 npx @openuidev/cli@latest create --name my-app --example mastra
+npx @openuidev/cli@latest create --name my-app --example vue
 
 # Non-interactive
 npx @openuidev/cli@latest create --no-interactive --name my-app --template openui-cloud --auth skip

packages/openui-cli/README.md

@@ -13,7 +13,7 @@ It currently supports two workflows:
   - **OpenUI Cloud (recommended)** — hosted models with managed conversations, streaming, built-in tools, and ready-to-use report and presentation artifacts
   - **Self-hosted** — bring an OpenAI-compatible model key and own the AI route and persistence
 - keeping the default minimal SDK route or adding a LangGraph, Vercel AI SDK, or Vercel Eve backend to either template
-- scaffolding a featured example listed in [`examples/examples.json`](https://github.com/thesysdev/openui/blob/main/examples/examples.json)
+- scaffolding an example from [`examples/examples.json`](https://github.com/thesysdev/openui/blob/main/examples/examples.json)
 - generating a system prompt or JSON Schema from a `createLibrary()` export
 
 ## Install
@@ -81,7 +81,7 @@ Options:
 - `-n, --name <string>`: Project name (interactive default: `openui-agent`)
 - `-t, --template <template>`: AI backend `key` from `templates/templates.json` — interactive default `openui-cloud`
 - `--backend-framework <framework>`: Overlay `key` from that template's `overlays` list (plus `default` for the base template)
-- `-e, --example <example>`: Scaffold a featured example from `examples/examples.json` instead of a starter template
+- `-e, --example <example>`: Scaffold any example from `examples/examples.json` (folder name)
 - `--skill`: Install the OpenUI agent skill for AI coding assistants
 - `--no-skill`: Skip installing the OpenUI agent skill
 - `--no-install`: Scaffold without running the package install
@@ -133,13 +133,14 @@ Every framework overlay includes `get_weather` as its example app-owned function
 
 #### Feature examples
 
-Interactive `openui create` lists **Feature Examples** under the starter templates. The names come from [`examples/examples.json`](https://github.com/thesysdev/openui/blob/main/examples/examples.json) in the OpenUI repo — the CLI prefetches that catalog at runtime, so adding or removing an example does not require a CLI release. Pick one in the prompt, or pass `--example <name>`. `--example` cannot be combined with `--template` or `--backend-framework`.
+Interactive `openui create` lists **Feature Examples** under the starter templates. The names come from [`examples/examples.json`](https://github.com/thesysdev/openui/blob/main/examples/examples.json) in the OpenUI repo — the CLI prefetches that catalog at runtime, so adding or removing an example does not require a CLI release. `--example` cannot be combined with `--template` or `--backend-framework`.
 
 The catalog currently features FastAPI, shadcn/ui, React Native, and Mastra. Examples are copied from the local OpenUI checkout when the CLI can see `examples/`, otherwise checked out from GitHub with sparse-checkout. Workspace and catalog dependencies are rewritten to `latest`, and monorepo `generate` scripts are rewritten to `npx @openuidev/cli generate`.
 
 ```bash
 openui create --example shadcn
 openui create --name my-mastra-app --example mastra --no-immediate
+openui create --example vue
 ```
 
 #### Conversation storage

packages/openui-cli/src/commands/create-app.ts

@@ -16,7 +16,7 @@ import {
   type PackageManagerName,
 } from "../lib/detect-package-manager";
 import { runDevCommand } from "../lib/dev-server";
-import { loadFeaturedExamples, requireFeaturedExamples } from "../lib/featured-examples";
+import { loadExamplesCatalog, requireExamplesCatalog } from "../lib/featured-examples";
 import { runSkillInstall, shouldInstallSkill } from "../lib/install-skill";
 import {
   applyOverlay,
@@ -201,18 +201,18 @@ export async function runCreateApp(options: CreateAppOptions): Promise<void> {
     );
   }
 
-  const [catalog, featuredExamples] = await Promise.all([
+  const [catalog, examples] = await Promise.all([
     loadTemplatesCatalog(),
-    loadFeaturedExamples(),
+    loadExamplesCatalog(),
   ]);
-  requireFeaturedExamples(featuredExamples, options.example);
+  requireExamplesCatalog(examples, options.example);
 
   const template: TemplateName | undefined = options.example
     ? undefined
     : (options.template ?? DEFAULT_TEMPLATE_KEY);
   const templateEntry = template ? findCatalogTemplate(catalog, template) : undefined;
   if (options.example) {
-    findExample(options.example, featuredExamples);
+    findExample(options.example, examples);
   } else if (options.backendFramework && templateEntry) {
     findCatalogOverlay(templateEntry, options.backendFramework);
   }
@@ -236,7 +236,7 @@ export async function runCreateApp(options: CreateAppOptions): Promise<void> {
   const project = await resolveProject({
     backendFramework: options.backendFramework,
     example: options.example,
-    examples: featuredExamples,
+    examples,
     templates: templatesFromOverlays(
       (templateEntry?.overlays ?? []).map((overlay) => ({
         name: overlay.key,

packages/openui-cli/src/index.ts

@@ -65,7 +65,10 @@ program
     "--backend-framework <framework>",
     "Backend framework: default | langgraph | vercel-ai-sdk | vercel-eve",
   )
-  .option("-e, --example <example>", "create from a featured example (see examples/examples.json)")
+  .option(
+    "-e, --example <example>",
+    "create from an example in examples/examples.json (interactive picker shows featured ones)",
+  )
   .option("--api-key <key>", "OpenUI Cloud API key (cloud template; skips sign-in)")
   .option("--auth <method>", "Cloud auth method: oauth | skip (manual is deprecated)")
   .option("--skill", "Install the OpenUI agent skill for AI coding assistants")
@@ -97,7 +100,8 @@ Backend frameworks:
 
 Feature examples:
   Loaded at runtime from examples/examples.json in the OpenUI repo.
-  Use --example <name>, or pick one interactively from Feature Examples.
+  The interactive picker lists featured examples. --example <name> accepts any
+  catalog name (folder name), including ones not shown in the picker.
 `,
   )
   .action(

packages/openui-cli/src/lib/checkout.ts

@@ -10,7 +10,7 @@ const FETCH_TIMEOUT_MS = 30_000;
 
 const SOURCE_OWNER = "thesysdev";
 const SOURCE_REPO = "openui";
-const SOURCE_REF = "main";
+const SOURCE_REF = "feat/cli-featured-examples";
 const SOURCE_GIT_URL = `https://github.com/${SOURCE_OWNER}/${SOURCE_REPO}.git`;
 
 export type SourceFetchOptions = {

packages/openui-cli/src/lib/featured-examples.ts

@@ -11,8 +11,7 @@ type CatalogExample = {
   featured?: unknown;
 };
 
-function parseFeaturedEntry(item: CatalogExample): ExampleProject | undefined {
-  if (item.featured !== true) return undefined;
+function parseCatalogEntry(item: CatalogExample): ExampleProject | undefined {
   if (
     typeof item.title !== "string" ||
     typeof item.description !== "string" ||
@@ -30,40 +29,41 @@ function parseFeaturedEntry(item: CatalogExample): ExampleProject | undefined {
     category: "example",
     path: relative.startsWith("examples/") ? relative : `examples/${relative}`,
     envFile: ".env",
+    featured: item.featured === true,
   };
 }
 
-function parseFeaturedExamples(raw: string): ExampleProject[] {
+function parseExamplesCatalog(raw: string): ExampleProject[] {
   const parsed = JSON.parse(raw) as { examples?: unknown };
   if (!Array.isArray(parsed.examples)) {
     throw new Error(`${EXAMPLES_CATALOG_PATH} must contain an "examples" array.`);
   }
   return parsed.examples
-    .map((entry) => parseFeaturedEntry(entry as CatalogExample))
+    .map((entry) => parseCatalogEntry(entry as CatalogExample))
     .filter((entry): entry is ExampleProject => Boolean(entry));
 }
 
-/** Prefetch featured examples (`featured: true`) from GitHub. */
-export async function loadFeaturedExamples(): Promise<ExampleProject[]> {
+/** Prefetch every example in `examples/examples.json`. The interactive picker uses `featured` only. */
+export async function loadExamplesCatalog(): Promise<ExampleProject[]> {
   try {
     const { content } = await fetchSourceFile(EXAMPLES_CATALOG_PATH);
-    return parseFeaturedExamples(content);
+    return parseExamplesCatalog(content);
   } catch (err) {
     if (err instanceof CreateError) throw err;
     throw new CreateError(
       "args_resolution",
-      `Could not load featured examples from ${EXAMPLES_CATALOG_PATH}.`,
+      `Could not load examples from ${EXAMPLES_CATALOG_PATH}.`,
       "network",
       "FEATURED_CATALOG_UNAVAILABLE",
     );
   }
 }
 
-export function requireFeaturedExamples(examples: ExampleProject[], requested?: string): void {
+export function requireExamplesCatalog(examples: ExampleProject[], requested?: string): void {
   if (!requested || examples.length > 0) return;
   throw new CreateError(
     "args_resolution",
-    `Could not load featured examples from ${EXAMPLES_CATALOG_PATH}.`,
+    `Could not load examples from ${EXAMPLES_CATALOG_PATH}.`,
     "network",
     "FEATURED_CATALOG_UNAVAILABLE",
   );

packages/openui-cli/src/lib/projects.ts

@@ -24,6 +24,8 @@ export interface ExampleProject {
   /** Primary env var to prompt for. Omit when the example needs several keys. */
   envKey?: string;
   aliases?: string[];
+  /** When true, the example appears in the interactive create picker. */
+  featured?: boolean;
 }
 
 export type ProjectMetadata = TemplateProject | ExampleProject;
@@ -118,10 +120,11 @@ export async function resolveProject(params: {
         description: project.description,
       })),
     ];
-    if (examples.length > 0) {
+    const pickerExamples = examples.filter((project) => project.featured);
+    if (pickerExamples.length > 0) {
       choices.push(
         new Separator("────── Feature Examples ──────"),
-        ...examples.map((project) => ({
+        ...pickerExamples.map((project) => ({
           value: `example:${project.name}`,
           name: project.label,
           description: project.description,