cesr/README.md

[](https://www.npmjs.com/package/cesr) [](https://github.com/lenkan/cesr-js/blob/main/LICENSE)

# CESR

[![NPM Version](https://img.shields.io/npm/v/cesr.svg?style=flat)](https://www.npmjs.com/package/cesr)
[![NPM License](https://img.shields.io/npm/l/cesr.svg?style=flat)](https://github.com/lenkan/cesr-js/blob/main/LICENSE)

This is a work in progress JavaScript implementation of [Composable Event Stream Representation](https://github.com/trustoverip/tswg-cesr-specification).

This package is currently not intended for any real world use case. It has been implemented for learning purposes.

# Usage

Install using npm

```bash
npm install cesr
```

Example usage that fetches and then parses a KERI OOBI stream:

```typescript
// @ts-check
import { parse } from "cesr";

const url = new URL("/lenkan/cesr-js/refs/heads/main/fixtures/geda.cesr", "https://raw.githubusercontent.com");
const response = await fetch(url);

if (response.body) {
  for await (const frame of parse(response.body)) {
    console.log(frame);
  }
}
```

## Command line interface

The command line interface can be used to parse CESR streams.

```bash
npm install -g cesr
cesr --help

# Parse a CESR file from a URL
cesr https://raw.githubusercontent.com/lenkan/cesr-js/refs/heads/main/fixtures/geda.cesr

# Parse a CESR file from stdin
curl https://raw.githubusercontent.com/lenkan/cesr-js/refs/heads/main/fixtures/geda.cesr | cesr --pretty -
```

# Features

- [x] Parsing CESR Stream
- [ ] API for encoding/decoding primitives