# mediacentral-sign

> Signing tool for mediacentral cloud-ux apps

Latest version **0.1.2** (published 2022-11-30) · EULA license · 0 weekly downloads

## Install

```sh
npm install mediacentral-sign
pnpm add mediacentral-sign
yarn add mediacentral-sign
bun add mediacentral-sign
```

Provides the command `mediacentral-sign`.

## 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.1.2 |
| Published | 2022-11-30 |
| First published | 2018-05-15 |
| Weekly downloads | 0 |
| License | EULA |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 52 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Artur Ziemba artur.ziemba@avid.com> |
| Maintainers | wbauer, joeapearson, enterit, anna.kryzhko, anna.vaskovska, yvadim, diana_chaikovska, vladyslav.kurakov, artur.ziemba.avid |
| Keywords | MediaCentral, Avid, sign |

## Links

- npm: https://www.npmjs.com/package/mediacentral-sign
- Repository: https://github.com/avid-technology
- npm.io page: https://npm.io/package/mediacentral-sign

## Dependencies (4)

- [joi](https://npm.io/package/joi.md) ^17.7.0
- [yargs](https://npm.io/package/yargs.md) ^17.6.2
- [log4js](https://npm.io/package/log4js.md) ^6.7.0
- [util.promisify](https://npm.io/package/util.promisify.md) ^1.1.1

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.1.2 (latest) — 2022-11-30
- 0.1.1 — 2021-06-30
- 0.1.0 — 2021-06-15
- 0.0.79 — 2019-01-03
- 0.0.78 — 2018-11-16
- 0.0.77 — 2018-10-24
- 0.0.76 — 2018-10-23
- 0.0.75 — 2018-09-21
- 0.0.74 — 2018-06-28
- 0.0.73 — 2018-06-18
- 0.0.72 — 2018-06-18
- 0.0.71 — 2018-06-11
- 0.0.70 — 2018-06-11
- 0.0.69 — 2018-06-11
- 0.0.68 — 2018-06-11
- … 18 more at https://npm.io/package/mediacentral-sign/versions

## README

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

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