# kinesis-get-records-cli

> This CLI outputs newline separated records from kinesis.

Latest version **0.1.0** (published 2020-03-18) · UNLICENSED license · 0 weekly downloads

## Install

```sh
npm install kinesis-get-records-cli
pnpm add kinesis-get-records-cli
yarn add kinesis-get-records-cli
bun add kinesis-get-records-cli
```

Provides the command `kinesis-get-records`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2020-03-18 |
| First published | 2020-03-18 |
| Weekly downloads | 0 |
| License | UNLICENSED |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 14.2 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | justinwalz |

## Links

- npm: https://www.npmjs.com/package/kinesis-get-records-cli
- npm.io page: https://npm.io/package/kinesis-get-records-cli

## Dependencies (7)

- [yargs](https://npm.io/package/yargs.md) ^15.3.0
- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.637.0
- [bluebird](https://npm.io/package/bluebird.md) ^3.7.2
- [typescript](https://npm.io/package/typescript.md) ^3.8.3
- [@types/node](https://npm.io/package/@types/node.md) ^13.9.0
- [@types/yargs](https://npm.io/package/@types/yargs.md) ^15.0.4
- [@types/bluebird](https://npm.io/package/@types/bluebird.md) ^3.5.30

## Recent versions

- 0.1.0 (latest) — 2020-03-18

## README

# kinesis-cli

This CLI outputs newline separated records from kinesis.

## Install

```bash
npm i -g kinesis-get-records-cli
```

## Usage

To fetch the latest records:

```bash
kinesis-get-records --stream-name <StreamName> --shard-iterator-type <ShardIteratorType>
kinesis-get-records --region us-east-1 -s my-stream -i LATEST
```

If records are JSON objects, consider piping into `jq`

## Example

Put records using the [AWS CLI](https://aws.amazon.com/cli/):

```bash
aws --region <AWSRegion> kinesis put-records --records Data=\'{\"key\":\"blob-$(date --iso-8601=seconds)\"}\',PartitionKey=foo --stream-name <StreamName>
```

Output

```bash
{"key":"blob-2020-03-18T07:22:29-07:00"}
{"key":"blob-2020-03-18T07:22:31-07:00"}
```

## Build

```bash
npm run transpile
```

## Run

```bash
 node lib --region <AWSRegion> -s <StreamName> -i LATEST
```

---
_Source: https://npm.io/package/kinesis-get-records-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._