Skip to content

Commit

Permalink
docs: improving the installation docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ekristen committed Oct 2, 2024
1 parent 5e33e89 commit 073197f
Showing 1 changed file with 26 additions and 9 deletions.
35 changes: 26 additions & 9 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,45 @@
# Install

## Install the pre-compiled binary
Preferred installation order is the following:

### Homebrew Tap (MacOS/Linux)
1. [GitHub Release](#github-releases-preferred)
2. [ekristen's homebrew tap](#ekristens-homebrew-tap-macoslinux)
3. [Homebrew Core](#homebrew-core-macoslinux)

Docker images are also available via the GitHub Container Registry.

## GitHub Releases (preferred)

!!! success - "Recommended"
This supports all operating systems and most architectures.

You can download pre-compiled binaries from the [releases](https://github.com/ekristen/aws-nuke/releases) page.

## ekristen's Homebrew Tap (MacOS/Linux)

!!! info
I control this tap, and it sources the binaries directly from the GitHub releases. However, it only supports MacOS.

```console
brew install ekristen/tap/aws-nuke
```

!!! warning "Brew Warning"
`brew install aws-nuke` will install the rebuy-aws version of aws-nuke, which is not the same as this version.

## Releases
## Homebrew Core (MacOS/Linux)

You can download pre-compiled binaries from the [releases](https://github.com/ekristen/aws-nuke/releases) page.
!!! note
I do not control the Homebrew Core formula, so it may not be up to date. Additionally, it is not compiled with
goreleaser, instead it is compiled with the Homebrew build system which does not build it in the same way, for
example it does not compile it statically.

```console
brew install aws-nuke
```
## Docker

Registries:

- [ghcr.io/ekristen/aws-nuke](https://github.com/ekristen/aws-nuke/pkgs/container/aws-nuke)

You can run **aws-nuke** with Docker by using a command like this:

## Source

To compile **aws-nuke** from source you need a working [Golang](https://golang.org/doc/install) development environment and [goreleaser](https://goreleaser.com/install/).
Expand Down

0 comments on commit 073197f

Please sign in to comment.