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

docs: clarify get started steps #13

Merged
merged 2 commits into from
Jul 4, 2022
Merged

docs: clarify get started steps #13

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef53dbf
docs: clarify get started steps
alikhajeh1 Jul 4, 2022
f6d96ad
Update README.md
alikhajeh1 Jul 4, 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
20 changes: 17 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,24 @@ Check out the video below to see the Infracost extension in action!

## Getting started

1. Install [Infracost CLI](https://www.infracost.io/docs/#1-install-infracost) on your machine & register for an API key.
2. Open VSCode and install the [Infracost extension](https://marketplace.visualstudio.com/items?itemName=Infracost.infracost). This will also install the the [Hashicorp Terraform extension](https://marketplace.visualstudio.com/items?itemName=HashiCorp.terraform) extension if you don't already have it.
### 1. Install Infracost CLI

Follow [this step](https://www.infracost.io/docs/#1-install-infracost) to install the Infracost CLI, which is used by this VSCode extension.

### 2. Get API key
alikhajeh1 marked this conversation as resolved.
Show resolved Hide resolved

Follow [this step](https://www.infracost.io/docs/#2-get-api-key) to get a free API key that's used by the CLI to get prices from our Cloud Pricing API.

### 3. Install VSCode extension

Open VSCode and install the [Infracost extension](https://marketplace.visualstudio.com/items?itemName=Infracost.infracost).

This will also install the the [Hashicorp Terraform extension](https://marketplace.visualstudio.com/items?itemName=HashiCorp.terraform) extension if you don't already have it.
![](https://github.com/infracost/vscode-infracost/blob/master/.github/assets/infracost-install.png?raw=true)
3. Navigate to any Terraform file, if you've done the prior steps correctly you'll see costs above [supported blocks](https://www.infracost.io/docs/supported_resources/overview/).

### 4. Use extension

Navigate to any Terraform file, if you've done the prior steps correctly you'll see costs above [supported blocks](https://www.infracost.io/docs/supported_resources/overview/).
![](https://github.com/infracost/vscode-infracost/blob/master/.github/assets/maintf.png?raw=true)

## Requirements
Expand Down