Skip to content

Emporium CLI

The Emporium CLI provides a suite of tools to enhance interactions with Emporium instances and application lifecycle of Emporium Apps:

Emporium Setup

  • Emporium installation: Install Emporium on your Kubernetes cluster.
  • Cluster Status: View the status of your Emporium cluster.
  • Local Tools: Install necessary Kubernetes tools locally (kubectl, helm, git, etc.).

Emporium App Lifecycle Management

  • Check and Update Dependencies: Easily check and update dependencies. Can be integrated with build pipelines for automatic application updates.
  • Scaffold Apps: Assists in getting started with your custom Emporium applications.

Cluster Operations & Development

  • Catapult: Proxy services within the cluster.
  • Debug-Node: Launch a pod on a specified node with full access to host namespaces and filesystem.
  • Tunnel: Establish a network tunnel within the cluster (default: 10.0.0.0/8).

Installation

Linux, macOS & WSL

Install the CLI with the following command:

bash
curl https://cli.emporium.build/ | sh

Installation with homebrew and chocolatery is planned, but not yet available.

Windows

For most cases, using WSL2 is recommended.

To use with cmd, PowerShell, or the new Terminal, download the Windows native version:

Windows AMD64 Download

After downloading, add the installation directory to your PATH Environment variable for seamless integration.

All Versions