diff --git a/apps/docs/src/content/docs/ai-agents.md b/apps/docs/src/content/docs/ai-agents.md index 3b1f9b18..a47cdde3 100644 --- a/apps/docs/src/content/docs/ai-agents.md +++ b/apps/docs/src/content/docs/ai-agents.md @@ -76,7 +76,7 @@ It guides decisions about raw versus shaped data, transformations, pagination, i bun create chkit@latest my-chkit-app --example hello ``` -`hello` is the small default schema (two tables, one migration). Pass `--example clickbench` for the full ClickBench dataset load. +`hello` is two tables and one migration. Pass `--example hello` as shown: the published interactive prompt still preselects `clickbench` until `create-chkit` is republished. Pass `--example clickbench` for the full ClickBench dataset load. It then runs the same connect flow as `chkit init` (Step 4). Drive it non-interactively with `--connect ` (and `--email` for the claim path), or `--skip-onboarding` to scaffold only. diff --git a/apps/docs/src/content/docs/getting-started/index.mdx b/apps/docs/src/content/docs/getting-started/index.mdx index e5a8bef2..d1ced2c0 100644 --- a/apps/docs/src/content/docs/getting-started/index.mdx +++ b/apps/docs/src/content/docs/getting-started/index.mdx @@ -29,7 +29,7 @@ For manual setup, start with an example or add chkit to an existing project. - -Pass a project directory and select `hello` explicitly: +Pass `--example hello`: +Omitting `--example` prompts from the manifest bundled in the installed `create-chkit` package. That published prompt still preselects `clickbench` and does not list `hello` until `create-chkit` is republished. `--example` downloads the named example from the repository, so `--example hello` works on the current release. The repository manifest default is already `hello`; the prompt picks that up on the next release. + The scaffold then asks how to connect: ``` @@ -49,7 +47,7 @@ For the full ClickBench schema and public dataset load, pass `--example clickben | Flag | Description | | --- | --- | | `[project-directory]` | Target directory. Prompted if omitted. | -| `-e, --example ` | Example name or full GitHub URL. Prompted with the list of bundled examples if omitted. | +| `-e, --example ` | Example name or full GitHub URL. If omitted, prompted from the manifest bundled in the installed package. | | `-m, --package-manager ` | `npm`, `pnpm`, `yarn`, or `bun`. Auto-detected from the invoking package manager. | | `--skip-install` | Skip installing dependencies after scaffolding. | @@ -57,10 +55,10 @@ For the full ClickBench schema and public dataset load, pass `--example clickben | Name | Description | | --- | --- | -| `hello` | Two small tables and one migration. Default. Claim a free ObsessionDB instance or use local ClickHouse. | -| `clickbench` | Full ClickBench schema and dataset load against ObsessionDB or ClickHouse. | +| `hello` | Two small tables and one migration. Default in the repository manifest. Claim a free ObsessionDB instance or use local ClickHouse. | +| `clickbench` | Full ClickBench schema and dataset load against ObsessionDB or ClickHouse. Preselected by the published interactive prompt until `create-chkit` is republished. | -The list and default live in [`examples/manifest.json`](https://github.com/obsessiondb/chkit/blob/main/examples/manifest.json). The same `hello` project can be cloned from [`examples/hello`](https://github.com/obsessiondb/chkit/tree/main/examples/hello) without the scaffolder. +The list and repository default live in [`examples/manifest.json`](https://github.com/obsessiondb/chkit/blob/main/examples/manifest.json). The same `hello` project can be cloned from [`examples/hello`](https://github.com/obsessiondb/chkit/tree/main/examples/hello) without the scaffolder. ## Run your first migration diff --git a/packages/create-chkit/README.md b/packages/create-chkit/README.md index 259deca7..975a31da 100644 --- a/packages/create-chkit/README.md +++ b/packages/create-chkit/README.md @@ -16,6 +16,14 @@ yarn create chkit Pick an example by name: +```sh +bun create chkit@latest my-app --example hello +``` + +`hello` is two tables and one migration. Omitting `--example` prompts from the manifest bundled in the installed package. Published `create-chkit` still preselects `clickbench` and does not list `hello` until that package is republished. `--example` downloads `examples/` from the chkit repository, so `--example hello` works on the current release. + +`clickbench` is the full ClickBench schema and dataset load: + ```sh bun create chkit@latest my-app --example clickbench ``` @@ -25,7 +33,7 @@ bun create chkit@latest my-app --example clickbench | Flag | Description | | --- | --- | | `[project-directory]` | Target directory. Prompted if omitted. | -| `-e, --example ` | Example to scaffold. Bare name (`clickbench`) or full GitHub URL. Prompted with the list of bundled examples if omitted. | +| `-e, --example ` | Example to scaffold. Bare name (`hello`, `clickbench`) or full GitHub URL. If omitted, prompted from the manifest bundled in the installed package. | | `-m, --package-manager ` | `npm`, `pnpm`, `yarn`, or `bun`. Auto-detected from the invoking package manager. | | `--skip-install` | Skip installing dependencies after scaffolding. | | `-v, --version` | Print version. | @@ -35,6 +43,7 @@ bun create chkit@latest my-app --example clickbench | Name | Description | | --- | --- | +| `hello` | Two small tables and one migration. Default in the repository manifest. | | `clickbench` | Full ClickBench schema and dataset load against ObsessionDB / ClickHouse. | -See the [chkit documentation](https://chkit.obsessiondb.com) for the full list. +See the [chkit documentation](https://chkit.obsessiondb.com/getting-started/with-an-example/) for the scaffold flow.