CLI Reference

The renduo CLI is the primary tool for developing templates: it bundles your React component locally, registers it as a template, manages assets, and generates test PDFs.

Install

npm install -g @renduo/cli

The -g flag matters: without it, npm installs the package into a local node_modules folder and renduo is never added to your shell's PATH, which shows up as command not found: renduo.

If you'd rather not install globally, run it through npx instead — this works with a local (non--g) install too:

npm install @renduo/cli
npx renduo whoami

If you did use -g and still get command not found: renduo, your global npm bin directory isn't on PATH. Check where npm installs global binaries and confirm it's there:

npm config get prefix   # e.g. /usr/local or ~/.nvm/versions/node/vX.Y.Z
echo $PATH               # should include <prefix>/bin

Configuration

Set these environment variables before running any authenticated command:

* Only renduo push can fail fast without it, and renduo templates list, renduo whoami, renduo generate, and renduo assets all require it.

export RENDUO_API_KEY=rnd_live_your_key_here

Commands

renduo push <file.tsx>

Bundles a React component locally with esbuild (platform: browser, format: iife, React as external) and registers it as a template — creating a new template or a new version of an existing one (same slug = new version).

renduo push Invoice.tsx --slug invoice

Requires RENDUO_API_KEY with the templates:write scope.

renduo templates list

Lists the templates registered in your account with their active version.

renduo templates list

Requires RENDUO_API_KEY with the templates:read scope.

renduo whoami

Shows the account, plan, current usage, environment, and key prefix for the active API key.

renduo whoami

Requires RENDUO_API_KEY.

renduo generate <templateId>

Generates a PDF in sync mode and saves it to disk.

renduo generate <templateId> --props '{"title":"..."}' --output invoice.pdf

Requires RENDUO_API_KEY with the generate scope.

renduo assets

Manage your organization's custom fonts and images (ADR-016).

renduo assets push ./acme-sans.woff2 --name acme-sans   # upload a font or image
renduo assets list                                       # list assets + storage usage
renduo assets rm acme-sans                               # delete an asset

Requires RENDUO_API_KEY with the templates:write scope (list needs templates:read).

See also

• Quickstart — the full flow from API key to first PDF.
• CLI workflow — push, versions, and pinning an older version.
• Custom fonts — the assets flow end to end.
• API reference — the HTTP endpoints the CLI calls under the hood.