# shroud

> Encrypt and decrypt secrets with a master password

Latest version **0.6.1** (published 2017-04-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install shroud
pnpm add shroud
yarn add shroud
bun add shroud
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.6.1 |
| Published | 2017-04-23 |
| First published | 2016-11-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 14 |
| Author | Tara Vancil |
| Maintainers | taravancil |
| Keywords | password, password manager, password vault, secret store, encrypted store |

## Links

- npm: https://www.npmjs.com/package/shroud
- Repository: https://github.com/taravancil/shroud
- Homepage: https://github.com/taravancil/shroud#readme
- Issues: https://github.com/taravancil/shroud/issues
- npm.io page: https://npm.io/package/shroud

## Dependencies (3)

- [zerr](https://npm.io/package/zerr.md) ^1.0.4
- [scrypt](https://npm.io/package/scrypt.md) ^6.0.3
- [libsodium-wrappers](https://npm.io/package/libsodium-wrappers.md) ^0.4.8

## Recent versions

- 0.6.1 (latest) — 2017-04-23
- 0.6.0 — 2017-04-23
- 0.4.0 — 2017-01-02
- 0.3.0 — 2016-12-04
- 0.2.0 — 2016-12-02
- 0.1.3 — 2016-12-02
- 0.1.2 — 2016-12-01
- 0.1.1 — 2016-11-30
- 0.1.0 — 2016-11-30

## README

# Shroud

[![standard code
style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard)

A module for encrypting and decrypting secrets with a master password, and
managing them in a file-based vault.

## Usage

```
const opts = {
  dataDir: '/usr/shroudData', // optional, default HOME_DIR/.shroud
  masterPassword: 'astrongmasterpassword' // required if not initialized
}

// initialize shroud
const shroud = require('shroud')(opts)

// add a secret to the vault
shroud.add({name: 'sekrit.com', secret: 'sekrit'})

// add a secret with a category
shroud.add({name: 'sekrit.com', secret: 'sekrit', category: 'work'})

// decrypt a secret
shroud.reveal('sekrit.com', 'astrongmasterpassword')

// remove a secret
shroud.remove('sekrit.com')

// list all secrets
shroud.list()

// list all secrets by category()
shroud.list({category: 'work'})

// list secrets that match a pattern (case-insensitive)
shroud.list({pattern: 'SekRit'})
```

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