Skip to content

Commit

Permalink
Update install section in docs (#24)
Browse files Browse the repository at this point in the history
  • Loading branch information
najose authored Sep 15, 2023
1 parent ecb66a6 commit e1a1a41
Showing 1 changed file with 22 additions and 26 deletions.
48 changes: 22 additions & 26 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,37 +17,18 @@ See [**official Terraform documentation**](https://developer.hashicorp.com/terra

!!! info "Install"

=== "Build From Source"

```shell
# Clone the repo
$ git clone [email protected]:schrodinger/infra-tester.git

# Build the executable
$ go build -o bin/infra-tester

# Move the binary to a directory in the $PATH
$ sudo mv infra-tester /usr/local/bin
```

=== "Install Latest Linux Release"

=== "Install using Go"
```shell
# Download the latest release binary
$ curl -L https://github.com/schrodinger/infra-tester/releases/latest/download/infra-tester-linux-x86_64 -o infra-tester

# Make it executable
$ chmod +x infra-tester

# Move it to a directory in the $PATH
$ sudo mv infra_tester /usr/local/bin
go install github.com/schrodinger/infra-tester@latest
```

=== "Install Latest MacOS Release"
=== "Install from GitHub Release - Linux and MacOS"

```shell
PLATFORM=linux
PLATFORM=macos
# Download the latest release binary
$ curl -L https://github.com/schrodinger/infra-tester/releases/latest/download/infra-tester-macos-x86_64 -o infra-tester
$ curl -L https://github.com/schrodinger/infra-tester/releases/latest/download/infra-tester-${PLATFORM}-x86_64 -o infra-tester

# Make it executable
$ chmod +x infra-tester
Expand All @@ -56,7 +37,7 @@ See [**official Terraform documentation**](https://developer.hashicorp.com/terra
$ sudo mv infra-tester /usr/local/bin
```

=== "Install Latest Windows Release"
=== "Install from GitHub Release - Windows"

1. Download the latest Windows release binary from the below URL:
```
Expand All @@ -65,6 +46,21 @@ See [**official Terraform documentation**](https://developer.hashicorp.com/terra

2. Move it to a directory under `PATH`, or add the directory where you'd like to keep the executable to `PATH`.

=== "Build From Source"

```shell
# Clone the repo
$ git clone [email protected]:schrodinger/infra-tester.git

# Build the executable and move the binary to a directory in the $PATH
$ cd infra-tester && go build -o bin/infra-tester
$ sudo mv infra-tester /usr/local/bin

# OR you may run go install
$ go install

```

#### Writing Your First *infra-tester* Test Configuration

The [Writing a Test From Scratch](./writing_tests.md) page provides a simple hands-on
Expand Down

0 comments on commit e1a1a41

Please sign in to comment.