yax-cli

Yet another command line tool helper, multi-level, and generator using Javascript/Typescript. (By the way my last name is Yax)

Install

npm install yax-cli

Documentation

• Option validation
• Multi-level
• Prompt

Getting started

Main structure

As a example, It uses src as source path.

1repository
2├── src
3│   ├── phone ## relative path 
4│   │   ├──on 
5│   │   │  └── index.ts ## implements CommandInterface
6│   ├── index.ts  ##  Command line Register file

files

Command line register definition file

1#!/usr/bin/env node
2
3import { Register } from 'yax-cli'
4
5new Register({
6  description: 'Phone demo cli',
7  commandsPath: `${__dirname}/phone`, //  Add here your full path to the directory
8  process,  // Procees runtime variable
9});

phone on command definition

1import { CommandInterface } from "yax-cli";
2
3export default class Cmd implements CommandInterface {
4  description = 'Phone turn on';
5  examples = [];
6  validations = [];
7  handler() {
8    console.log('Hello moto!');
9    console.log('Phone turned on :D');
10  }
11};

Executing

1phone on

Output

1Hello moto!
2Phone turned on :D

Show help

1phone --help

output

1USAGE: phone <COMMAND> [OPTIONS]
2DESCRIPTION: Phone demo cli
3COMMANDS:
4  * on
5OPTIONS:
6--help, -h                             (optional) Display help

That's it, I hope this tool can help you :)