An independent "Command Line Argument" language based on the tokens recived from process.argv
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
source
.gitignore
.npmignore
LICENSE
README.md
package.json
tsconfig.json

README.md

Clavinet

Clavinet is a command line argument parser with it's own language rules. It joins the given process.argv into a string and then parses it with it's own language grammar.

Language

Clavinet has these concepts:

  • Commands — Commands start with double dashes as --some-command-name and they can have a value after them separated by spaces like: --say hello, or --add [2, 3, 5]
  • Values — Values are Literals or Arrays
  • Array — Array is made of a sequence of Values separated by , and inside of square bracket. For example: [1, 2, 4, hello, [1, 3]]
  • Literals — Literals are numbers and words in this format: [a-zA-Z0-9_\./][a-zA-Z0-9_\.\-/]*

Building

You need to run npm install to install all the dependencies and you must have TypeScript installed on your system. After that you can build the package using

npm run build

How to use it?

First install it via

npm install --save clavinet

Then use it as:

const clavinet = require('clavinet')
const args = clavinet.Parse( )