Install Shipa Client [CLI]

Installation Options

You can download and/or upgrade the Shipa CLI by running a bash script or if leveraging a Mac, using Homebrew.


Shipa CLI Options

Please note that the Shipa CLI has different install instructions for Shipa Cloud and Self-Hosted Shipa.

Bash Script

curl -s | bash
curl -s | bash

The command above will install the Shipa CLI in your /usr/local/bin


Specific Version of the CLI

Can Pipe on a specific version e.g

curl -s | VERSION=v1.7.7 bash


brew tap shipa-corp/cli

brew install shipa-cli
brew tap shipa-corp/cli

brew install shipa-cloud-cli

Add Cluster and Login with CLI

Add Shipa API target using current kubernetes context and sets it as current target.

shipa target add shipa -s -c

shipa login
shipa target add shipa-cloud --set-current

shipa login
  • -c, --from-current-context: Use current kubernetes context to determine Shipa API address
  • -s, --set-current: Set newly added shipa target as current


Shipa OAuth/SSO CLI Authentication

If using Shipa Cloud, you could register with one of several OAuth/SSO providers. To wire the CLI to SSO, head to Shipa Cloud -> Settings -> General then your token for Single Sign On CLI shipa sso login <token>

Get Dashboard UI from CLI - Self-Managed

Once authenticated to the CLI for Self-Managed, you can use the Shipa App List Command to get the dashboard address and head to that address for the UI.

shipa app list

| Application | Status    | Shipa Managed | Address                                                    |
| dashboard   | 1 running | true          | http://dashboard.                                        ↡ |
|             |           |               |↡ |
|             |           |               |                             |


Other Ingress Choices

Shipa Self-Managed can be installed via LoadBalancer, NodePort, or ClusterIP. Can check out the Shipa Ingress Choices documentation on how to get access to the Dashboard in these cases.

Enabling CLI Tab Autocompletion

As of CLI Version 1.7.0, you can now enable Tab Autocompletion. Install to at least CLI version 1.7.0 then run the help completion command to enable in your terminal profile.

shipa help completion

To load completions:
  $ source <(shipa completion bash)
  # To load completions for each session, execute once:
  # Linux:
  $ shipa completion bash > /etc/bash_completion.d/shipa
  # macOS:
  $ shipa completion bash > /usr/local/etc/bash_completion.d/shipa
  # If shell completion is not already enabled in your environment,
  # you will need to enable it.  You can execute the following once:
  $ echo "autoload -U compinit; compinit" >> ~/.zshrc
  # To load completions for each session, execute once:
  $ shipa completion zsh > "${fpath[1]}/_shipa"
  # You will need to start a new shell for this setup to take effect.
  $ shipa completion fish | source
  # To load completions for each session, execute once:
  $ shipa completion fish > ~/.config/fish/completions/
  PS> shipa completion powershell | Out-String | Invoke-Expression
  # To load completions for every new session, run:
  PS> shipa completion powershell > shipa.ps1
  # and source this file from your PowerShell profile.

Self-Managed CLI Compatibility Matrix

The CLI will iterate usually faster than the versions of released Shipa Self Managed.

Self-Managed CLI VersionShipa 1.6.3Shipa 1.7.0Shipa 1.7.1

What’s Next

After downloading the Shipa client, add your Shipa instance as a target