Skip to content

Commit

Permalink
Merge pull request #43 from Green-Software-Foundation/command-name
Browse files Browse the repository at this point in the history
Replace CLI command from `if` to `ie`
  • Loading branch information
narekhovhannisyan authored Mar 4, 2024
2 parents 60c528f + 18dc2a6 commit d4c11f4
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion src/lib/azure-importer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
4 changes: 2 additions & 2 deletions src/lib/boavizta/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
6 changes: 3 additions & 3 deletions src/lib/ccf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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`):
Expand Down
6 changes: 3 additions & 3 deletions src/lib/co2js/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).

Expand Down Expand Up @@ -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`):
Expand Down
4 changes: 2 additions & 2 deletions src/lib/teads-aws/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
4 changes: 2 additions & 2 deletions src/lib/teads-curve/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
4 changes: 2 additions & 2 deletions src/lib/watt-time/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit d4c11f4

Please sign in to comment.