cli

command module
v0.4.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 28, 2024 License: MIT Imports: 1 Imported by: 0

README

metal-stack-cloud cli

Markdown Docs

This is the official CLI for accessing the API of metalstack.cloud.

To work with this CLI, it is first necessary to create an api-token. This can be issued through the cloud console.

Once you got the token, you probably want to create a CLI context. The project's ID can be copied from the UI, the button is located right next to the project title in the project dashboard.

$ metal ctx add devel --activate --default-project <project-uuid> --api-token <your-token>
✔ added context "devel"

The configuration file is by default written to ~/.metal-stack-cloud/config.yaml.

The generated markdown documentation of all the commands can be found here.

Installation

Download locations:

Installation on Linux
curl -LO https://github.com/metal-stack-cloud/cli/releases/latest/download/metal-linux-amd64
chmod +x metal-linux-amd64
sudo mv metal-linux-amd64 /usr/local/bin/metal
Installation on MacOS

For x86 based Macs:

curl -LO https://github.com/metal-stack-cloud/cli/releases/latest/download/metal-darwin-amd64
chmod +x metal-darwin-amd64
sudo mv metal-darwin-amd64 /usr/local/bin/metal

For Apple Silicon (M1) based Macs:

curl -LO https://github.com/metal-stack-cloud/cli/releases/latest/download/metal-darwin-arm64
chmod +x metal-darwin-arm64
sudo mv metal-darwin-arm64 /usr/local/bin/metal
Installation on Windows
curl -LO https://github.com/metal-stack-cloud/cli/releases/latest/download/metal-windows-amd64
copy metal-windows-amd64 metal.exe

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL