create-zuplo-api 7.8.7 → 7.8.9

package/README.md

@@ -16,130 +16,48 @@ pnpm create zuplo-api
 bunx create-zuplo-api
 ```
 
-You will be asked for the name of your project, and then whether you want to
-create a TypeScript project:
+You will be asked for the name of your project and a few setup options, such as
+the linter, formatter, and AI coding agents to configure.
 
-```bash
-✔ Would you like to use TypeScript? … No / Yes
-```
+### Templates
 
-Select **Yes** to install the necessary types/dependencies and create a new TS
-project.
+Pick a built-in template with `--template <name>`:
 
-### Non-interactive
-
-You can also pass command line arguments to set up a new project
-non-interactively. See `create-zuplo-api --help`:
+| Template        | What you get                                                                  |
+| --------------- | ----------------------------------------------------------------------------- |
+| `default`       | A sample API with routes, a developer portal, and VS Code debugging (default) |
+| `default-empty` | The same project structure with no sample routes (same as `--empty`)          |
+| `ai-gateway`    | A Zuplo AI Gateway: one OpenAI-compatible API in front of many AI providers   |
 
 ```bash
-Usage: create-zuplo-api [project-directory] [options]
-
-Options:
-  -V, --version                        output the version number
-  --ts, --typescript
-
-    Initialize as a TypeScript project. (default)
-
-  --js, --javascript
-
-    Initialize as a JavaScript project.
-
-  --linter <linter>
-
-    The linter to configure: eslint, biome, oxlint, or none.
-
-  --formatter <formatter>
-
-    The formatter to configure: prettier, biome, oxfmt, or none.
-    Biome can fill both roles with a single dependency and config.
-
-  --eslint
-
-    Initialize with ESLint config. (deprecated: use --linter eslint)
-
-  --prettier
-
-    Initialize with Prettier config. (deprecated: use --formatter prettier)
-
-  --empty
-
-    Initialize an empty project.
-
-  --use-npm
-
-    Explicitly tell the CLI to bootstrap the application using npm
-
-  --use-pnpm
-
-    Explicitly tell the CLI to bootstrap the application using pnpm
-
-  --use-yarn
-
-    Explicitly tell the CLI to bootstrap the application using Yarn
-
-  --use-bun
-
-    Explicitly tell the CLI to bootstrap the application using Bun
-
-  --no-install
-
-    Explicitly tell the CLI to skip installing packages
-
-  --no-git
-
-    Explicitly tell the CLI to skip initialing the project as a git repository
-
-  --no-version-check
-
-    Explicitly tell the CLI to skip checking for the latest version of the CLI
-
-  --server-project
-
-    Create a project on portal.zuplo.com and link this working copy
-    to it. Skips the interactive prompt and goes straight to account
-    selection, project creation, and linking.
-
-  --no-server-project
-
-    Don't create a project on portal.zuplo.com. Local files are
-    scaffolded as usual; the prompt is skipped.
-
-  --account <account-name>
-
-    The Zuplo account that will host the project. Passing this flag
-    implies --server-project (the prompt is skipped). If you opt in
-    without passing --account, create-zuplo-api will prompt you to
-    pick from your accounts, or auto-select if you have exactly one.
-
-    By default, when run interactively, create-zuplo-api asks whether
-    to create a project on portal.zuplo.com before contacting the
-    portal. In --yes or non-interactive (CI) mode the default answer
-    is "no" — pass --server-project or --account <name> to opt in.
-
-  -e, --example [name]|[github-url]
-
-    An example to bootstrap the app with. You can use an example name
-    from the official Zuplo repo or a GitHub URL. The URL can use
-    any branch and/or subdirectory
-
-  --example-path <path-to-example>
-
-    In a rare case, your GitHub URL might contain a branch name with
-    a slash (e.g. bug/fix-1) and the path to the example (e.g. foo/bar).
-    In this case, you must specify the path to the example separately:
-    --example-path foo/bar
-
-  --reset-preferences
-
-    Explicitly tell the CLI to reset any stored preferences
+npm create zuplo-api@latest my-gateway -- --template ai-gateway
+```
 
-  --yes
+`--template` can't be combined with `--example` or `--empty`.
 
-    Use previous preferences or defaults for all options that were not
-    explicitly specified, without prompting.
+### Non-interactive
 
-  -h, --help                           display help for command
-```
+You can also pass command line arguments to set up a new project
+non-interactively. Common options:
+
+| Option                                               | Description                                                                      |
+| ---------------------------------------------------- | -------------------------------------------------------------------------------- |
+| `--template <name>`                                  | Built-in template: `default`, `default-empty`, or `ai-gateway`                   |
+| `--empty`                                            | Initialize an empty project (same as `--template default-empty`)                 |
+| `-e, --example <name\|github-url>`                   | Bootstrap from a Zuplo example or a public GitHub URL                            |
+| `--example-path <path>`                              | Path to the example when the GitHub branch name contains a slash                 |
+| `--linter <linter>`                                  | Linter to configure: `eslint`, `biome`, `oxlint`, or `none`                      |
+| `--formatter <formatter>`                            | Formatter to configure: `prettier`, `biome`, `oxfmt`, or `none`                  |
+| `--agents <agents>`                                  | AI coding agents to configure (`claude,copilot,cursor,windsurf,codex`) or `none` |
+| `--use-npm`, `--use-pnpm`, `--use-yarn`, `--use-bun` | Package manager to bootstrap with                                                |
+| `--no-install`                                       | Skip installing packages                                                         |
+| `--no-git`                                           | Skip initializing a git repository                                               |
+| `--server-project` / `--no-server-project`           | Create (or skip creating) a linked project on portal.zuplo.com                   |
+| `--account <account-name>`                           | Zuplo account to host the project. Implies `--server-project`                    |
+| `--yes`                                              | Use saved preferences or defaults without prompting                              |
+| `--reset-preferences`                                | Reset saved preferences                                                          |
+
+Run `create-zuplo-api --help` for the full list.
 
 ### Why use Create Zuplo API?