Skip to documentation
Documentation

Jumpz CLI

Use the Jumpz CLI when you want to deploy, follow a build, manage environment variables, or share an app without leaving your terminal.

The CLI is a thin client for your Jumpz installation. It uses the same account and access rules as the dashboard, so you can safely use it yourself or from an approved coding workflow.

Install the CLI

The CLI currently ships with the Jumpz source. From a checkout of the project, build it and optionally expose the jump command on your PATH.

cd cli
npm install
npm run build
npm link

Point the CLI at the Jumpz installation you use. It defaults to a local installation at http://localhost:3000.

export JUMP_API_URL=https://your-jump-installation.example

Log in from the CLI

Run jump login. Your browser opens a Jumpz page asking you to approve the CLI; approve it and return to the terminal. No password or link passes through the terminal.

jump login

Run jump whoami to check the active account and jump logout when you finish on a shared machine. For automation, mint a personal token in the dashboard and run jump login --token <token>, or set JUMP_TOKEN.

Deploy an app

From a project directory, run jump deploy. Jumpz packs the directory, publishes it, follows the build, and prints the app’s link. Run it again later to publish a new version of the same app.

cd team-dashboard
jump deploy
jump deploy --message "Add the weekly chart"
jump deploy https://github.com/you/your-app --env API_URL=https://api.example

The CLI never uploads .env files — set secrets with jump env set, where they are stored encrypted and can never be read back. Apps require sign-in; share them with jump share. Use --workspace <id> to choose a workspace (jump workspaces lists them), or --no-follow to start the deployment without waiting.

Understand deployment stagesPublish from Claude or ChatGPT instead

Commands

jump appsList the apps you can access.
jump logs <app>Follow the latest deployment. Add --no-follow to print the current logs and exit.
jump env list|set|rm <app>List variable names, set values, or remove keys. Redeploy the app to apply a change.
jump share <app> <email>Invite someone by email. Add --link to create an invitation link you can send yourself.
jump revoke <app> <email>Remove someone’s access to an app.
jump access <app>List who has been given access.
jump open <app>Print the app’s Jumpz URL.
jump stop <app>Stop a running app.
jump redeploy <app>Build and deploy the app’s source again.
jump rm <app>Permanently delete an app after confirmation. Use --yes only in a trusted non-interactive workflow.

Keep your sign-in safe

The CLI stores a short-lived access token and a refresh token in ~/.jump/config.json with owner-only file permissions. They work only with the CLI’s API, not the dashboard. Anyone with that file may be able to act as you, so do not share or commit it; disconnect it from Settings if a machine is lost.

Environment-variable values are sent only when you set them. Jumpz shows variable names when you list them, but never returns stored values.

On this page