Exciting news!Announcing our $4.6M Series Seed. Learn more
Socket
LoveBlogFAQ
Install
Log in

bagofcli

Package Overview
Dependencies
8
Maintainers
1
Versions
24
Issues
File Explorer

Advanced tools

bagofcli

A bag-of-holding containing CLI utility functions.

    2.2.0latest

Version published
Maintainers
1
Yearly downloads
12,004
increased by7.45%

Weekly downloads

Changelog

Source

2.2.0 - 2022-01-29

Added

  • Add GH Actions release-* and publish-*

Changed

  • Set min node engine >= 16.0.0

Readme

Source
Avatar

Build Status Vulnerability Scanning Status Dependencies Status Coverage Status Published Version

Bag Of CLI

Bag Of CLI contains CLI utility functions.

This is handy when you want to have a set of common CLI commands with descriptions, options, help, and example usages, by just defining them in a JSON file. Bag of CLI essentially allows you to define those info in a configuration file instead of code.

Installation

npm install bagofcli

or as a dependency in package.json file:

"dependencies": { "bagofcli": "x.y.z" }

Usage

Commands:

// create conf/commands.json file containing commands configuration { "options": [ { "arg": "-f, --file <file>", "desc": "This is a global option, applicable to all commands." } ], "commands": { "command1": { "desc": "This is the first command", "options": [ { "arg": "-r, --registry <registry>", "desc": "This is a command option, applicable only to command1"} ], "examples": [ "<bin> command1 --registry someregistry" ] }, "command2": { "desc": "This is the second command", "options": [ { "arg": "-d, --debug", "desc": "This is a command option, applicable only to command2"} ], "examples": [ "<bin> command2 --debug" ] } } } // setup command handlers var bag = require('bagofcli'); var actions = { commands: { command1: { action: function (args) { console.log(args.registry); } }, command2: { action: function (args) { console.log(args.debug); } } } }; bag.command(__dirname, actions);

Check out lib/bagofcli.js for more utility functions.

Upgrade

From 0.0.x to 0.1.x .

Update commands.json argument validation rules:

  • notEmpty to required
  • isNumeric to number
  • isEmail to email

Check out iz for available validation rules.

Colophon

Developer's Guide

Build reports:

Keywords

Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc