@renduo/cli

Official CLI for Renduo — register React components as templates and generate PDFs.

Install

npm install -g @renduo/cli

The -g flag matters: without it, npm installs the package locally and renduo won't be on your shell's PATH, which shows up as command not found: renduo.

Prefer not to install globally? Run it through npx instead — this works with a local (non--g) install too:

npm install @renduo/cli
npx renduo whoami

Still get command not found: renduo after installing with -g? 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

export RENDUO_API_KEY=rnd_live_your_key_here
export RENDUO_API_URL=http://localhost:3000     # optional, default: https://api.renduo.dev

Commands

renduo push MyComponent.tsx                     # bundles with esbuild and registers (or versions) the template
renduo push MyComponent.tsx --slug custom-slug --name "My Name"
renduo push MyComponent.tsx --sample-payload sample.json --schema schema.json
renduo push MyComponent.tsx --assets acme-sans,company-logo   # assets to bake into this version

renduo templates list                           # lists your account's templates + active version

renduo assets push AcmeSans.woff2               # uploads a font or image
renduo assets push logo.png --name company-logo
renduo assets list
renduo assets rm company-logo

renduo generate <templateId> --props '{...}'    # generates a test PDF (sync mode) and saves it to disk
renduo generate <templateId> --props-file props.json   # props from a .json file instead of an inline string
renduo generate <templateId> --props '{...}' --output ./out/invoice.pdf   # custom output path (default: ./<templateId>.pdf)

renduo whoami                                   # info about the active organization and API key

Documentation

See renduo.dev/docs.