cli

command module
v0.8.0 Latest Latest
Warning

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

Go to latest
Published: Apr 6, 2021 License: Apache-2.0 Imports: 1 Imported by: 0

README

Reliably CLI

Reliably

Reliability toolbox for developers from the command line.

Installation

Reliably CLI is available for macOS, Linux and Windows as downloadable binaries from the releases page.

Installation as a Krew plugin

Reliably CLI can be used as a kubectl Krew plugin for macOS and Linux.

Once you have Krew installed, install Reliably with the following command.

$ kubectl krew install reliably

You can then use the CLI as a kubectl plugin:

$ kubectl reliably
Authentication

Run reliably auth login to authenticate with your Reliably account. This will run the interactive authentication flow by default.

You can also choose to login with an access token in a non-interactive mode: reliably auth login --with-token < my-access-token.txt

Finally, reliably will respect tokens set as environment variable using RELIABLY_TOKEN.

Usage

To check your Kubernetes manifests for Reliably Advice and Suggestions, simply run:

$ reliably scan

It will scan for manifests recursively in your current working directory.

To indicate a specific file or folder, give it as a command argument:

$ reliably scan manifest.yaml
$ reliably scan ./manifests

To run Reliably for suggestions against a Kubernetes cluster, run

$ reliably scan --live

You can also pipe into scan command, as it can read from stdin using '-' as argument:

$ cat manifest.yaml | reliably scan -

The CLI supports multiple output formats, such as simple (default), json, yaml, sarif, codeclimate. To report in a specific format, you can use the --format or -f flag, as follow:

$ reliably scan --format sarif

The CLI prints out the report to the standard output, by default, but it can write the report to a local file. You can indicate the path of the report with the --output or -o flag, as follow:

$ reliably scan --output ./report.txt

Please read the documentation for more information.

Credits

This repository contains code from the Reliably CLI project as well as some open-source works:

Documentation

Overview

Copyright © 2020 Reliably <[email protected]>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Directories

Path Synopsis
cmd
doc
kubernetes
package kubernetes is a colletion of funtions for interactng with a live kubernetes cluster
package kubernetes is a colletion of funtions for interactng with a live kubernetes cluster
debug
examples
Package scan contains implementation and logic for running scans using pre-defined policies against specified targets.
Package scan contains implementation and logic for running scans using pre-defined policies against specified targets.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
JackTT - Gopher 🇻🇳