hopinc / cli

💻 Interact with Hop in your terminal

Hop CLI

The Hop CLI allows you to interface with Hop services through your command line. It can be used as a replacement for the Console.

Installation

Any of the following will make the hop command available to you.

Arch Linux

Use your favorite AUR helper to install the package (e.g. paru):

paru -S hop-cli

Windows

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

Homebrew

brew install hopinc/tap/hop

Linux, MacOS and FreeBSD

It can be installed with our universal install script:

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

Source

To build the application from the source code, you'll first need to install Rust. Then, once you've cloned the repository, you can execute this command within the directory:

cargo install --path .

Logging In

To get started, you need to log in to your Hop account through the CLI:

hop auth login

A browser window will open the Hop Console and prompt you to allow the CLI to connect to your account. Once done, you will be redirected back.

That's all! You can now start using the CLI.

Usage

Projects

You can set a default project to use which will automatically be applied to every command.

hop projects switch

You can override it by passing the --project argument. For example, hop deploy --project api.

Deploying

To deploy a project directory, first navigate to the directory through cd and then execute:

hop deploy

This will deploy the project to Hop, or create a new one if you don't have a Hopfile (hop.yml) already.

Linking

To link a project to a service, first navigate to the directory through cd and then execute:

hop link

This will link the directory to the deployment and create a Hopfile (hop.yml).

Contributing

Contributions are welcome! Please open an issue or pull request if you find any bugs or have any suggestions.

cli's Issues

`hop auth login` with `--token` option fails in newer versions

Hey there,

I'm current embedding the hop.io CLI within a Github Actions workflow. Installation works fine, but when I run the hop auth login command with the project token in the --token option, it gives me the following error for all newer versions.

When I try the exact same procedure with the version stated in the docs (v0.1.46) (https://docs.hop.io/cli/ci#example) it works fine.

Have you encountered this error already?

Installation script doesn't work

OS: WSL2 Ubuntu
Shell: zsh

Error:

sh: 4: [: x1000: unexpected operator
sh: 21: [[: not found
sh: 21: [[: not found
sh: 21: [[: not found
sh: 25: [[: not found
sh: 25: [[: not found
sh: 25: [[: not found
sh: 29: [[: not found
sh: 29: [[: not found
sh: 29: [[: not found
sh: 37: [[: not found
sh: 41: HOP_VERSION: parameter not set

Fix error when trying to `hop deploy -y`

How to reproduce

1. Go to the project directory you want to deploy
2. Delete hop.yml if you have one
3. Run hop deploy -y
4. You might see this error:

> hop deploy -y    
info: Attempting to deploy ./yourprojectdir
info: No hopfile found, creating one
info: Deploying to project project_name  /project  project_id  date  regular
warn: Using default config, skipping arguments
error: body.restart_policy should be equal to one of the allowed values

Expected behavior
The restart policy on_failure should work fine by default and allowed

deploy multiple .env files

Add the possibility to put multiple .env files in the hop.yml config file ?

deploy with compose

Make the hop deploy command supporting docker-compose files (through the hop.yml config file for example) ?

Add Support For Termux

hop deploy -> Gateway Timeout

I've been using Hop CLI for my deployments but now I'm getting 504 on my terminal while the process gets successfully executed in the Hope servers

1. hop deploy
2. Hop says it is pending

3. CLI throws `error: HTTP 504: Gateway Timeout`

Happy to provide more details if needed 😄

Hop tunnel port arguments

This would be useful for things like run configurations to be able to just say hop fwd deployment -h 127.0.0.1 -p 5000 -r 5432 -p coolproject so I don't need to enter it everytime when I run my run configuration to forward to my DB.