feat: update cli and docs

Author: iamdavidmt

README.md

@@ -1,8 +1,8 @@
 ![Eco-Infra Logo](./logo.svg)
 
-**ecoinfra** is a powerful tool that helps you predict, asses, and reduce the environmental impact of your cloud
+**ecoinfra** is a powerful tool that helps you predict, assess, and reduce the environmental impact of your cloud
 infrastructure.
-By integrating your existing or new IaC project you can harness predictive sustainability into your cloud operations.
+By analyzing Terraform plan outputs, you can harness predictive sustainability into your cloud operations.
 
 Visit our website at [**Eco-Infra.com**](https://eco-infra.com) to learn more about how we're revolutionizing
 eco-friendly cloud computing.
@@ -29,38 +29,52 @@ To start using the **ecoinfra** tool, follow these simple steps:
 ### Step 3: Run the Tool
 Run the tool in a supported CI environment
 
-[GitHub Actions](https://github.com/marketplace/actions/eco-infra-action) 
+[GitHub Actions](https://github.com/marketplace/actions/eco-infra-action)
 ```yaml
   - name: Eco-Infra
     uses: ecoinfra/ecoinfra-action@v1.1.2
     with:
     token: 'TOKEN'
     project-name: 'my-project'
-    path: './terraform'
-    apply: 'true'
+    plan-file: './terraform'
 ```
 
-Or Run the tool from your command line interface (CLI) or terminal.
+Run the tool from your command line interface (CLI) or terminal.
 
 ```bash
-$ ecoinfra-PLATFORM --token {{Token}} --project-name {{Unique Project Name}} {{Project Directory}}
+$ ecoinfra-PLATFORM --token {{Token}} --project-name {{Unique Project Name}} --plan-file {{Plan JSON File}}
 ```
 
-An example:
+Example:
 
 ```bash
-$ ecoinfra-PLATFORM --token c3da55b6-b8a0-43ad-b513-a751e76553de --project-name "Production Account" ./prod
+# Generate the Terraform plan JSON file
+$ terraform plan -out=plan.out
+$ terraform show -json plan.out > plan.json
+
+# Analyze with ecoinfra
+$ ecoinfra-PLATFORM --token c3dc55b6-78a0-43ad-2513-a751e76553de --project-name "Production Account" --plan-file plan.json
 ```
 ---
 ## 📖 Documentation
 
-The tool requires two arguments and a path to your IaC project (Where you run terraform form):
+### Required Parameters
 
 - `--token` - Your unique API key.
 - `--project-name` - A unique name for your project.
-- `{{Project Directory}}` - The directory of your IaC project.
+- `--plan-file` - Path to the Terraform plan JSON file.
+
+### Optional Parameters
+
+- `--breakdown` - Show detailed resource breakdown.
+
+### Generating the Plan File
 
-You will be required you to run terraform init before running the tool.
+Generate the plan file using Terraform:
+```bash
+terraform plan -out=plan.out
+terraform show -json plan.out > plan.json
+```
 
 ## Supported Providers
 
@@ -82,11 +96,17 @@ You will be required you to run terraform init before running the tool.
 4. Run the tool!
 
 ```bash
-git clone git@github.com:eco-infra/ecoinfra.git 
+git clone git@github.com:eco-infra/ecoinfra.git
 npm i
 npm run package
-./build/ecoinfra-PLATFORM --token {{Token}} --project-name {{Unique Project Name}} {{Project Directory}}
+
+# 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}} --plan-file plan.json
 ```
 
 # Contributing
-Please read the contribution guidelines before contributing to the project. [CONTRIBUTING.md](./CONTRIBUTING.md)
+Please read the contribution guidelines before contributing to the project. [CONTRIBUTING.md](./CONTRIBUTING.md)

app/cli/main.cli.ts

@@ -3,56 +3,42 @@ import arg from 'arg';
 export default class MainCli {
   private token: string;
 
-  private breakdown: boolean
-
-  private apply: boolean
-
-  private _project: string;
+  private breakdown: boolean;
 
   private projectName: string;
 
-  public args: arg.Result<any>
+  private planFile: string;
 
-  constructor(argResults: arg.Result<any>, project?: string) {
-    this.args = argResults
+  public args: arg.Result<any>;
 
-    if (!this.args['--token']) throw new Error('Specify token --token')
+  constructor(argResults: arg.Result<any>) {
+    this.args = argResults;
 
-    if (!this.args['--project-name']) throw new Error('Specify project name --project-name')
+    if (!this.args['--token']) throw new Error('Specify token --token');
 
-    this.token = this.args['--token']
-    this.breakdown = this.args['--breakdown'] ?? false
-    this.apply = this.args['--apply'] ?? false
-    this._project = this.setProjectPath(project)
-    this.projectName = this.args['--project-name']
-  }
+    if (!this.args['--project-name']) throw new Error('Specify project name --project-name');
 
-  /**
-     * @description Set the project path, making sure that the path ends with /
-     */
-  setProjectPath(path?: string) {
-    if (!path) return './'
+    if (!this.args['--plan-file']) throw new Error('Specify plan file --plan-file <path>');
 
-    return path.endsWith('/') ? path : path.concat('/')
-  }
-
-  get project(): string {
-    return this._project;
+    this.token = this.args['--token'];
+    this.breakdown = this.args['--breakdown'] ?? false;
+    this.planFile = this.args['--plan-file'];
+    this.projectName = this.args['--project-name'];
   }
 
   getToken(): string {
-    return this.token
+    return this.token;
   }
 
   getProjectName(): string {
-    return this.projectName
+    return this.projectName;
   }
 
-  getApply(): boolean {
-    return this.apply
+  getBreakdown(): boolean {
+    return this.breakdown;
   }
 
-  getBreakdown(): boolean {
-    return this.breakdown
+  getPlanFile(): string {
+    return this.planFile;
   }
 }