# apeman-scrt

> Secret manager for apeman.

Latest version **3.0.3** (published 2016-07-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install apeman-scrt
pnpm add apeman-scrt
yarn add apeman-scrt
bun add apeman-scrt
```

Provides the command `apeman-scrt`.

## 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.3 |
| Published | 2016-07-03 |
| First published | 2015-12-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.0.0 |
| Dependencies | 11 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |
| Keywords | apeman, command, secret |

## Links

- npm: https://www.npmjs.com/package/apeman-scrt
- Repository: https://github.com/apeman-cmd-labo/apeman-scrt
- Homepage: https://github.com/apeman-cmd-labo/apeman-scrt#readme
- Issues: https://github.com/apeman-cmd-labo/apeman-scrt/issues
- npm.io page: https://npm.io/package/apeman-scrt

## Dependencies (11)

- [co](https://npm.io/package/co.md) ^4.6.0
- [argx](https://npm.io/package/argx.md) ^2.0.2
- [apemancwd](https://npm.io/package/apemancwd.md) ^1.0.4
- [askconfig](https://npm.io/package/askconfig.md) ^3.0.2
- [commander](https://npm.io/package/commander.md) ^2.9.0
- [apemanfile](https://npm.io/package/apemanfile.md) ^7.0.1
- [cipherjson](https://npm.io/package/cipherjson.md) ^2.0.3
- [colorprint](https://npm.io/package/colorprint.md) ^4.0.2
- [arrayfilter](https://npm.io/package/arrayfilter.md) ^1.1.2
- [arrayreduce](https://npm.io/package/arrayreduce.md) ^2.1.0
- [readline-sync](https://npm.io/package/readline-sync.md) ^1.4.4

## Recent versions

- 3.0.3 (latest) — 2016-07-03
- 3.0.2 — 2016-07-03
- 3.0.1 — 2016-07-03
- 3.0.0 — 2016-05-21
- 2.0.0 — 2016-04-07
- 1.0.1 — 2015-12-24
- 1.0.0 — 2015-12-24

## README

apeman-scrt
==========

<!---
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]
[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_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/apeman-cmd-labo/apeman-scrt
[bd_travis_url]: http://travis-ci.org/apeman-cmd-labo/apeman-scrt
[bd_travis_shield_url]: http://img.shields.io/travis/apeman-cmd-labo/apeman-scrt.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/apeman-cmd-labo/apeman-scrt
[bd_travis_com_shield_url]: https://api.travis-ci.com/apeman-cmd-labo/apeman-scrt.svg?token=
[bd_license_url]: https://github.com/apeman-cmd-labo/apeman-scrt/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/apeman-cmd-labo/apeman-scrt
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-cmd-labo/apeman-scrt.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-cmd-labo/apeman-scrt.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/apeman-cmd-labo/apeman-scrt
[bd_gemnasium_shield_url]: https://gemnasium.com/apeman-cmd-labo/apeman-scrt.svg
[bd_npm_url]: http://www.npmjs.org/package/apeman-scrt
[bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-scrt.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>

Secret manager for apeman.

<!-- 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
-----

Install apeman-scrt module via [npm][npm_url].
```bash
$ npm install apeman-scrt -g
```


[npm_url]: https://www.npmjs.com/


<!-- 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
---------

1. Prepare an Apemanfile.js at your project root.
2. Run the command via CLI.

***Apemanfile.js***
```javascript
/** Example of Apemanfile.js */

'use strict'

module.exports = {
  $cwd: __dirname,
  $pkg: { /* ... */ },
  $proto: [ /* ... */ ],
  $tmpls: { /* ... */ },
  $tasks: { /* ... */ },
  $apps: { /* ... */ },
  $wtchs: { /* ... */ },
  $infra: { /* ... */ },
  // Secret json file path.
  $scrt: './secret.json'
}

```

Then,

```bash
$ apeman-scrt MYSQL_ROOT_PASSWORD
```


##### CLI Options

```bash
$ apeman-scrt -h

  Usage: apeman-scrt [options] [name...] 

  Encrypt/decrypt secret file.

  Options:

    -h, --help                           output usage information
    -V, --version                        output the version number
    -p, --password <password>            Password of secret.
    -c, --configuration <configuration>  Pathname of Apemanfile

  Examples:

    $ apeman-scrt                     # Update secret file.


```


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

<!-- Section from "doc/guides/03.Programmatic API.md.hbs" Start -->

<a name="section-doc-guides-03-programmatic-a-p-i-md"></a>
Programmatic API
---

apeman-scrt also provide programmatic API.

Firstly, install the module locally.

```bash
$ npm install apeman-scrt --save-dev
```

Then,

```javascript
'use strict'

const apemanScrt = require('apeman-scrt')

apemanScrt({

}).then(() => {
    /* ... */
})

```


##### Programmatic Options

| Key | Description | Default |
| --- | ----------- | ------- |
| password | Password of secret. |  |
| configuration | Pathname of Apemanfile |  |


<!-- Section from "doc/guides/03.Programmatic API.md.hbs" End -->


<!-- Sections Start -->


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

License
-------
This software is released under the [MIT License](https://github.com/apeman-cmd-labo/apeman-scrt/blob/master/LICENSE).

<!-- LICENSE End -->


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

Links
------

+ [apeman][apeman_url]
+ [apeman-cmd-labo][apeman_cmd_labo_url]

[apeman_url]: http://github.com/apeman-labo/apeman
[apeman_cmd_labo_url]: http://github.com/apeman-cmd-labo

<!-- Links End -->

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