The Shipa Developer Hub

Welcome to the Shipa developer hub. You'll find comprehensive guides and documentation to help you start working with Shipa as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Changelog

Quickstart

Welcome to the Shipa quickstart.

In this guide, we’ll walk you through three major topics. We'll install the CLI and explore how to set up Setup Self-Managed Shipa or Setup Shipa Cloud version of Shipa. Then we’ll walk through some of the commonly used features of Shipa targeted towards developers. Finally, we'll see some of the operations platform teams can perform.

Install the Shipa CLI

If this is your first time using Shipa, you might need to download the shipa command-line interface (CLI) onto your local machine.

📘

The CLI is highly recommended, but not mandatory if you are planning to use Shipa only from the Web UI.

The command that installs the CLI depends on the choice of whether you would like to run Shipa yourself (self-managed) or to use the Cloud version.

❗️

If you are a Windows user, please run the command that follows from Windows Subsystem for Linux (WSL) or from a Bash terminal like, for example, Git Bash.

curl -s https://storage.googleapis.com/shipa-client/install.sh | bash
curl -s https://storage.googleapis.com/shipa-client/install-cloud-cli.sh | bash

Updated 4 months ago


What's Next

Now we are ready to install Shipa inside an existing cluster or register for Shipa Cloud. Please choose one of those.

Setup Self-Managed Shipa
Setup Shipa Cloud

Quickstart


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.