https://github.com/cronus1007/cronus-cli
https://github.com/cronus1007/cronus-cli
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/cronus1007/cronus-cli
- Owner: Cronus1007
- License: apache-2.0
- Created: 2021-06-18T07:28:02.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-07-09T15:51:09.000Z (almost 5 years ago)
- Last Synced: 2025-02-14T17:41:42.690Z (over 1 year ago)
- Language: JavaScript
- Size: 346 KB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
Awesome Lists containing this project
README
Cronus CLI
The official CLI of Cronus package
___
## Table of Contents
- [About](#about)
- [How to install](#how-to-install)
- [Supported arguments and commands](#supported-arguments-and-commands)
- [Packages](#packages)
- [Commands](#commands)
- [Utilities](#utilities)
- [Getting started](#getting-started)
- [Exit codes and their meanings](#exit-codes-and-their-meanings)
___
## About
### ◦ How to install
## Supported arguments and commands
```cronus``` Prefix to command to access the node package
## Packages
### ◦ Commands
Supporting developers is an important task for cronus CLI.
Thus, cronus CLI provides different commands for many common tasks.
```cronus generate-pem``` To generate public and private keys in .pem format
###### Options for ```cronus generate-pem``` command
```--puboutput``` Default none, not required
```--privoutput``` Default none, not required
___
```cronus sign``` generate signature from the given public and private keys with a message digest
###### Options for ```cronus sign``` command
```--pubinput``` File name consisting of public key(required)
```--privinput``` File name consisting of private key(required)
```--message``` some text for creating the signatures (default none, not required)
### ◦ Utilities
The project has several utility packages which are used by other commands
```commands``` - Contains all cronus-cli related generators.
## Getting started
You would need to install cronus CLI and the packages you want to use using either npm or yarn. To start with a new project:
```generate-pem ``` command generates public and private keys in .pem format
## Exit codes and their meanings
| Exit Code | Description |
| --------- | -------------------------------------------------- |
| `0` | Success |
| `1` | Errors from cronus |
## Code of Conduct
Guidelines to how the cronus organization expects you to behave is documented under [Code of Conduct](./CODE-OF-CONDUCT.md)
___