Skip to content

Latest commit

 

History

History
115 lines (72 loc) · 3.43 KB

ENABLEMENT.md

File metadata and controls

115 lines (72 loc) · 3.43 KB
Raw

Enablement Guide for Impact Framework (IF)

What is the Impact Framework?

The Impact Framework (IF) empowers you to calculate and understand the environmental impact of your software. It comes with a standard library of built-in plugins, referred to as builtins, and an Explorer for discovering and installing third-party plugins.

How to Use the Impact Framework?

Prerequisites

Before getting started, ensure you have the following:

  1. Node.js: Installed and configured.
  2. NPM: Comes with Node.js; ensure it’s updated.
  3. Access to Documentation: Familiarize yourself with the IF documentation.
  4. Basic YAML Knowledge: For creating and managing manifest files.

Steps to Enable the Impact Framework

Step 1: Installation

Install the latest version of IF globally using NPM:

npm install -g "@grnsft/if"

IF provides multiple command-line tools, with the primary tool being if-run.

Step 2: Working with Command-Line Tools

  1. if-run: Execute Manifest Files

    • Description: Executes manifest files to calculate impact.
    • Manifest File: A YAML file central to IF functionality. It contains configurations, application architecture, input data, and serves as a portable, shareable, human-readable document for audits.
    • Usage:
    if-run --manifest <path-to-your-manifest-file>

More about if-run here.

  1. if-env: Create Local Development Environments

    • Description: Sets up a local environment for running manifests.
    • Usage:
    mkdir my-manifest && cd my-manifest
if-env

Find details in the documentation.

  1. if-check: Verify Manifests

    • Description: Combines the functionalities of if-env and if-diff to verify manifest files with outputs and execution sections.
    • Usage:
    # Check a specific manifest file
if-check -m <path-to-your-manifest-file>

# Check all manifests in a directory
if-check -d /path-to-your-manifests

Explore more in the documentation.

  1. if-csv: Save Data to CSV

    • Description: Saves calculated impact data to a CSV file.
    • Usage:
    if-csv -m ./my-manifest.yml -p carbon

Read more in the documentation.

  1. if-diff: Compare Manifests or Outputs

    • Description: Compares two manifest or output files to identify differences.
    • Usage:
    if-diff <file1> <file2>

Details are available in the documentation.

Step 3: Explore Plugins

  • Built-In Plugins: Utilize IF’s built-ins for common environmental impact assessments.
  • Third-Party Plugins: Visit the Explorer to discover and install third-party plugins tailored to your needs.

Step 4: Help and Guidance

For assistance with any command, use the --help flag:

if-run --help

Additional Resources

Support

Join the IF Community for updates and discussions: