metalctl

metalctl is the command line client to access the metal-api.

Installation

Download locations:

Via pre-build package:

sudo curl -fsSL https://images.metal-pod.io/metalctl/metalctl -o /usr/local/bin/metalctl
sudo chmod +x /usr/local/bin/metalctl

Self-build:

make
sudo ln -sf $(pwd)/bin/metalctl /usr/local/bin/metalctl

Installation on Linux

sudo curl -fsSL https://images.metal-pod.io/metalctl/metalctl-linux-amd64 -o /usr/local/bin/metalctl
sudo chmod +x /usr/local/bin/metalctl

Installation on MacOS

sudo curl -fsSL https://images.metal-pod.io/metalctl/metalctl-darvin-amd64 -o /usr/local/bin/metalctl
sudo chmod +x /usr/local/bin/metalctl

Installation on Windows

curl -LO https://blobstore.fi-ts.io/cloud-native/metalctl/metalctl-windows-amd64
copy metalctl-windows-amd64 metalctl.exe

Configuration

Set up auto-completion for metalctl, e.g. add to your ~/.bashrc:

source <(metalctl completion bash)

Set up metalctl config, by first creating the config folder (mkdir -p ~/.metalctl), then set the metalctl URL within ~/.metalctl/config.yaml:

---
current: prod
contexts:
  prod:
    url: https://api.metal-stack.io/metal
    issuer_url: https://dex.metal-stack.io/dex
    client_id: metal_client
    client_secret: 456

Available commands

Full documentation is generated out of the cobra command implementation with:

metalctl markdown

generated markdown is here