You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`-n, --name <string>`| Project name (directory to create) |
59
-
|`-t, --template <template>`| AI setup/template: `openui-cloud` or `openui-self-hosted`|
60
-
|`--api-key <key>`| OpenUI Cloud API key; skips sign-in for the Cloud setup |
61
-
|`--auth <method>`| Cloud auth method: `oauth`, `manual`, or `skip`|
62
-
|`--skill`| Install the OpenUI agent skill for AI coding assistants |
63
-
|`--no-skill`| Skip installing the OpenUI agent skill |
64
-
|`--no-install`| Scaffold without running dependency installation |
65
-
|`--no-interactive`| Fail instead of prompting for missing input |
66
-
|`--agent-name <name>`| Declare the invoking coding-agent slug (default: `unknown`) |
67
-
68
-
When run interactively (default), the CLI prompts for any missing options. It asks you to choose your AI setup: **OpenUI Cloud** is the fastest setup with free hosted models, while **OpenAI-compatible provider** uses your own key and self-hosts the AI route in the generated app. Pass `--no-interactive` in CI or scripted environments to surface missing required flags as errors instead.
|`-n, --name <string>`| Project name (directory to create) |
59
+
|`-t, --template <template>`| AI backend: `openui-cloud`(recommended) or `openui-self-hosted`|
60
+
|`--api-key <key>`| OpenUI Cloud API key; skips sign-in for the Cloud setup |
61
+
|`--auth <method>`| Cloud auth method: `oauth`, `manual`, or `skip`|
62
+
|`--skill`| Install the OpenUI agent skill for AI coding assistants |
63
+
|`--no-skill`| Skip installing the OpenUI agent skill |
64
+
|`--no-install`| Scaffold without running dependency installation |
65
+
|`--no-interactive`| Fail instead of prompting for missing input |
66
+
|`--agent-name <name>`| Declare the invoking coding-agent slug (default: `unknown`) |
67
+
68
+
When run interactively (default), the CLI prompts for any missing options. 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. Pass `--no-interactive` in CI or scripted environments to surface missing required flags as errors instead.
Scaffolds a new Next.js app from the **OpenUI Chat** or **OpenUI Cloud** template.
58
+
Scaffolds a new Next.js agent app from the recommended managed **OpenUI Cloud**template or the **self-hosted** template.
59
59
60
60
```bash
61
61
openui create [options]
@@ -64,7 +64,7 @@ openui create [options]
64
64
Options:
65
65
66
66
-`-n, --name <string>`: Project name
67
-
-`-t, --template <template>`: Template to scaffold — `openui-self-hosted`or `openui-cloud`
67
+
-`-t, --template <template>`: AI backend — `openui-cloud` (managed) or `openui-self-hosted` (bring your provider)
68
68
-`--skill`: Install the OpenUI agent skill for AI coding assistants
69
69
-`--no-skill`: Skip installing the OpenUI agent skill
70
70
-`--no-install`: Scaffold without running the package install
@@ -83,24 +83,29 @@ What it does:
83
83
- optionally installs the OpenUI agent skill for AI coding assistants
84
84
- writes a `.env` file tailored to the template (see below)
85
85
86
+
#### Choose a backend
87
+
88
+
-**OpenUI Cloud (recommended default)** — start here for prototypes and evaluations. You get hosted models, managed conversation history and streaming, built-in tools, and ready-to-use report and presentation artifacts without operating the model, storage, or artifact infrastructure.
89
+
-**Self-hosted** — choose this when owning the OpenAI-compatible provider integration, AI route, and persistence is a requirement.
90
+
86
91
#### Template-specific `.env`
87
92
88
-
-**OpenUI Chat** — prompts for your OpenAI API key and writes `OPENAI_API_KEY` to `.env` (interactive mode only). Leave blank to skip.
89
93
-**OpenUI Cloud** — obtains an OpenUI Cloud API key and writes `THESYS_API_KEY` plus `DEMO_USER_ID=demo-user` to `.env`. The key is resolved by, in order:
90
94
-`--api-key <key>` if provided
91
95
- the `--auth` method, otherwise an interactive prompt offering:
92
96
-`oauth` — sign in with Thesys in the browser and mint a key for your org
93
97
-`manual` — paste an existing key
94
98
-`skip` — leave `THESYS_API_KEY` empty and add it later (get one at <https://console.thesys.dev/keys>)
95
99
- in non-interactive mode without `--api-key`, the cloud template fails because a key is required
100
+
-**Self-hosted** — prompts for your OpenAI-compatible provider API key and writes `OPENAI_API_KEY` to `.env` (interactive mode only). Leave blank to skip.
0 commit comments