{"id":19718179,"url":"https://github.com/khaosdoctor/openvolt-cli","last_synced_at":"2026-04-18T03:31:01.329Z","repository":{"id":207018432,"uuid":"718109293","full_name":"khaosdoctor/openvolt-cli","owner":"khaosdoctor","description":"Fetches electricity information from OpenVolt","archived":false,"fork":false,"pushed_at":"2023-11-28T17:25:01.000Z","size":10504,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-25T04:47:41.418Z","etag":null,"topics":["carbon-emissions","cli","electricity","node","openvolt","typescript","typescript-cli","volt"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/khaosdoctor.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":["khaosdoctor","irontitan"]}},"created_at":"2023-11-13T11:58:31.000Z","updated_at":"2024-04-06T13:30:58.000Z","dependencies_parsed_at":"2023-11-13T18:24:57.869Z","dependency_job_id":"b35a6ab7-566a-4b29-9b74-78cbb2e60e12","html_url":"https://github.com/khaosdoctor/openvolt-cli","commit_stats":{"total_commits":3,"total_committers":1,"mean_commits":3.0,"dds":0.0,"last_synced_commit":"5aaa945124e43127e13d4a2bcffca4544e0ec3ef"},"previous_names":["khaosdoctor/openvolt-cli"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/khaosdoctor/openvolt-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khaosdoctor%2Fopenvolt-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khaosdoctor%2Fopenvolt-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khaosdoctor%2Fopenvolt-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khaosdoctor%2Fopenvolt-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/khaosdoctor","download_url":"https://codeload.github.com/khaosdoctor/openvolt-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khaosdoctor%2Fopenvolt-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31955573,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T00:39:45.007Z","status":"online","status_checked_at":"2026-04-18T02:00:07.018Z","response_time":103,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["carbon-emissions","cli","electricity","node","openvolt","typescript","typescript-cli","volt"],"created_at":"2024-11-11T22:54:01.863Z","updated_at":"2026-04-18T03:31:01.306Z","avatar_url":"https://github.com/khaosdoctor.png","language":"TypeScript","funding_links":["https://github.com/sponsors/khaosdoctor","https://github.com/sponsors/irontitan"],"categories":[],"sub_categories":[],"readme":"# openvolt CLI\n\n\u003e Gathers and displays energy consumption information from OpenVolt and other sources\n\n# Installation\n\nThis is a CLI tool, you can clone it locally with `git clone` and either run it directly with npm or manually.\n\nYou will need to create a `.env` file with the following variables defined in [`.env.example`](./.env.sample)\n\n![](./usagegif.gif)\n\n## Steps\n\n1. Clone the repository\n2. Run `npm install` to install dependencies\n3. Run `npm link` to link the CLI to your system\n4. Run `openvolt` to start the CLI\n\nYou can also execute the file directly from the `src` folder with `tsx` using `npm start`.\n\n\u003e If you have any issues with the installation, please install `tsx` globally with `npm i -g tsx` (this shouldn't be necessary in most cases)\n\n## Usage\n\nThere's only one command called `analysis`, you can run `openvolt -h` or `openvolt help analysis` to see the options.\n\n```bash\n❯ openvolt -h\nUsage: OpenVolt CLI [options] [command]\n\nFetches energy information from OpenVolt\n\nOptions:\n  -V, --version                 output the version number\n  -h, --help                    display help for command\n\nCommands:\n  analysis [options] [meterId]  Gets analysis of the energy consumption of a meter\n  help [command]                display help for command\n```\n\nYou can optionally supply a meter ID and a date range to get the analysis for that specific time using `openvolt analysis [meterId] -s [startDate] -e [endDate]`. Dates **must** be in the ISO format `YYYY-MM-DDTHH:MM:SS.ZZZZ`.\n\n\u003e Running it in larger terminals will make the output easier to read\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhaosdoctor%2Fopenvolt-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkhaosdoctor%2Fopenvolt-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhaosdoctor%2Fopenvolt-cli/lists"}