renza

CLI

The renza CLI drives the same API as the app and the SDK — anything you can do in the UI, you can script. One command is one endpoint, plus a small set of porcelain commands for the everyday journeys. This page walks those journeys; the full command tree is at Commands and the automation contract (JSON output, exit codes, flags) at Output & exit codes.

Install

Run it with npx (no install), or install the renza binary globally:

npx renza <command>      # zero-install
npm install -g renza     # or install it once

The examples below drop the npx for brevity.

Log in

renza login

renza login opens your browser, you approve the device, and the CLI stores a key that acts as you (comments and other actions are authored under your name) in ~/.renza/config.json (mode 0600). For CI or headless environments, skip the browser:

renza login --api-key rza_sk_live_…

renza whoami shows where requests go (never the secret), renza me resolves the current actor and org, and renza doctor diagnoses credentials, connectivity, and identity in one shot. Key kinds, credential precedence, and service keys are covered in Authentication.

Publish — the fastest path to a link

renza publish              # finds the .html in the current folder → a live link
renza publish deck.html    # or name it

publish scans the current directory for an HTML deck (one file → straight through; several → it asks which), hosts it, and opens the link. No login required — logged out, the deck is hosted anonymously and is claimable: run renza login and publish again to keep it under your account.

In use — publish once, then keep the same link live across revisions:

renza publish deck.html --external-id board-q3   # first run creates the deck
renza publish deck.html --external-id board-q3   # later runs add a version, same link

--no-open skips the browser; --new forces a fresh deck instead of versioning.

Import — the plumbing under publish

renza import ./q3-board-deck.html --title "Q3 Board Deck"

import is the direct call to POST /v1/imports: file in, deck out, no folder scanning or link opening. Use it in scripts where you want exactly one file imported and the result as JSON. The full journey — import, check status, work with the deck — is in Import a deck.

Check — validate before you publish

renza check deck.html

check validates a deck against the slide contract without publishing — the author loop. Fix what it reports, run it again, publish when it passes.

Init and guide — teach your AI tools

renza guide            # print the slide contract (how to author a Renza-ready deck)
renza init             # write it into your AI tools (Claude skill / Cursor rules / AGENTS.md)

renza init detects your tools and drops the slide contract where your agent will read it, so "make me a deck" produces Renza-ready HTML. renza guide prints the same contract to stdout for piping into a prompt.

Describe and commands — orientation for agents

renza commands         # the full command tree as JSON (capability discovery)
renza describe <id>    # a rich summary — a deck rolls up its versions, shares, grants, open comments

renza commands is how an agent discovers what the CLI can do without scraping --help. renza describe answers "what is this id and what's around it" in one call.

Everything else

The CLI covers the whole API — decks, versions, rollback, folders, shares, comments, grants, keys, orgs. Two pages carry the reference: