The utility tool to create powerful command line tools
OTHER License
The utility tool to create powerful command line tools
$ npm i bin-tool
For example with annotations, see example
/path/to/project
|-- cli.js
|-- commands
|-- serve.js
|-- package.json
cli.js
const {Command} = require('bin-tool')
const path = require('path')
class Bin extends Command {
constructor () {
super()
this.load(path.join(__dirname, 'commands'))
}
}
new Bin().start()
serve.js
const {Command} = require('bin-tool')
module.exports = class extends Command {
constructor () {
super()
this.options = {
port: {
type: 'number',
default: 3000,
description: 'port to bind on'
}
}
}
run ({argv}) {
serve(argv.port)
}
}
package.json
{
"name": "bin",
"bin": {
"bin": "./cli"
}
}
npm link
bin serve --port 8080
Array
specify the process argvIn most cases, we leave the argv
unspecified to use the default value process.argv
except for test purpose.
string
the full absolute path of the directory that contains sub commandsLoad subtle commands
number
Set the offset of process.argv
defaults to 2
object
Set the options of the command
string
Set the usage of the command
string
Set the semantic version of the command
process.cwd()
object
the parsed argv objectArray
the raw process argvThe method to override to define the behavior of the current command. If the method is not overridden, it will showHelp()
The argv
object has a special argv.__
property which contains the arguments after '--'
string
the alias name of the commandstring
the original command nameAdd an alias name for a command commandName
Start the command
Handle an error
Print help message of the current command to stdout