mediacentral-sign/README.md

Signing tool for mediacentral cloud-ux apps

[![pipeline status](https://burl-gitlab.global.avidww.com/avid/dtk/avid-sign/badges/master/pipeline.svg)](https://burl-gitlab.global.avidww.com/avid/dtk/avid-sign/commits/master)
[![coverage report](https://burl-gitlab.global.avidww.com/avid/dtk/avid-sign/badges/master/coverage.svg)](https://burl-gitlab.global.avidww.com/avid/dtk/avid-sign/commits/master)

# Motivation
A tool to sign pointed files or directories with RSA512 hash. 

## Usage

1. As a CLI (Install globally)

    npm i -g mediacentral-sign
  
2. As a JS module

```js
const sign = require('mediacentral-sign')
sign(options)
```

## CLI tool help page  

Options:
- **-S** `Sign` use this options to Sign your file
  - --version `Show version number` [boolean]
  - --help `Show help` [boolean]
  - -k, --key `path to a private key` [default: "private.key"]
  - -m, --manifest `path to a new or existing manifest file` [default: "./manifest.json"]
  - -f, --file `path to a directory or file to sign` [default: "."]
  - -p, --password `password to the private key`
  - -i, --id `developers ID (assigned by Avid)`
- **-V** `Verify` this option allow you to verify your _**manifest.json**_
file  with your public key
  - -m, --manifest `path to your manifest.json file`
  - -v, -pubKeyPath `path to you public key`

## Api

### `sign([, options])`

Parameters

- `options` -- options object with keys:
  - `key` -- path to a private key
  - `manifest` -- path to a new or existing manifest file
  - `file` -- path to a directory or file to sign
  - `password` -- optional, password to the private key 
  - `id` -- optional, developers ID (assigned by Avid)
  - `verify` -- setting to _**true**_ will verify your file
  - `manifest` -- path to your _**manifest.json**_ file
  - `pubKeyPath` -- path to your public key