carbon-node

A lightweight carbon footprint calculator for Node.js applications. Estimate CO2 emissions from your app's runtime, get optimization suggestions, and generate reports for ESG compliance.

Installation

npm install carbon-node

Usage

As a Library

const { calculateFootprint, generateReport } = require('carbon-node');

async function example() {
  // Basic usage
  const result = await calculateFootprint({ duration: 1, cloud: 'aws' });
  console.log(`CO2: ${result.footprint} grams`);

  // Premium (requires license key)
  const premium = await calculateFootprint({ duration: 1, cloud: 'aws', licenseKey: 'your-key' });
  console.log('Optimizations:', premium.tips);

  // Generate report
  await generateReport({ duration: 1, cloud: 'aws' }, result.footprint, 'report.json');
}

example();

As a CLI

npx carbon-node --duration 2 --cloud aws --region us-east-1 --scope 2 --output report.json

With premium license key for optimizations:

npx carbon-node --duration 2 --cloud aws --licenseKey your-key

Options

• duration: Runtime in hours (required).
• cloud: Cloud provider (aws, azure, gcp, default).
• region: Cloud region (e.g., us-east-1, default: us-east-1).
• scope: Emission scope (1, 2, or 3, default: 1).
• customFactor: Custom emission factor in gCO2/kWh.
• licenseKey: Unlock premium features (optimizations).
• output: Path for report file (e.g., report.json).

Premium Features

Get advanced features like real-time carbon intensity data and optimization suggestions by purchasing a license key at Purchase License.

Setup for Real-Time Data

1. Get a free API key from Climatiq.
2. Set environment variable: export CLIMATIQ_API_KEY=your-api-key.

Support

File issues at GitHub Issues or contact [[email protected]].

License

MIT