Using aven-stellar as an npm Package

Install and consume the aven-stellar npm package programmatically to embed work-session tracking and submission inside your own Node.js tooling.

The aven-stellar package ships both a CLI (documented in the CLI Guide) and a programmatic API for embedding session tracking directly in your Node.js applications.

Install

npm

npm install aven-stellar

pnpm add aven-stellar

yarn add aven-stellar

Programmatic API

import { startSession, stopSession } from "aven-stellar";

const session = await startSession({
  streamId: "CSTREAM...",
  repoPath: process.cwd(),
});

// ... time passes, code is committed ...

const report = await stopSession({
  sessionId: session.id,
  submit: true, // submit on-chain immediately
});

console.log("Attestation tx:", report.txHash);

What the package exports

Export	Purpose
startSession(opts)	Begin a tracked work session tied to a Stream.
stopSession(opts)	Finalize the session and optionally submit it on-chain.
readReport(path)	Load a locally-saved session report.
verifyReport(report)	Recompute the report’s signature and Git hash chain.

For interactive terminal usage, prefer the CLI. The programmatic API is intended for CI jobs, custom dashboards, and headless environments.

CLI reference

Full command-line documentation for aven-stellar start and aven-stellar stop.