https://github.com/ryanckulp/hatchbox_cli

Unofficial CLI for HatchBox.io
https://github.com/ryanckulp/hatchbox_cli

Last synced: 2 months ago
JSON representation

Unofficial CLI for HatchBox.io

• Host: GitHub
• URL: https://github.com/ryanckulp/hatchbox_cli
• Owner: ryanckulp
• Created: 2022-07-20T10:06:45.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-07-20T14:13:10.000Z (over 2 years ago)
• Last Synced: 2024-10-03T16:34:49.283Z (3 months ago)
• Language: Shell
• Size: 4.88 KB
• Stars: 13
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# HatchBox CLI

Unofficial bash script that makes SSH-ing into your server a bit easier. no user data is saved, this lives on your machine.

![hatchbox-cli](https://user-images.githubusercontent.com/3083888/179966310-38f22445-3fc2-4d0e-841b-5a905d7e0448.jpg)

## Usage

the CLI accepts 2 arguments, `app` (HatchBox project slug) and `command` (common server task).

```sh

hb [app] [command]

# examples

hb [app] console # run rails console for [app]

hb [app] logs # tail live logs for [app]

hb help # list available commands

```

## Installation

add the script to your environment and provide a HatchBox server IP.

**Mac**

```sh

# step 1 - append script to your bash profile

echo "$(curl https://raw.githubusercontent.com/ryanckulp/hatchbox_cli/master/script.sh)" >> ~/.bash_profile

# step 2 - modify script to point to your HatchBox server

vim ~/.bash_profile

# replace "xxx.xxx.xxx.xxx" inside hb() function with your HatchBox server IP (begin insert via 'i')

# save the file (press escape key, then hold down the shift key and press "zz")

# step 3 - refresh your PATH

source ~/.bash_profile

# you're done!

```

**Windows**

i don't know, [tell me how?](https://github.com/ryanckulp/hatchbox_cli/issues/new) :)