# @cumulus/ingest

> Ingest utilities

Latest version **22.4.0** (published 2026-09-02) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @cumulus/ingest
pnpm add @cumulus/ingest
yarn add @cumulus/ingest
bun add @cumulus/ingest
```

## Health

**Score 55/100 (C)** — status: active.

Positive: no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 22.4.0 |
| Published | 2026-09-02 |
| First published | 2018-01-11 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 304 |
| Author | Cumulus Authors |
| Maintainers | cumuluspublisher, nsidc_kovarik, jennyhliu, npauzenga, ppilone84, etcart |
| Keywords | GIBS, CUMULUS, NASA |

## Links

- npm: https://www.npmjs.com/package/@cumulus/ingest
- Repository: https://github.com/nasa/cumulus
- Homepage: https://github.com/nasa/cumulus/tree/master/packages/ingest#readme
- Issues: https://github.com/nasa/cumulus/issues
- npm.io page: https://npm.io/package/@cumulus/ingest

## Recent versions

- 22.4.0 (latest) — 2026-09-02
- 21.3.5 (release-v21.3.5) — 2026-06-03
- 20.3.3 (release-v20.3.3) — 2026-04-16
- 21.2.1 (release-v21.2.1) — 2026-03-18
- 21.3.2-testlerna.0 (release-v21.3.2-testlerna.0) — 2026-03-02
- 21.3.1-alpha.0 (release-v21.3.1-alpha.0) — 2026-01-28
- 20.3.2 (release-v20.3.2) — 2025-12-04
- 20.2.3 (release-v20.2.3) — 2025-12-03
- 21.0.0-echo10 (release-v21.0.0-echo10) — 2025-11-21
- 20.3.1 (release-v20.3.1) — 2025-10-14
- 20.2.2 (release-v20.2.2) — 2025-10-08
- 20.1.3-alpha.2 (release-v20.1.3-alpha.2) — 2025-05-15
- 20.1.3-alpha.1 (release-v20.1.3-alpha.1) — 2025-05-15
- 20.1.3-alpha.0 (release-v20.1.3-alpha.0) — 2025-05-14
- 18.5.6 (release-v18.5.6) — 2025-04-11
- … 249 more at https://npm.io/package/@cumulus/ingest/versions

## README

# @cumulus/ingest

@cumulus/ingest is a collection of modules for discovering and ingesting data.

## About Cumulus

Cumulus is a cloud-based data ingest, archive, distribution and management prototype for NASA's future Earth science data streams.

[Cumulus Documentation](https://nasa.github.io/cumulus)

## Installation

```bash
npm install @cumulus/ingest
```

## Testing

Running tests locally requires [localstack](https://github.com/localstack/localstack).

With localstack running, you can run tests using:

```bash
LOCALSTACK_HOST=localhost npm test
```

## Modules

All modules are accessible using require: `require('@cumulus/ingest/<MODULE_NAME>')` or import: `import <MODULE_NAME> from '@cumulus/ingest/<MODULE_NAME>'`.

- [`consumer`](./consumer.js) - consumer for SQS messages
- [`crypto`](./crypto.js) - provides encryption and decryption methods with a consistent API but differing mechanisms for dealing with encryption keys
- [`ftp`](./ftp.js) - for accessing FTP servers
- [`granule`](./granule.js) - discovers and ingests granules
- [`http`](./http.js) - for accessing data via HTTP and HTTPS
- [`lock`](./lock.js) - creates locks for S3 data
- [`log`](./log.js) - stringifies JS object logs for ElasticSearch indexing
- [`parse-pdr`](./parse-pdr.js) - tools for validating PDRs and generating PDRD and PAN messages
- [`pdr`](./pdr.js) - discovers and ingests pdrs
- [`queue`](./queue.js) - creates queues for ingesting data
- [`recursion`](./recursion.js) - handles recursion of a FTP/SFTP list operation
- [`sftp`](./sftp.js) - for accessing SFTP servers

## Contributing

To make a contribution, please [see our contributing guidelines](https://github.com/nasa/cumulus/blob/master/CONTRIBUTING.md).

---
_Source: https://npm.io/package/@cumulus/ingest · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._