https://github.com/digitalbazaar/vc-js-cli
https://github.com/digitalbazaar/vc-js-cli
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/digitalbazaar/vc-js-cli
- Owner: digitalbazaar
- License: bsd-3-clause
- Created: 2019-07-23T14:52:10.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-13T19:08:29.000Z (almost 2 years ago)
- Last Synced: 2025-04-19T11:08:30.597Z (about 1 year ago)
- Language: JavaScript
- Size: 35.2 KB
- Stars: 4
- Watchers: 11
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `vc-js` CLI _(vc-js-cli)_
> A command line interface for `vc-js` Verifiable Credentials library, based on Docker
## Table of Contents
- [Background](#background)
- [Usage](#usage)
- [Install](#install)
- [Contribute](#contribute)
- [Commercial Support](#commercial-support)
- [License](#license)
## Background
This is a Docker-based cross platform CLI tool for using the
[`vc-js`](https://github.com/digitalbazaar/vc-js)
[Verifiable Credentials](https://w3c.github.io/vc-data-model/)
library (useful for testing, or issuing and verifying credentials from non-JS
languages).
See the [`vc-js` README](https://github.com/digitalbazaar/vc-js) for further
information, background and discussion.
## Usage
See the [VC Demo](https://github.com/digitalbazaar/vc-demo) repo for some
instructions to get started.
If using the `keygen` command, you will need a GitHub Personal Access Token with
at least "gist" permissions.
## Install
To use this tool, you only need Docker and Git.
To develop/modify it, you will also need to install Node.js and other deps.
#### Requirements (to use)
* A 64-bit system
* git >= v2.x
* Docker >= 18.x (and a Docker Hub account(?))
#### Requirements (to modify/develop)
In addition to the usage requirements above, you will need to install `npm`
and Node.js 12+.
To install locally (for development):
```
git clone https://github.com/digitalbazaar/vc-js-cli.git
cd vc-js-cli
npm install
```
## Contribute
See [the contribute file](https://github.com/digitalbazaar/bedrock/blob/master/CONTRIBUTING.md)!
PRs accepted.
Small note: If editing the Readme, please conform to the
[standard-readme](https://github.com/RichardLitt/standard-readme) specification.
## Commercial Support
Commercial support for this library is available upon request from
Digital Bazaar: support@digitalbazaar.com
## License
[New BSD License (3-clause)](LICENSE) © Digital Bazaar