computeledger-cli
Advanced tools
computeledger-cli - npm Package Compare versions
+5
-2
| { | ||
| "name": "computeledger-cli", | ||
| "version": "0.1.0", | ||
| "version": "0.1.1", | ||
| "description": "Provider-agnostic CLI and MCP server that signs, hash-chains, and verifies compute usage receipts (GPU-hours, workload type, hardware) so any third party can audit them without trusting the issuer.", | ||
@@ -9,3 +9,3 @@ "type": "module", | ||
| "bin": { | ||
| "computeledger": "./dist/cli.js" | ||
| "computeledger": "dist/cli.js" | ||
| }, | ||
@@ -41,5 +41,8 @@ "files": [ | ||
| "mcp", | ||
| "mcp-server", | ||
| "agent-native", | ||
| "cryptographic-verification", | ||
| "ed25519", | ||
| "hash-chain", | ||
| "tamper-evident", | ||
| "finops" | ||
@@ -46,0 +49,0 @@ ], |
+35
-16
@@ -8,7 +8,7 @@ # ComputeLedger | ||
| [](https://github.com/RudrenduPaul/ComputeLedger/actions/workflows/ci.yml) | ||
| [](https://www.npmjs.com/package/computeledger-cli) | ||
| [](https://pypi.org/project/computeledger-cli/) | ||
| [](LICENSE) | ||
| [](package.json) | ||
| <!-- TODO: record demo GIF with vhs (computeledger keys generate --local && computeledger run --local -- <job> && computeledger verify) --> | ||
| ## Install | ||
@@ -18,4 +18,2 @@ | ||
| npm install -g computeledger-cli | ||
| # or, without installing: | ||
| npx computeledger-cli keys generate | ||
| ``` | ||
@@ -27,11 +25,22 @@ | ||
| *Not yet published to npm or PyPI. Until the first release, build and link from source:* | ||
| Both packages install the same `computeledger` command. Receipts are interoperable either way: a receipt signed by the npm binary verifies correctly with the PyPI binary, and vice versa. | ||
| ```bash | ||
| git clone https://github.com/RudrenduPaul/ComputeLedger.git && cd ComputeLedger | ||
| npm install && npm run build && npm link # TypeScript CLI | ||
| # or | ||
| cd python && pip install -e . # Python CLI | ||
| ``` | ||
| ## Demo | ||
| <!-- demo GIF placeholder: docs/demo.gif not yet generated in this repo --> | ||
| ## Table of contents | ||
| - [Quickstart](#quickstart) | ||
| - [Why this exists](#why-this-exists) | ||
| - [Features](#features) | ||
| - [CLI reference](#cli-reference) | ||
| - [MCP / agent-native usage](#mcp--agent-native-usage) | ||
| - [Library API](#library-api) | ||
| - [Comparison](#comparison) | ||
| - [What is ComputeLedger, and why does it exist](#what-is-computeledger-and-why-does-it-exist) | ||
| - [FAQ](#faq) | ||
| - [Contributing](#contributing) | ||
| - [License](#license) | ||
| ## Quickstart | ||
@@ -77,3 +86,3 @@ | ||
| - **Hash-chained ledger.** Every receipt embeds the previous receipt's hash. Deleting, reordering, or editing a historical entry breaks the chain in a way `ledger verify` detects, even if the tampered entry's own signature still looks locally valid. | ||
| - **Cross-language interoperability by construction.** A receipt signed by the npm package's `computeledger` binary verifies correctly against the PyPI package's `computeledger` binary, and vice versa: both implementations serialize the receipt payload through the same deterministic canonical-JSON algorithm before hashing. | ||
| - **Cross-language interoperability by construction.** A receipt signed by the npm package's `computeledger` binary verifies correctly against the PyPI package's `computeledger` binary. Both implementations serialize the receipt payload through the same deterministic canonical-JSON algorithm before hashing. | ||
| - **Provider-agnostic.** No account, no API key, no dependency on any specific cloud or chain. Works identically on a laptop, an on-prem cluster, or any cloud VM. | ||
@@ -135,12 +144,13 @@ - **Agent-native.** Every subcommand supports `--json` for structured output, and `computeledger mcp` starts a Model Context Protocol server exposing `record_usage`, `verify_receipt`, `list_ledger`, and `verify_ledger` as callable tools. | ||
| | | ComputeLedger | SkyPilot | OpenCost | AICert (archived) | | ||
| | | ComputeLedger | SkyPilot | OpenCost | AICert | | ||
| |---|---|---|---|---| | ||
| | What it is | Signed, portable usage receipts | Multi-cloud job orchestration + cost | Kubernetes/cloud cost monitoring | Training-provenance attestation | | ||
| | Cryptographic verification | Yes (Ed25519, offline) | No | No | Yes (dead project) | | ||
| | Cryptographic verification | Yes (Ed25519, offline) | No | No | Yes (TPM-based) | | ||
| | Provider lock-in | None | Orchestrates specific clouds | Kubernetes/cloud-native | None | | ||
| | Tamper-evident history | Yes (hash-chained ledger) | No | No | No (single artifact, no chain) | | ||
| | GitHub stars | New | 10,440 | 6,659 (CNCF) | 20, archived June 2024 | | ||
| | GitHub stars | New | 10,441 | 6,659 (CNCF) | 20 | | ||
| | Project activity | Active | Active | Active | No commits since June 2024 | | ||
| | Agent-native (MCP/`--json`) | Yes | Partial (API/SDK) | No | No | | ||
| SkyPilot and OpenCost solve real, adjacent problems (running jobs across clouds, and visualizing what they cost) at far larger scale and maturity than this project. Neither produces a signed, independently verifiable usage record. AICert attempted training-compute provenance as a standalone OSS tool and did not find an audience; ComputeLedger's scope is deliberately narrower (a usage receipt, not a full training-provenance framework) and ships both an npm and a PyPI package from day one specifically so the receipt format isn't locked to one language's ecosystem. | ||
| SkyPilot and OpenCost solve real, adjacent problems (running jobs across clouds, and visualizing what they cost) at far larger scale and maturity than this project. Neither produces a signed, independently verifiable usage record. AICert attempted training-compute provenance as a standalone OSS tool using TPM-bound attestation and has had no commits since June 2024; ComputeLedger's scope is deliberately narrower (a usage receipt, not a full training-provenance framework) and ships both an npm and a PyPI package from day one specifically so the receipt format isn't locked to one language's ecosystem. | ||
@@ -168,2 +178,11 @@ ## What is ComputeLedger, and why does it exist | ||
| **Does ComputeLedger work on Windows?** | ||
| The npm and PyPI packages install and run on any platform Node.js 18+ or Python 3.10+ supports, including Windows. One caveat: private key files are written with POSIX permission bits (mode 600), which restrict access on Linux and macOS; Windows does not enforce the same POSIX permission model, so the file is written but the access restriction has no equivalent effect there. CI currently runs on Linux only, so Windows and macOS are not continuously tested upstream. | ||
| **Can I use ComputeLedger for commercial projects?** | ||
| Yes. Both the TypeScript and Python packages are licensed Apache-2.0, which permits commercial use, modification, and redistribution, including in closed-source products, as long as the license and copyright notice are preserved. | ||
| **What if I need multi-cloud orchestration or a cost dashboard instead?** | ||
| ComputeLedger doesn't do either. It only produces and verifies signed usage receipts. Pair it with SkyPilot for orchestration or OpenCost for cost visibility if you need those. | ||
| ## Contributing | ||
@@ -170,0 +189,0 @@ |
No alert changes
Improved metrics
- Total package byte prevSize
61335
2.64%- Number of lines in readme file
189
11.18%No dependency changes