Acid JS - CLI 💻

Create command line tools using a simple yargs wrapper.

✅ Very little setup.

✅ A lot out of the box.

Install

$ npm install -g @acidjs/cli

Usage

Note: A folder named .acid should exist in your projects main direcotry. When you do, you can configure the cli, and start creating your options and commands.

Create a command:

Create a .js file in a directory named .acid/tasks (you can configure this path), then inside the file, export an array with 4 entries:

1. Command (string)
2. Description (string)
3. Builder (function)
4. Handler (function)

1module.exports = [
2    'hello [name]',
3    'An example command',
4    (yargs) => {}, 
5    (argv) => {
6        if(argv.name) console.log(`Hey ${argv.name}!`)
7    }
8]

In the command line:

All the files that live within path.resolve('.acid', config.cli.entry.x) will be registered to yargs. For example, this is what actually gets called upon each valid command (file):

1yargs.command(
2  ...require(
3    path.resolve(
4      '.acid', 
5      config.cli.entry.command, 
6      file
7    )
8  )
9)

Configure

To overwrite defaults, create .acid/config.yml in the root directory of your project. If there is a mistake in your config file, you will be notified.

Defaults:

1cli:
2  help: true
3  color: magenta
4  logErrors: true
5  entry:
6    commands: tasks
7    options: tasks/options

License

MIT License

Copyright (c) 2020 Michael Arakilian

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.