A javascript implementation of google/python-fire

js-fire is a library for automatically generating command line interfaces (CLIs) from most js objects.

• js Fire is a simple way to create a CLI in js.
• js Fire helps with exploring existing code or turning other people's code into a CLI.
• js Fire makes transitioning between Bash and js easier.

yarn add js-fire

npm install js-fire

You can call Fire on any functions and objects:

Here's an example of calling Fire on a object, you can infinitely nest objects to create subcommands.

const fire = require('js-fire')

const calculator = {
  double: number => {
    // I double things
    return 2 * number
  },
  add: (n1 = Math.PI, n2) => {
    return n1 + n2
  },
  misc: {
    year: () => '1999',
    brand: () => 'casio',
    hello: name => `hello ${name}`,
  },
}

fire(calculator)

Then, from the command line, you can run:

node calculator.js double --number=15  # 30

node calculator.js misc hello hobochild  # 'hi hobochild'

Automactic --help command.

node calculator.js --help

USAGE:
	node object.js

COMMANDS:

	half  --number=<number>
	double  --number=<number>
	add  --n1=3.141592653589793  --n2=<n2>

	misc
		year
		brand
		hello  --name=<name>

Automactic --interactive mode:

For additional examples, see /examples.