README
¶
Reliably CLI
Installation • Documentation • ChangeLog • Credits •
What does Reliably do for you?
Here is a really quick recap of the main features that will help you bringing reliability to your daily activities:
- Populate objectives automatically from AWS, Google Cloud, Kubernetes, GitHub and more
- Run an agent that updates these objectives for you at regular interval
- Run verifications (via Chaos Engineering experiments) to explore conditions on your system
- Fetch the latest status for objectives and score-cards to bring reliability into your automation
- Manage your Reliably organisations
- Run from anywhere, including your CI/CD
Installation
Reliably CLI is available for macOS, Linux and Windows as downloadable binaries from the releases page.
Please see the documentation for further details.
Usage
Reliably is a CLI and runs from anywhere you can execute its binary. From your terminal or embedded into a CI/CD pipeline for instance.
$ reliably
The Reliably Command Line Interface (CLI).
Usage:
reliably [command]
Available Commands:
agent runs in agent mode sending SLIs to Reliably
auth Login, logout, and verify your authentication
completion Generate shell completion scripts
help Help about any command
org Manage your organizations
populate populate your reliably environment
status retrieve the status of score cards and objectives
update Updates Reliably CLI
verification verification root command
Flags:
--help help for reliably
--no-color Disable color output
-v, --verbose verbose output
--version version for reliably
-V, --very-verbose very verbose output
Use "reliably [command] --help" for more information about a command.
Environment variables:
See 'reliably environment --help' for the list of supported environment variables.
Feedback:
You can provide with feedback or report an issue at https://github.com/reliablyhq/cli/issues/new
Please follow the guidelines to walk you through Reliably's main features.
Credits
This repository contains code from the Reliably CLI project as well as some open-source works:
- GitHub CLI
- Secure Go gosec
- Christopher Thorpe nestedmaplookup.go
Documentation
¶
Overview ¶
Copyright © 2020 Reliably <oss@reliably.com>
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.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
reliably/populate/gcp
package gcp contains logic for gcp populate command
|
package gcp contains logic for gcp populate command |
|
reliably/populate/github
Package github contains logic for github populate command
|
Package github contains logic for github populate command |
|
reliably/populate/kube
Package kube contains logic for kube populate command
|
Package kube contains logic for kube populate command |
|
agent
Package agent contains code for pushing metric indicators to reliably entity api
|
Package agent contains code for pushing metric indicators to reliably entity api |
|
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
|
|
|
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. |