OrbitPush CLI

Log in

Run the CLI through npx, with no global installation:

npx -y @orbitpush/cli@latest login

The CLI prints a link and code, opens the link when possible, and waits for approval in your browser. It stores the resulting login locally for later commands.

Deploy a directory

Build your site first, then pass its output directory to deploy:

npm run build
npx -y @orbitpush/cli@latest deploy ./dist

Replace ./dist if your build tool writes static files somewhere else.

On the first deployment, the CLI asks you to select an existing project or create one. If your account has no projects, it creates one with a generated name.

Project links

The first deployment writes the selected project to .orbitpush/project.json. Commit this file so every checkout deploys to the same OrbitPush project.

Later deployments reuse the link without asking you to choose a project. If the linked project is unavailable, update the link explicitly before deploying again.

Non-interactive deployment

Use --yes when a terminal cannot answer prompts:

npx -y @orbitpush/cli@latest deploy ./dist --yes

A valid project link still takes precedence. Without one, the CLI creates and links a project with a generated name.

For automated deployments to an existing project, use a project-scoped deploy token instead. See GitHub Actions.

Command reference

Command	Purpose
`npx -y @orbitpush/cli@latest login`	Authorize the CLI with your OrbitPush account.
`npx -y @orbitpush/cli@latest logout`	Revoke and remove the stored login.
`npx -y @orbitpush/cli@latest deploy <path>`	Deploy a static directory or ZIP archive.
`npx -y @orbitpush/cli@latest --version`	Print the CLI version.

Deploy options

Option	Purpose
`-y`, `--yes`	Create and link a generated project without prompting.
`--token <token>`	Authenticate with a project-scoped deploy token. Prefer the `ORBITPUSH_DEPLOY_TOKEN` environment variable so the token does not enter shell history.