# cipherjson

> Store json in encrypted format.

Latest version **3.0.7** (published 2019-01-25) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.7 |
| Published | 2019-01-25 |
| First published | 2015-12-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 6 |
| Unpacked size | 18.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | okunishinishi |
| Maintainers | okunishinishi |
| Keywords | crypto |

## Links

- npm: https://www.npmjs.com/package/cipherjson
- Repository: https://github.com/okunishinishi/node-cipherjson
- Homepage: https://github.com/okunishinishi/node-cipherjson#readme
- Issues: https://github.com/okunishinishi/node-cipherjson/issues
- npm.io page: https://npm.io/package/cipherjson

## Dependencies (6)

- [qs](https://npm.io/package/qs.md) ^6.6.0
- [argx](https://npm.io/package/argx.md) ^3.0.2
- [abind](https://npm.io/package/abind.md) ^1.0.0
- [async](https://npm.io/package/async.md) ^2.1.4
- [objnest](https://npm.io/package/objnest.md) ^5.0.4
- [writeout](https://npm.io/package/writeout.md) ^2.1.0

## Alternatives

- [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads
- [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads
- [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads
- [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads
- [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads

## Recent versions

- 3.0.7 (latest) — 2019-01-25
- 3.0.6 — 2019-01-25
- 3.0.5 — 2018-12-26
- 3.0.4 — 2018-12-26
- 3.0.3 — 2018-12-26
- 3.0.2 — 2018-12-25
- 3.0.1 — 2018-12-25
- 3.0.0 — 2018-12-19
- 2.1.0 — 2016-12-04
- 2.0.4 — 2016-12-04
- 2.0.3 — 2016-05-21
- 2.0.2 — 2016-05-21
- 2.0.0 — 2016-05-21
- 1.1.0 — 2015-12-24
- 1.0.4 — 2015-12-24
- … 4 more at https://npm.io/package/cipherjson/versions

## README

cipherjson
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/okunishinishi/node-cipherjson
[bd_travis_url]: http://travis-ci.org/okunishinishi/node-cipherjson
[bd_travis_shield_url]: http://img.shields.io/travis/okunishinishi/node-cipherjson.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/okunishinishi/node-cipherjson
[bd_travis_com_shield_url]: https://api.travis-ci.com/okunishinishi/node-cipherjson.svg?token=
[bd_license_url]: https://github.com/okunishinishi/node-cipherjson/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/okunishinishi/node-cipherjson
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/okunishinishi/node-cipherjson.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/okunishinishi/node-cipherjson.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/okunishinishi/node-cipherjson
[bd_gemnasium_shield_url]: https://gemnasium.com/okunishinishi/node-cipherjson.svg
[bd_npm_url]: http://www.npmjs.org/package/cipherjson
[bd_npm_shield_url]: http://img.shields.io/npm/v/cipherjson.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Store json in encrypted format.

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
$ npm install cipherjson --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
---------

```javascript
'use strict'

const cipherjson = require('cipherjson')

const cipher = cipherjson('your-password')

cipher.write('secret.json', {
  DATABASE_PASSWORD: 'asekr324',
  EXTERNAL_API_SECRET: 'puaALiJ'
}).then(() => {
  /* ... */

  cipher.read('secret.json').then((data) => {
    /* ... */
  })
})


```


And secret.json would be looks like:

```json
{
    "DATABASE_PASSWORD": "enciphered:fd871bb714f57481f229dd795a94ec34",
    "EXTERNAL_API_SECRET": "enciphered:asf09a;sdfj09asdf98u89jlj98u98"
}
```

<!-- Section from "doc/guides/02.Usage.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/okunishinishi/node-cipherjson/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------



<!-- Links End -->

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