JSPM

cardamon

1.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 3
  • Score
    100M100P100Q27245F
  • License SEE LICENSE

A CLI tool for measuring the carbon footprint and energy consumption of web pages using the Cardamon model

Package Exports

  • cardamon
  • cardamon/dist/cli.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (cardamon) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

🌱 Cardamon CLI

A simple command-line tool for measuring the carbon footprint and energy consumption of web pages during development.

Installation

npm install -g cardamon

Usage

Basic Usage

cardamon http://localhost:3000

With Custom Carbon Intensity

cardamon http://localhost:3000 --carbon-intensity 400

Options

  • <url> - URL to measure (required)
  • -c, --carbon-intensity <value> - Carbon intensity in g CO2/kWh (default: 494)

Development

# Install dependencies
npm install

# Run in development mode
npm run dev http://localhost:3000

# Build for production
npm run build

# Run built version
npm start http://localhost:3000

License

Cardamon is distributed under the terms of the PolyForm Shield License (Version 1.0).

See LICENSE for details.

Copyright © 2023 Root & Branch ltd