Skip to content

Commit

Permalink
docs: reference homebrew for installation
Browse files Browse the repository at this point in the history
  • Loading branch information
dschofie committed Apr 19, 2024
1 parent 34321f8 commit d2b5697
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,17 @@ Automation and Compliance are key concerns when adopting a multi-account AWS set
Currently, Telophase is a CLI tool only. In the future, we plan to offer a web UI.

## Install
### Go
Go is the only supported installation method. If you'd like another method, please let us know by opening an issue!
```
go install github.com/santiago-labs/telophasecli@latest
```


### Homebrew
```
brew tap Santiago-Labs/telophasecli
brew install telophasecli
```

## Quick links

Expand Down
7 changes: 7 additions & 0 deletions mintlifydocs/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,18 @@ Automation and Compliance are key concerns when adopting multi-account AWS. Telo
Currently, Telophase is a CLI tool only. In the future, we plan to offer a web UI.

# Install
## Go
Go is the only supported installation method. If you'd like another method, please let us know by opening an issue!
```bash
go install github.com/santiago-labs/telophasecli@latest
```

## Homebrew
```
brew tap Santiago-Labs/telophasecli
brew install telophasecli
```

# Features
<CardGroup cols={2}>
<Card
Expand Down
7 changes: 7 additions & 0 deletions mintlifydocs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,17 @@ description: 'Start using telophasecli'
2. AWS CLI must be configured. See [Authentication](#authentication) below

### Installation
#### Go
```bash
go install github.com/santiago-labs/telophasecli@latest
```

#### Homebrew
```
brew tap Santiago-Labs/telophasecli
brew install telophasecli
```

### Authentication
Note: Set `AWS_SDK_LOAD_CONFIG=1` when passing env variables directly e.g. `AWS_PROFILE=<profile_name> AWS_SDK_LOAD_CONFIG=1 telophasecli account import`

Expand Down

0 comments on commit d2b5697

Please sign in to comment.