Skip to content
  • CLI
  • Overview

CLI

The Hop CLI allows you to manage and control every aspect of your Hop projects. It acts as a command-line replacement for the Hop Console with some extra features to support Hop deployments.

Install

Shell Script (Linux, macOS and FreeBSD)

curl -fsSL https://download.hop.sh/install | sh

Arch Linux

Use your favourite AUR helper to install the package:

# yay example
$ yay -S hop-cli

Windows

Install with the Hop Windows Installer 64bit or the Hop Windows Installer 32bit

Login

Once installed, you will be able to use the following command to authenticate the CLI with your Hop account. This will open a browser window to login.

hop auth login
💡

If you want to login to the Hop CLI in a headless environment (e.g. without a browser), then you can provide a Project Token or a PAT using the --token flag.

Projects

When first logging in, the CLI will execute commands against your default personal project.

Switching Projects

You can switch projects using the following command:

hop projects switch

This will bring up an interface that allows you to use arrow keys to select a project:


You can also use hop projects switch <namespace> to perform the switch directly.

Project override flag

You can specify --project on any Hop CLI command to override the currently selected project for the current command.

More

Use hop help to view a full list of command categories. You can also use hop <category> help for a list of commands within a category.

Last updated on October 14, 2022