Documentation

Install the CLI

Suggest Edits

The code is open source on GitHub.


Generic Install: Manual Download from GitHub Releases

Download the appropriate archive for your architecture on the releases page.

Then extract the archive, (optionally move the binary to a folder in PATH) and run the binary.


macOS: Installing with brew or the installer.sh script

brew install bunnyshell/tap/bunnyshell-cli

installer=$(curl --silent https://raw.githubusercontent.com/bunnyshell/cli/master/installer.sh) \
    && [ "33cdd268adb1e26511b0cc90c9f4bf017bb145041677ca52d23a0f93cd13bd58 *stdin" = "$(echo -n "${installer}" | openssl dgst -sha256 -r)" ] \
    && (
        sh -c "${installer}" || :
    ) \
    || echo "Checksum did not match $(echo -n "${installer}" | openssl dgst -sha256 -r)" \
;

installer=$(curl --silent https://raw.githubusercontent.com/bunnyshell/cli/master/installer.sh) \
    && [ "33cdd268adb1e26511b0cc90c9f4bf017bb145041677ca52d23a0f93cd13bd58 *stdin" = "$(echo -n "${installer}" | openssl dgst -sha256 -r)" ] \
    && (
        SUDO_INSTALL=true INSTALL_PATH=/usr/local/bin sh -c "${installer}" || :
    ) \
    || echo "Checksum did not match $(echo -n "${installer}" | openssl dgst -sha256 -r)" \
;

Linux, macOS with installer.sh script


installer=$(curl --silent https://raw.githubusercontent.com/bunnyshell/cli/master/installer.sh) \
    && [ "33cdd268adb1e26511b0cc90c9f4bf017bb145041677ca52d23a0f93cd13bd58 *stdin" = "$(echo -n "${installer}" | openssl dgst -sha256 -r)" ] \
    && (
        sh -c "${installer}" || :
    ) \
    || echo "Checksum did not match $(echo -n "${installer}" | openssl dgst -sha256 -r)" \
;

installer=$(curl --silent https://raw.githubusercontent.com/bunnyshell/cli/master/installer.sh) \
    && [ "33cdd268adb1e26511b0cc90c9f4bf017bb145041677ca52d23a0f93cd13bd58 *stdin" = "$(echo -n "${installer}" | openssl dgst -sha256 -r)" ] \
    && (
        SUDO_INSTALL=true INSTALL_PATH=/usr/local/bin sh -c "${installer}" || :
    ) \
    || echo "Checksum did not match $(echo -n "${installer}" | openssl dgst -sha256 -r)" \
;

Windows:


  1. Download the executable file from [[https://github.com/bunnyshell/cli/releases]]. You'll need to select the file suited to your architecture:
    • bns_[version]_Windows_x86_64.zip (64 bit Windows)
    • bns_[version]_Windows_arm64.zip (Windows for ARM)
    • bns_[version]_Windows_i386.zip (For 32 bit Windows)
  2. Extract the archive
  3. Place the bns.exe file in a location of your choice. (For example C:\Users\Username\bin - replace Username with your actual username)
  4. Add the location to your PATH using the command below. ( ReplaceC:\Users\Username\bin with the actual directory where you copied the bns binary):
setx PATH "%PATH%;C:\Users\Username\bin"


Installing in a Dockerfile 

If you need the CLI in your images, we recommend using the one from the official Docker Image.

COPY --from=bunnyshell/cli /usr/bin/bns /usr/bin/bns

 

Run in a Docker image

You can also choose to execute it using our provided Docker image:

docker run --volume ~/.bunnyshell:/root/.bunnyshell bunnyshell/cli environments list

👍

Next, see how to Authenticate in the CLI.

Updated 7 months ago