ecoinfra is a powerful tool that helps you predict, assess, and reduce the environmental impact of your cloud infrastructure. By analyzing Terraform plan outputs, you can harness predictive sustainability into your cloud operations.

Visit our website at Eco-Infra.com to learn more about how we're revolutionizing eco-friendly cloud computing.

🚀 Getting Started

To start using the ecoinfra tool, follow these simple steps:

Step 1: Download the Tool

1. Visit releases to download the ecoinfra tool for your supported operating system.
2. Once the download is complete, locate the downloaded file on your computer.

Step 2: Set up Your API Key

1. Open your web browser and go to Eco-Infra.com.
2. Log in to your Eco-Infra account or create one if you don't have an account already.
3. After logging in, navigate to your profile settings.
4. In your profile settings, look for the "API Key" section.
5. Click on "Create".
6. A unique API key will be generated for you. Copy this key to your clipboard.

Step 3: Run the Tool

Run the tool in a supported CI environment

GitHub Actions

  - name: Eco-Infra
    uses: ecoinfra/[email protected]
    with:
    token: 'TOKEN'
    project-name: 'my-project'
    file: './terraform/state.json'

Run the tool from your command line interface (CLI) or terminal.

$ ecoinfra-PLATFORM --token {{Token}} --project-name {{Unique Project Name}} --file {{Plan JSON File}}

Example:

# Generate the Terraform JSON file
$ terraform plan -out=plan.out
# get the plan json
$ terraform show -json plan.out > plan.json
# or state json
$ terraform show -json terraform.tftate > state.json

# Analyze plan with ecoinfra
$ ecoinfra-PLATFORM --token c3dc55b6-78a0-43ad-2513-a751e76553de --project-name "Production Account" --file plan.json

# Analyze state with ecoinfra
$ ecoinfra-PLATFORM --token c3dc55b6-78a0-43ad-2513-a751e76553de --project-name "Production Account" --file state.json

---

📖 Documentation

Required Parameters

• --token - Your unique API key.
• --project-name - A unique name for your project.
• -fill - Path to the Terraform plan JSON file.

Optional Parameters

• --breakdown - Show detailed resource breakdown.

Generating the Plan File

Generate the plan file using Terraform:

terraform plan -out=plan.out
terraform show -json plan.out > plan.json

Supported Providers

• AWS 🟢
• Azure 🔴
• GCP 🔴

Supported IaC Tools

• Terraform 🟢
• OpenTofu 🔴
• Pulumi 🔴
• CloudFormation 🔴

---

Running the tool from source

1. Clone the repository.
2. Install the dependencies.
3. Build the tool
4. Run the tool!

git clone [email protected]:eco-infra/ecoinfra.git
npm i
npm run package

# Generate the Terraform plan file
terraform plan -out=plan.out
terraform show -json plan.out > plan.json

# Run the tool
./build/ecoinfra-PLATFORM --token {{Token}} --project-name {{Unique Project Name}} -fill plan.json

Contributing

Please read the contribution guidelines before contributing to the project. CONTRIBUTING.md