A flexible library to create CLIs
--foo bar)--foobar)--foo=bar)-f)--foo bar --foo baz)-abc)-h, --help supportInstall with: npm i -P eclipt
const { eclipt } = require('eclipt');
eclipt('my-awesome-tool', {
description: 'My Awesome Tool can do anything you with', // Optional description
action: input => // optional action for the command
console.log('You have run: %s with following input', input.name, input),
// optional array of supported arguments
// OR single string to allow any number of arguments
args: [ 'MY_ARG_1', 'MY_ARG_2' ],
opts: {
// Any number of options
foo: { flag: true }, // A boolean option
bar: { value: 'value' }, // A regular key and the name for it's value
baz: { multi: true, value: 'value' }, // An array option that can appear multiple times
opt1: { value: 'value', alias: 'o' }, // Aliased option
opt2: { description: 'Does that' } // Optional description
},
commands: {
'command-name': { /* (description?, action?, args?, opts? commands?) */ }
}
});
If you have found any problems with this module, please:
~bug.We will make sure to take a look when time allows us.
If you wish to get that awesome feature or have some advice for us, please:
~proposal.If you have spotted any enhancements to be made and is willing to get your hands dirty about it, fork us and submit your merge request so we can collaborate effectively.
[v0.2.1] - 2021-12-01
FAQs
A complete library to quickly develop CLI programs.
The npm package eclipt receives a total of 47 weekly downloads. As such, eclipt popularity was classified as not popular.
We found that eclipt demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.