Installation

Choose the command for your operating system and CPU architecture. Every command below downloads the latest QuickDeploy release from quickdeploy.dev.

After Purchase: Start Here

Already have a license? Complete these steps in order so the local CLI, server, activation, and application are each verified before the first deployment:

1. Choose your local platform, install the matching CLI, and run quickdeploy --version.
2. Complete the server preflight check with the same SSH user you will give QuickDeploy.
3. Configure and activate QuickDeploy with the checkout email address or license key from your purchase email.
4. Open the source project root and deploy your first app.
5. Open the deployed URL and verify an application route that exercises important behavior.

If the purchase email has not arrived, choose the checkout-email option during configuration. If SSH or license validation fails, use the targeted recovery commands before repeating the full setup.

Verify Before You Buy

You can install QuickDeploy and run quickdeploy --version before purchasing. Downloading the CLI and checking its version does not configure a server or deploy an application. A license is required to complete quickdeploy configure and use the deployment commands.

Review the server, local, application, and domain requirements, then use the matching installation instructions below to verify that the CLI runs on your platform.

Choose Your Platform

Select your local operating system. Each path ends with the same license-free version check.

What A Successful Check Looks Like

Every installation path finishes with:

quickdeploy --version

Linux

Check your CPU architecture:

uname -m

Use the x86_64 download when the command returns x86_64:

curl --fail --location --output quickdeploy https://quickdeploy.dev/api/download/linux-amd64

Use the ARM64 download when it returns aarch64 or arm64:

curl --fail --location --output quickdeploy https://quickdeploy.dev/api/download/linux-arm64

Install the downloaded binary, remove the temporary copy, and verify it:

sudo install -m 0755 quickdeploy /usr/local/bin/quickdeploy
rm quickdeploy
quickdeploy --version

macOS

Recommended (homebrew)

1. Add the tap to your homebrew:

brew tap programonaut/quickdeploy

2. Install the binary:

brew install quickdeploy

3. Run quickdeploy --version to verify the installed release

4. To update the binary run:

brew update
brew upgrade quickdeploy

Manual

Check your Mac architecture:

uname -m

Use the Intel download when the command returns x86_64:

curl --fail --location --output quickdeploy https://quickdeploy.dev/api/download/darwin-amd64

Use the Apple Silicon download when it returns arm64:

curl --fail --location --output quickdeploy https://quickdeploy.dev/api/download/darwin-arm64

Install the downloaded binary, remove the temporary copy, and verify it:

sudo mkdir -p /usr/local/bin
sudo install -m 0755 quickdeploy /usr/local/bin/quickdeploy
rm quickdeploy
quickdeploy --version

Windows (CMD)

1. Download the Windows executable:

curl.exe --fail --location --output quickdeploy.exe https://quickdeploy.dev/api/download/windows-amd64

2. Create a bin directory if needed and move the executable there:

if not exist "%USERPROFILE%\bin" mkdir "%USERPROFILE%\bin"
move /Y quickdeploy.exe "%USERPROFILE%\bin\quickdeploy.exe"

3. Add the directory to your PATH (if not already added)
   You can do this by pressing the Windows key and typing "env" and then clicking on "Edit the system environment variables".
4. Open a new terminal and verify the installation:

quickdeploy --version

Important Notes

On Windows and macOS you might need to allow the binary to run or add an exception in your security settings.

• Windows: Allowing blocked executables
• macOS: Allowing blocked executables

Configure And Activate QuickDeploy

Before starting, have these details ready:

• Your server's IP address and SSH username.
• A working private key in ~/.ssh, or a key loaded in your SSH agent.
• The email address used at checkout or the license key from your QuickDeploy email.

First, complete the server preflight check. It verifies that the same SSH user can connect and run Docker Compose without an interactive sudo prompt.

Then run:

quickdeploy configure

The setup flow:

1. Asks for the server IP address and SSH username.
2. Detects private keys in ~/.ssh. If it finds several, it asks you to choose one; if it finds none, it uses your SSH agent.
3. Tests the SSH connection.
4. Asks for the purchase email address or license key and validates the license.
5. Saves the configuration to ~/.quickdeploy/config.json.

When the full flow finishes, it prints Configuration saved successfully!.

If a setup check fails

An SSH test failure does not stop configuration. Do not deploy until you can connect to the server over SSH. Fix the server access, verify it directly, and then retest QuickDeploy:

ssh your-user@your-server-ip
quickdeploy configure --ssh

If license validation fails after the server details were saved, retry only activation:

quickdeploy configure --license

Both recovery commands use the server configuration already saved on your computer. Running quickdeploy configure again starts the full flow and asks before overwriting an existing configuration.

If the license email is delayed, you can still choose the purchase-email option. If neither the purchase email nor license key validates, contact max@quickdeploy.dev with the email used at checkout.

If you do not have a license yet, you can get a QuickDeploy license.

Deploy Your First App

After configuration reports success and the SSH connection works, open the source project root. Make sure the application has a production start command and listens on 0.0.0.0.

Deploy with the default internal application port, 8080:

quickdeploy push --domain example.com

If the application listens on another port, pass it explicitly:

quickdeploy push --domain example.com --port 3000

Replace example.com with a domain whose A record points to your server. QuickDeploy rebuilds the application from source on the VPS, so run the command from the project root rather than a generated dist, build, or .next directory.

See the requirements before deploying and the first-push command reference for environment variables, failure recovery, databases, project names, and background deployments.