-
Notifications
You must be signed in to change notification settings - Fork 39
Add INSTALLATION guide #37
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.
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
Merged
+57
−27
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| # Installation | ||
|
|
||
| ## macOS | ||
|
|
||
| The STACKIT CLI is available to download and install through the [Homebrew](https://brew.sh/) package manager. | ||
|
|
||
| 1. First, you need to register the [STACKIT tap](https://github.com/stackitcloud/homebrew-tap) via: | ||
|
|
||
| ```shell | ||
| brew tap stackitcloud/tap | ||
| ``` | ||
|
|
||
| 2. You can then install the CLI via: | ||
|
|
||
| ```shell | ||
| brew install stackit-cli | ||
| ``` | ||
|
|
||
| ## Linux | ||
|
|
||
| We will soon distribute the STACKIT CLI via [Snap](https://snapcraft.io/). For the moment, you can either install via [Homebrew](https://brew.sh/) or refer to the [manual installation](#manual-installation) guide. | ||
|
|
||
| ## Windows | ||
|
|
||
| We will soon distribute the STACKIT CLI via [Chocolatey](https://chocolatey.org/). For the moment, please refer to the [manual installation](#manual-installation) guide. | ||
|
|
||
| ## Manual installation | ||
|
|
||
| Alternatively, you can get the STACKIT CLI by downloading a pre-compiled binary or compiling it from source. | ||
|
|
||
| ### Pre-compiled binary | ||
|
|
||
| 1. Download the binary corresponding to your operating system and CPU architecture from our [Releases](https://github.com/stackitcloud/stackit-cli/releases) page | ||
| 2. Extract the contents of the file to your file system and move it to your preferred location (e.g. your home directory) | ||
| 3. (For macOS only) Right click on the executable, select "Open". You will see a dialog stating the identity of the developer cannot be confirmed. Click on "Open" to allow the app to run on your Mac. We soon plan to certificate the STACKIT CLI to be trusted by macOS | ||
|
|
||
| ### Compile from source | ||
|
|
||
| 1. Clone the repository | ||
| 2. Build the application locally by running: | ||
|
|
||
| ```bash | ||
| $ make build | ||
| ``` | ||
|
|
||
| To use the application from the root of the repository, you can run: | ||
|
|
||
| ```bash | ||
| $ ./bin/stackit <GROUP> <SUB-GROUP> <COMMAND> <ARGUMENT> <FLAGS> | ||
| ``` | ||
|
|
||
| 3. Skip building and run the Go application directly using: | ||
|
|
||
| ```bash | ||
| $ go run . <GROUP> <SUB-GROUP> <COMMAND> <ARGUMENT> <FLAGS> | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.