← Back to docs

Zippy CLI

A command-line tool for Zippy. Instead of the SSH commands, you could use a simple `zippy` command with tab completion.

How does it work?

The Zippy CLI is a small wrapper around the SSH commands. Instead of typing out full SSH commands, you get a simple interface with shell autocompletion.

# Without the CLI:
$ ssh git@zippy.sh build acme/webapp
# With the CLI:
$ zippy build

Install

Download the binary for your operating system:

macOS

Choose the command for your machine:

# Apple Silicon (M1/M2/M3)
$ curl -fsSL https://storage.zippy.sh/zippy-darwin-arm64 -o /usr/local/bin/zippy && chmod +x /usr/local/bin/zippy
# Intel
$ curl -fsSL https://storage.zippy.sh/zippy-darwin-amd64 -o /usr/local/bin/zippy && chmod +x /usr/local/bin/zippy

Linux

# x86_64
$ curl -fsSL https://storage.zippy.sh/zippy-linux-amd64 -o /usr/local/bin/zippy && chmod +x /usr/local/bin/zippy

Windows

  1. Download zippy-windows-amd64.exe
  2. Create a folder for Zippy (e.g., C:\Users\YourUsername\AppData\Local\Programs\zippy)
  3. Move zippy.exe into that folder
  4. Add that folder to your PATH.

Verify the installation:

$ zippy

Note: The binary is installed to /usr/local/bin, which must be in your PATH. If the command isn't found after installing, check your shell profile (~/.bashrc, ~/.zshrc, etc.).

Usage

All Zippy SSH commands work with the CLI. Use tab completion to autocomplete project names and commands:

# Trigger a build
$ zippy build
# Rebuild with a fresh environment
$ zippy rebuild
# Get an interactive shell
$ zippy shell

Available Commands

For a complete reference of all commands, see the SSH Commands documentation. These all work with the CLI:

  • zippy build <project> [branch] — Run your build
  • zippy rebuild <project> [branch] — Rebuild with fresh environment
  • zippy shell <project> [branch] — Your build Shell