blink-go-cli

command module
v0.3.23 Latest Latest
Warning

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

Go to latest
Published: Sep 19, 2022 License: MIT Imports: 6 Imported by: 0

README

GoReleaser Logo

Blink CLI


The Blink CLI helps you build and manage your Blink operations right from the terminal.

With the CLI, you can:

  • Create, retrieve, update, or delete API objects.
  • Run playbooks.

Installation

Blink CLI is available for macOS, Windows, and Linux for distros like Ubuntu, Debian, RedHat and CentOS.

macOS

Blink CLI is available on macOS via Homebrew:

brew tap blinkops/blink-go-cli https://github.com/blinkops/blink-go-cli
brew install blink

Linux (Under Development)

WIP

Windows (Under Development)

Blink CLI is available on Windows via the Scoop package manager: WIP

Docker (Under Development)

The CLI is also available as a Docker image: blinkops/blink-cli.

docker run --rm -it blinkops/blink-cli version

Without package managers (Under Development)

WIP

Init

To first initialize your credentials after installing run:

blink init

You will be prompted to add a hostname (will be https://app.blinkops.com by default unless Blink is run locally within the org) and an API-key

✔ Hostname: https://app.dev.blinkops.com
✔ Blink API Key (Obtain key by accessing https://app.dev.blinkops.com/api/v1/apikey in your browser)

If you wish to use a pre-defined configuration, you can specify a file path by setting the --config flag when running blink init Example:

blink init --config ./config.json

At a minimum you should set the following values in your config file.

{
  "hostname": "<blink-address>", 
  "blink-api-key": "<apikey>",
  "scheme": "https"
}

Usage

blink [command]

# Run `--help` for detailed information about CLI commands
blink [command] --help

Workspaces

By default, blink uses the workspace specified in your config file. If a workspace is not set in your config file, or you would like to use a different workspace than the one set, use the --workspace flag.

blink [command] --workspace my_workspace

Commands

The Blink CLI supports a broad range of commands. Below is some of the most used ones:

  • playbooks
  • runner-groups
  • connections

Feedback

Got feedback for us? Please don't hesitate to shoot us a message.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

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