Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme links #5

Merged
merged 2 commits into from
Sep 14, 2022
Merged

Readme links #5

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
94a7000
Added links to the readme
rtfee Sep 14, 2022
5e3a599
Update README.md
rtfee Sep 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

## Beta Software
Please note that this is currently beta software and might not work as expected at all times. No guarantees are given. Use at your own risk.
If you find something that is broken, please run it again with the "-verbose" flag and post the output as an issue.
If you find something that is broken, please run it again with the "-verbose" flag and post the output as an [issue](https://github.com/Scalr/scalr-cli/issues).

## Installation

Installing the Scalr cli tool is very straightforward as it's distributed as a single static binary. Simply download the zipped binary from the releases section that corresponds to your architecture and (preferably) unpack it somewhere in your PATH.
Installing the Scalr cli tool is very straightforward as it's distributed as a single static binary. Simply download the zipped binary from the [releases](https://github.com/Scalr/scalr-cli/releases) section that corresponds to your architecture and (preferably) unpack it somewhere in your PATH.

## Basic usage
```
Expand Down Expand Up @@ -35,7 +35,7 @@ Options:
```

## Configure:
Before the CLI can be used, you will need to configure what Scalr URL and Token to use.
Before the CLI can be used, you will need to configure what Scalr URL and [Token](https://docs.scalr.com/en/latest/api/index.html#scalr-api) to use.
This can be done using environment variables (SCALR_HOSTNAME and SCALR_TOKEN) or a configuration file.
Run the CLI with the -configure flag to run the configuration wizard.

Expand Down