@cloudinary/apps-cli
v0.1.21
Published
CLI to bootstrap Cloudinary DAM apps
Readme
@cloudinary/apps-cli
CLI for scaffolding and managing Cloudinary DAM custom-action apps.
Requirements: Node.js >= 20
Install
npm install -g @cloudinary/apps-cliThis installs the cld-apps binary.
Quick start
cld-apps create my-dam-app
cd my-dam-app
pnpm install
pnpm devDev server: http://localhost:7179
Commands
| Command | Description |
| ------------------------------------------------- | ---------------------------------------------- |
| cld-apps create <app-name> | Scaffold a new DAM app |
| cld-apps login | Authenticate via browser and store credentials |
| cld-apps logout [cloud-name] | Remove stored credentials |
| cld-apps whoami | Show active cloud / credentials |
| cld-apps use <cloud-name> | Switch active cloud |
| cld-apps manifest create [path] | Create cloudinary.app.json (+ schema) |
| cld-apps manifest validate [path] | Validate a manifest |
| cld-apps manifest push [options] | Push manifest to Cloudinary |
| cld-apps manifest push:watch [options] | Watch and push on change |
| cld-apps deploy <staging\|production> [options] | Build, zip, and deploy |
| cld-apps get-config [options] | Fetch live DamConfig |
| cld-apps --version | Print package version |
Run cld-apps with no args for full usage.
Auth
cld-apps loginCredentials are stored locally. Override with CLOUDINARY_GATEWAY_TOKEN when needed.
Optional env:
CLOUDINARY_GATEWAY_URL/API_GATEWAY_URL— gateway base URLCLOUDINARY_APP_ID— Custom Action app id (also via.env.<tier>)
Publishing this package (maintainers)
From cli/:
./bin/publishPublishes @cloudinary/apps-cli to the public npm registry (--access public). Requires npm auth with publish rights to the @cloudinary scope.
Related packages
@cloudinary/apps-api— typed API gateway client (CLI dependency)@cloudinary/apps-sdk— shared utilities for DAM apps (scaffold dependency)
