Command Reference
These commands are provided by press-cloud-cli. Use them through press or invoke the binary directly.
Global flags
Section titled “Global flags”Available with any command:
| Flag | Description |
|---|---|
--api-base <url> | API base URL (default: Press.js Cloud production) |
--token <key> | API key for automation (prefix pcak_) |
--help | Print usage information |
press install cloud
Section titled “press install cloud”Install or upgrade the cloud CLI. See Installation.
press install cloud [--force] [--url <url>]| Flag | Description |
|---|---|
--force | Force reinstall instead of treating an existing binary as an upgrade |
--url <url> | Custom cloud CLI archive or binary URL |
press uninstall cloud
Section titled “press uninstall cloud”Uninstall the managed cloud CLI binary installed by press install cloud.
press uninstall cloudThis 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.
press update config
Section titled “press update config”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.
| Flag | Description |
|---|---|
--auto true|false | Enable or disable auto updates |
press login
Section titled “press login”Authenticate interactively. See Authentication.
press loginOpens your browser for OAuth sign-in (GitHub or Google).
press logout
Section titled “press logout”Clear your session.
press logoutpress whoami
Section titled “press whoami”Show the current user.
press whoamipress deploy
Section titled “press deploy”Build and deploy a document. See Deploy and Quickstart.
press deploy [entry] [options]| Flag | Description |
|---|---|
--config <path> | Path to press.toml (default: ./press.toml) |
--no-build | Skip 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.
press render —remote
Section titled “press render —remote”Build and render a document on Press.js Cloud using the normal press render command.
press render [entry] --remote [options]| Flag | Description |
|---|---|
--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-version | Keep 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.
press deploys
Section titled “press deploys”Manage deployments. See Managing Deploys.
press deploys <subcommand> [options]| Subcommand | Description |
|---|---|
list | List all deploys in your account |
get | View a specific deploy’s details |
create | Create a new empty deploy |
update | Update a deploy’s name or settings |
delete | Delete a deploy |
versions | List a deploy’s version history |
alias | Point an alias (e.g. production) to a version |
Delete a deploy with:
press deploys delete --deploy-id <id> --yesEnvironment variables
Section titled “Environment variables”| Variable | Description |
|---|---|
PRESS_CLOUD_TOKEN | API key for automated auth |
PRESS_CLOUD_API_BASE | API base URL (default: Press.js Cloud production) |
PRESSJS_CLOUD_INSTALL_DIR | Cloud CLI install directory (default: ~/.press-js/cloud) |
PRESSJS_CLOUD_CLI_PATH | Direct path to the cloud binary |
PRESS_CLOUD_CLI_DOWNLOAD_URL | Custom cloud CLI archive or binary URL override |
PRESSJS_RENDER_DEBUG | Set to "1" to preserve render debug logs |