New:Microsoft Teams Notifications Are Now Available in Socket.Learn more →

Get Started

previewdrop

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

previewdrop

CLI for PreviewDrop — live preview environments for every branch. Any Dockerfile, any stack.

Source

npm

Version: 0.1.4

Version published: 5 months ago

Weekly downloads: 388

Maintainers: 1

Weekly downloads

Created: 5 months ago

Source

PreviewDrop CLI

Deploy and manage instant PR preview environments from the command line.

Installation

# Install globally
npm install -g previewdrop

# Or run without installing
npx previewdrop <command>

Requires Node.js 18+

Quick Start

# 1. Authenticate
npx previewdrop login

# 2. Deploy a branch
npx previewdrop deploy <project-uuid> --branch feature/new-ui --wait

# 3. Check status
npx previewdrop status a1b2c3d4-e5f6-7890-abcd-ef1234567890

Authentication

previewdrop login [options]

Opens your browser to generate an API key. Paste it when prompted — stored locally for all subsequent commands.

-k, --key <api-key> — Provide an API key directly (skips browser flow)
-H, --host <url> — Override the API host (default: https://previewdrop.dev)

# Interactive
previewdrop login

# Non-interactive (CI)
previewdrop login --key pd_live_abc123

Commands

`deploy`

Trigger a new preview deployment.

previewdrop deploy <project-id> [options]

-b, --branch <branch> — Branch to deploy (default: project's default branch)
--wait — Wait until deployment is ready or failed before exiting

previewdrop deploy <project-uuid>
previewdrop deploy <project-uuid> --branch feature/new-ui
previewdrop deploy <project-uuid> --branch fix/bug-123 --wait

`status`

Show the status of a deployment.

previewdrop status <deployment-id> [options]

--watch — Poll until a terminal state is reached

Possible statuses: queued · building · deploying · ready · failed · stopped · expired

previewdrop status a1b2c3d4-e5f6-7890-abcd-ef1234567890
previewdrop status a1b2c3d4-e5f6-7890-abcd-ef1234567890 --watch

`destroy`

Stop and permanently remove a deployment.

previewdrop destroy <deployment-id> [options]

-y, --yes — Skip the confirmation prompt

previewdrop destroy a1b2c3d4-e5f6-7890-abcd-ef1234567890
previewdrop destroy a1b2c3d4-e5f6-7890-abcd-ef1234567890 --yes

`list`

# List all projects
previewdrop list projects

# List deployments for a project
previewdrop list deployments <project-id> [--limit <n>]

-n, --limit <n> — Number of deployments to show (default: 10)

CI / CD

# Authenticate once with a secret token
previewdrop login --key $PREVIEWDROP_API_KEY

# Deploy and block until done (exit 0 = ready, 1 = failed/stopped/expired)
previewdrop deploy $PROJECT_ID --branch $BRANCH_NAME --wait