https://github.com/timharek/wcarbon

Access Website Carbon's API for checking carbon emissions for websites with Deno.
https://github.com/timharek/wcarbon

cli-app co2-emissions co2-footprint deno deno-cli typescript website-carbon

Last synced: 7 days ago
JSON representation

Access Website Carbon's API for checking carbon emissions for websites with Deno.

• Host: GitHub
• URL: https://github.com/timharek/wcarbon
• Owner: timharek
• License: gpl-3.0
• Created: 2022-06-26T20:33:55.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-01T18:59:32.000Z (7 months ago)
• Last Synced: 2024-12-20T22:09:23.648Z (13 days ago)
• Topics: cli-app, co2-emissions, co2-footprint, deno, deno-cli, typescript, website-carbon
• Language: TypeScript
• Homepage:
• Size: 120 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
[![Latest version](https://deno.land/badge/wcarbon/version)](https://deno.land/x/wcarbon)

[![sourcehut](https://img.shields.io/badge/repository-sourcehut-lightgrey.svg?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSINCiAgICB3aWR0aD0iMTI4IiBoZWlnaHQ9IjEyOCI+DQogIDxkZWZzPg0KICAgIDxmaWx0ZXIgaWQ9InNoYWRvdyIgeD0iLTEwJSIgeT0iLTEwJSIgd2lkdGg9IjEyNSUiIGhlaWdodD0iMTI1JSI+DQogICAgICA8ZmVEcm9wU2hhZG93IGR4PSIwIiBkeT0iMCIgc3RkRGV2aWF0aW9uPSIxLjUiDQogICAgICAgIGZsb29kLWNvbG9yPSJibGFjayIgLz4NCiAgICA8L2ZpbHRlcj4NCiAgICA8ZmlsdGVyIGlkPSJ0ZXh0LXNoYWRvdyIgeD0iLTEwJSIgeT0iLTEwJSIgd2lkdGg9IjEyNSUiIGhlaWdodD0iMTI1JSI+DQogICAgICA8ZmVEcm9wU2hhZG93IGR4PSIwIiBkeT0iMCIgc3RkRGV2aWF0aW9uPSIxLjUiDQogICAgICAgIGZsb29kLWNvbG9yPSIjQUFBIiAvPg0KICAgIDwvZmlsdGVyPg0KICA8L2RlZnM+DQogIDxjaXJjbGUgY3g9IjUwJSIgY3k9IjUwJSIgcj0iMzglIiBzdHJva2U9IndoaXRlIiBzdHJva2Utd2lkdGg9IjQlIg0KICAgIGZpbGw9Im5vbmUiIGZpbHRlcj0idXJsKCNzaGFkb3cpIiAvPg0KICA8Y2lyY2xlIGN4PSI1MCUiIGN5PSI1MCUiIHI9IjM4JSIgc3Ryb2tlPSJ3aGl0ZSIgc3Ryb2tlLXdpZHRoPSI0JSINCiAgICBmaWxsPSJub25lIiBmaWx0ZXI9InVybCgjc2hhZG93KSIgLz4NCjwvc3ZnPg0KCg==)](https://sr.ht/~timharek/wcarbon)

[![GitHub mirror](https://img.shields.io/badge/mirror-GitHub-black.svg?logo=github)](https://github.com/timharek/wcarbon)

# wcarbon

Access [Website Carbon's API](https://api.websitecarbon.com/) for checking

carbon emissions for websites.

## Usage

### Example for site

```ts

import { site } from "jsr:@timharek/wcarbon";

const siteUrl = "example.org";

const result = await site(siteUrl);

```

### Example for data

```ts

import { data } from "jsr:@timharek/wcarbon";

const result = await data({ bytes: 1024, hasGreenHosting: false });

```

## CLI

### Installation

```sh

deno install --allow-net=api.websitecarbon.com \

   -n wcarbon jsr:@timharek/wcarbon/cli

```

### Usage

```bash

$ wcarbon timharek.no

$ wcarbon site timharek.no

$ wcarbon data 2048

$ wcarbon -h # for all available flags and commands

```

## Development

1. Install [Deno](https://deno.land)

1. Run `deno task setup:hooks`

1. Now you can get to work! :sunglasses: