Skip to content
Press.js Press.js Press.js Docs

Command Reference

These commands are provided by press-cloud-cli. Use them through press or invoke the binary directly.

Available with any command:

FlagDescription
--api-base <url>API base URL (default: Press.js Cloud production)
--token <key>API key for automation (prefix pcak_)
--helpPrint usage information

Install or upgrade the cloud CLI. See Installation.

press install cloud [--force] [--url <url>]
FlagDescription
--forceForce reinstall instead of treating an existing binary as an upgrade
--url <url>Custom cloud CLI archive or binary URL

Uninstall the managed cloud CLI binary installed by press install cloud.

press uninstall cloud

This removes the managed press-cloud-cli binary and manifest from PRESSJS_CLOUD_INSTALL_DIR. It does not delete a binary referenced through PRESSJS_CLOUD_CLI_PATH.

View or change CLI automatic update settings.

press update config [--auto true|false]

Automatic updates are enabled by default. Cloud CLI updates run in the background before Cloud commands when a managed install exists. Project-local @press-js/cli installs are not modified.

FlagDescription
--auto true|falseEnable or disable auto updates

Authenticate interactively. See Authentication.

press login

Opens your browser for OAuth sign-in (GitHub or Google).

Clear your session.

press logout

Show the current user.

press whoami

Build and deploy a document. See Deploy and Quickstart.

press deploy [entry] [options]
FlagDescription
--config <path>Path to press.toml (default: ./press.toml)
--no-buildSkip the build step
--token <key>API key for automation (prefix pcak_)
--deploy-id <id>Target an existing deploy by ID
--slug <slug>Target an existing deploy by slug
--name <name>Name for the deploy

Unrecognized flags are forwarded to the cloud binary.

Build and render a document on Press.js Cloud using the normal press render command.

press render [entry] --remote [options]
FlagDescription
--config <path>Path to press.toml (default: ./press.toml)
--out <pdf>Local PDF output path passed to the cloud render workflow
--timeout <ms>Render timeout forwarded as --render-timeout-ms
--save-versionKeep the deploy/version instead of deleting a temporary deploy
--remote-output <mode>Cloud output retention: transient or managed
--token <key>API key for automation (prefix pcak_)
--api-base <url>API base URL override
--deploy-id <id>Target an existing deploy by ID
--slug <slug>Target or create a deploy by slug
--name <name>Name used when a deploy is created

Without --save-version or an explicit deploy target, press render --remote creates a temporary deploy and deletes it after the cloud CLI finishes.

Manage deployments. See Managing Deploys.

press deploys <subcommand> [options]
SubcommandDescription
listList all deploys in your account
getView a specific deploy’s details
createCreate a new empty deploy
updateUpdate a deploy’s name or settings
deleteDelete a deploy
versionsList a deploy’s version history
aliasPoint an alias (e.g. production) to a version

Delete a deploy with:

press deploys delete --deploy-id <id> --yes
VariableDescription
PRESS_CLOUD_TOKENAPI key for automated auth
PRESS_CLOUD_API_BASEAPI base URL (default: Press.js Cloud production)
PRESSJS_CLOUD_INSTALL_DIRCloud CLI install directory (default: ~/.press-js/cloud)
PRESSJS_CLOUD_CLI_PATHDirect path to the cloud binary
PRESS_CLOUD_CLI_DOWNLOAD_URLCustom cloud CLI archive or binary URL override
PRESSJS_RENDER_DEBUGSet to "1" to preserve render debug logs