Create Zuplo API

6.69.10 verified Sat May 09 auth: no javascript

Create Zuplo API is a zero-dependency CLI tool (v6.69.10, latest) for scaffolding new Zuplo API projects interactively or non-interactively. It supports TypeScript, JavaScript, ESLint, Prettier, multiple package managers (npm, yarn, pnpm, bun), and optional server-side project creation on portal.zuplo.com. Unlike generic scaffolding tools, it is officially maintained by Zuplo and offers offline support, example templates, and git initialization. Requires Node >=20.

Common errors

error Error: The engine "node" is incompatible with this module. Expected version ">=20". Got "18.x.x" ↓

cause The package requires Node.js version 20 or higher.

fix

Upgrade Node.js to version 20 or later, or use nvm to switch to a compatible version.

error Error: Cannot find module 'create-zuplo-api' ↓

cause Attempting to use the package as a library instead of a CLI tool.

fix

Use npx create-zuplo-api or npm create zuplo-api instead of requiring it in code.

error command not found: create-zuplo-api ↓

cause Global install may be missing or not in PATH.

fix

Use npx create-zuplo-api@latest or the npm create command; avoid global install.

Warnings

breaking Node >=20 required — older versions will fail to run. ↓

fix Update Node.js to version 20 or later.

gotcha The CLI will prompt to create a project on portal.zuplo.com by default in interactive mode; in non-interactive (CI) mode it skips this unless --server-project or --account is passed. ↓

fix Pass --no-server-project or --server-project explicitly to avoid surprises in CI.

gotcha If you pass --example with a GitHub URL containing a slash in the branch name, you must also provide --example-path to disambiguate. ↓

fix Use --example <url> --example-path <path> for complex GitHub URLs.

deprecated The --no-install option skips package installation; previously there was no way to skip it. ↓

fix Use --no-install (available since v6) instead of workarounds.

Install

npm install create-zuplo-api

yarn add create-zuplo-api

pnpm add create-zuplo-api

Imports

createZuploApi (npx)
wrong
```
npm install -g create-zuplo-api
```
correct
```
npx create-zuplo-api@latest
```
The package is a CLI tool, not a library. Use npx or the equivalent for your package manager.
npm create
wrong
```
npm init zuplo-api
```
correct
```
npm create zuplo-api@latest
```
npm's npm create is specifically for scaffolding packages and is the recommended way.

yarn create

wrong

yarn add create-zuplo-api && create-zuplo-api

correct

yarn create zuplo-api

yarn create does not require global install.

Quickstart

Scaffolds a new Zuplo API project named 'my-api' with TypeScript, Prettier, and ESLint in non-interactive mode.

npm create zuplo-api@latest my-api -- --typescript --prettier --eslint