From 18dc2a608631433a3cac85afd232fa2a790bfba9 Mon Sep 17 00:00:00 2001 From: manushak Date: Mon, 4 Mar 2024 09:56:01 +0400 Subject: [PATCH] fix(lib): update CLI command from `if` to `ie` in all docs --- src/lib/azure-importer/README.md | 2 +- src/lib/boavizta/README.md | 4 ++-- src/lib/ccf/README.md | 6 +++--- src/lib/co2js/README.md | 6 +++--- src/lib/teads-aws/README.md | 4 ++-- src/lib/teads-curve/README.md | 4 ++-- src/lib/watt-time/README.md | 4 ++-- 7 files changed, 15 insertions(+), 15 deletions(-) diff --git a/src/lib/azure-importer/README.md b/src/lib/azure-importer/README.md index edbd797..72db6f6 100644 --- a/src/lib/azure-importer/README.md +++ b/src/lib/azure-importer/README.md @@ -152,7 +152,7 @@ You can run this example `manifest` by saving it as `./examples/manifests/test/a ```sh npm i -g @grnsft/if npm i -g @grnsft/if-unofficial-plugins -if --manifest ./examples/manifests/test/azure-importer.yml --output ./examples/outputs/azure-importer.yml +ie --manifest ./examples/manifests/test/azure-importer.yml --output ./examples/outputs/azure-importer.yml ``` The results will be saved to a new `yaml` file in `./examples/outputs`. diff --git a/src/lib/boavizta/README.md b/src/lib/boavizta/README.md index 9e1e76f..b3decca 100644 --- a/src/lib/boavizta/README.md +++ b/src/lib/boavizta/README.md @@ -108,10 +108,10 @@ tree: cpu/utilization: 16 ``` -You can run this by passing it to `if`. Run impact using the following command run from the project root: +You can run this by passing it to `ie`. Run impact using the following command run from the project root: ```sh npm i -g @grnsft/if npm i -g @grnsft/if-unofficial-plugins -if --manifest ./examples/manifests/test/boavizta.yml --output ./examples/outputs/boavizta.yml +ie --manifest ./examples/manifests/test/boavizta.yml --output ./examples/outputs/boavizta.yml ``` diff --git a/src/lib/ccf/README.md b/src/lib/ccf/README.md index e577958..cc59463 100644 --- a/src/lib/ccf/README.md +++ b/src/lib/ccf/README.md @@ -44,7 +44,7 @@ You can read a detailed explanation ofn the calculations in the [CCF docs](https ## Usage -In IF, the plugin is called from a `manifest`. A `manifest` is a `.yaml` file that contains configuration metadata and usage inputs. This is interpreted by the command line tool, `if`. The plugin input is expected to contain `duration`,`cpu/utilization`, `cloud/vendor` and `cloud/instance-type` fields. +In IF, the plugin is called from a `manifest`. A `manifest` is a `.yaml` file that contains configuration metadata and usage inputs. This is interpreted by the command line tool, `ie`. The plugin input is expected to contain `duration`,`cpu/utilization`, `cloud/vendor` and `cloud/instance-type` fields. You can see example Typescript invocations for each `cloud/vendor` below: @@ -125,13 +125,13 @@ tree: cpu/utilization: 10 ``` -This manifest is run using `if` using the following command, run from the project root: +You can run this by passing it to `ie`. Run impact using the following command run from the project root: ```sh npm i -g @grnsft/if npm i -g @grnsft/if-unofficial-plugins -if --manifest ./examples/manifests/test/ccf.yml --output ./examples/outputs/ccf.yml +ie --manifest ./examples/manifests/test/ccf.yml --output ./examples/outputs/ccf.yml ``` This yields a result that looks like the following (saved to `/outputs/ccf.yml`): diff --git a/src/lib/co2js/README.md b/src/lib/co2js/README.md index e9dc2ee..fc394d3 100644 --- a/src/lib/co2js/README.md +++ b/src/lib/co2js/README.md @@ -39,7 +39,7 @@ The CO2JS Framework is a community plugin, not part of the IF standard library. ## Usage -In IF the plugin is called from an `manifest`. An `manifest` is a `.yaml` file that contains configuration metadata and usage inputs. This is interpreted by the command line tool, `if`. +In IF the plugin is called from an `manifest`. An `manifest` is a `.yaml` file that contains configuration metadata and usage inputs. This is interpreted by the command line tool, `ie`. The plugin config should define a `type` supported by the CO2.JS library (either `swd` or `1byte`). These are different ways to calculate the operational carbon associated with a web application; `swd` is shorthand for 'sustainable web design' plugin and `1byte` refers to the OneByte mdoel. You can read about the details of these plugins and how they differ at the [Green Web Foundation website](https://developers.thegreenwebfoundation.org/co2js/explainer/methodologies-for-calculating-website-carbon/). @@ -82,12 +82,12 @@ tree: network/data/bytes: 1000000 ``` -This manifest is run using `if` using the following command, run from the project root: +You can run this by passing it to `ie`. Run impact using the following command run from the project root: ```sh npm i -g @grnsft/if npm i -g @grnsft/if-unofficial-plugins -if --manifest ./examples/manifests/test/co2js.yml --output ./examples/outputs/co2js.yml +ie --manifest ./examples/manifests/test/co2js.yml --output ./examples/outputs/co2js.yml ``` This yields a result that looks like the following (saved to `/outputs/co2js.yml`): diff --git a/src/lib/teads-aws/README.md b/src/lib/teads-aws/README.md index 9bcb2df..0c64a96 100644 --- a/src/lib/teads-aws/README.md +++ b/src/lib/teads-aws/README.md @@ -79,10 +79,10 @@ tree: cpu/utilization: 10 ``` -You can run this by passing it to `if`. Run impact using the following command run from the project root: +You can run this by passing it to `ie`. Run impact using the following command run from the project root: ```sh npm i -g @grnsft/if npm i -g @grnsft/if-unofficial-plugins -if --manifest ./examples/manifests/test/teads-aws.yml --output ./examples/outputs/teads-aws.yml +ie --manifest ./examples/manifests/test/teads-aws.yml --output ./examples/outputs/teads-aws.yml ``` diff --git a/src/lib/teads-curve/README.md b/src/lib/teads-curve/README.md index a0e3ed7..28b6a1b 100644 --- a/src/lib/teads-curve/README.md +++ b/src/lib/teads-curve/README.md @@ -105,10 +105,10 @@ tree: cpu/utilization: 50 ``` -You can run this by passing it to `if`. Run impact using the following command run from the project root: +You can run this by passing it to `ie`. Run impact using the following command run from the project root: ```sh npm i -g @grnsft/if npm i -g @grnsft/if-unofficial-plugins -if --manifest ./examples/manifests/test/teads-curve.yml --output ./examples/outputs/teads-curve.yml +ie --manifest ./examples/manifests/test/teads-curve.yml --output ./examples/outputs/teads-curve.yml ``` diff --git a/src/lib/watt-time/README.md b/src/lib/watt-time/README.md index f37a731..6403cab 100644 --- a/src/lib/watt-time/README.md +++ b/src/lib/watt-time/README.md @@ -104,12 +104,12 @@ tree: geolocation: 37.7749,-122.4194 ``` -You can run this by passing it to `if`. Run impact using the following command run from the project root: +You can run this by passing it to `ie`. Run impact using the following command run from the project root: ```sh npm i -g @grnsft/if npm i -g @grnsft/if-unofficial-plugins -if --manifest ./examples/manifests/test/watt-time.yml --output ./examples/outputs/watt-time.yml +ie --manifest ./examples/manifests/test/watt-time.yml --output ./examples/outputs/watt-time.yml ``` ## Position and effects in the manifest: