Registry / devops / create-zuplo-api

create-zuplo-api

JSON →
library6.69.10jsnpmunverified

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.

devops
npm install create-zuplo-api
github ↗package ↗homepage ↗
INSTALL
IMPORT
SIG · CREATE-ZUPLO-API
C
create-zuplo-api
devopsjavascriptv6.69.10
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

createZuploApi (npx)
✓ npx create-zuplo-api@latest
✗ npm install -g create-zuplo-api
The package is a CLI tool, not a library. Use npx or the equivalent for your package manager.
npm create
✓ npm create zuplo-api@latest
✗ npm init zuplo-api
npm's npm create is specifically for scaffolding packages and is the recommended way.
yarn create
✓ yarn create zuplo-api
✗ yarn add create-zuplo-api && create-zuplo-api
yarn create does not require global install.

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
create-zuplo-api --version
Debug
Known issues
breakingNode >=20 required — older versions will fail to run.
fix
Update Node.js to version 20 or later.
affects: >=6.0.0
gotchaThe 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.
affects: *
gotchaIf 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.
affects: *
deprecatedThe --no-install option skips package installation; previously there was no way to skip it.
fix
Use --no-install (available since v6) instead of workarounds.
affects: <6.0.0
Errors
Common errors & fixes
Error: The engine "node" is incompatible with this module. Expected version ">=20". Got "18.x.x"
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: Cannot find module 'create-zuplo-api'
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.
command not found: create-zuplo-api
Global install may be missing or not in PATH.
fix
Use npx create-zuplo-api@latest or the npm create command; avoid global install.
Upgrade
Version history
6.69.10latest on npm
Audit
Dependencies

No dependency data recorded yet.

Agent activity
6 hits · last 30 days
node
6
Resources
githubhttps://github.com/zuplo/core ↗
packagehttps://www.npmjs.com/package/create-zuplo-api ↗
homepagehttps://zuplo.com ↗
create-zuplo-api — npm install create-zuplo-api · libregistry