js-fire

A javascript clone of google/python-fire

CLI
craigmulligan/js-firejs-fire

README

js-fire Node.js CI


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.

Installation


  1. ```
  2. yarn add js-fire
  3. ```

  1. ```
  2. npm install js-fire
  3. ```

js-fire is exposed as both an API and a CLI.

API Usage


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.

  1. ``` js
  2. const fire = require("js-fire");

  4. const calculator = {
  5.   __description__: "I am a math machine",
  6.   double: (number) => {
  7.     // I double things
  8.     return 2 * number;
  9.   },
  10.   add: (n1 = Math.PI, n2) => {
  11.     return n1 + n2;
  12.   },
  13.   misc: {
  14.     year: () => "1999",
  15.     brand: () => "casio",
  16.     hello: (name) => `hello ${name}`,
  17.   },
  18. };

  20. fire(calculator);
  21. ```

Then, from the command line, you can run:

  1. ``` sh
  2. node calculator.js double --number=15  # 30
  3. ```

  1. ``` sh
  2. node calculator.js misc hello hobochild  # 'hello hobochild'
  3. ```

Automactic --help command.

  1. ``` sh
  2. node calculator.js --help

  4. USAGE:
  5. node calculator.js

  7. DESCRIPTION:
  8. I am a math machine

  10. COMMANDS:

  12. half  --number=<number>
  13. double  --number=<number>
  14. add  --n1=3.141592653589793  --n2=<n2>

  16. misc
  17.   year
  18.   brand
  19.   hello  --name=<name>
  20. ```

Automatic --interactive mode:
asciicast

For additional examples, see /examples.

CLI Usage


js-fire exposes a CLI that takes modulePath and passes it to js-fire.

  1. ``` sh
  2. USAGE:
  3. js-fire  --modulePath=<modulePath>
  4. ```

Example


So you can js-fire on _most_ js modules.

  1. ``` sh
  2. js-fire fs -- writeFileSync --path=hello.txt --data="hiii"
  3. ```

You can also use interactive and help mode to explore a modules api:

  1. ``` sh
  2. js-fire fs -- -h

  4. USAGE:
  5. js-fire

  7. COMMANDS:

  9. appendFile <flags> --path=<path>  --data=<data>  --options=<options>  --callback=<callback>
  10. appendFileSync <flags> --path=<path>  --data=<data>  --options=<options>
  11. access <flags> --path=<path>  --mode=<mode>  --callback=<callback>
  12. accessSync <flags> --path=<path>  --mode=<mode>
  13. chown <flags> --path=<path>  --uid=<uid>  --gid=<gid>  --callback=<callback>
  14. chownSync <flags> --path=<path>  --uid=<uid>  --gid=<gid>
  15. chmod <flags> --path=<path>  --mode=<mode>  --callback=<callback>
  16. chmodSync <flags> --path=<path>  --mode=<mode>
  17. close <flags> --fd=<fd>  --callback=<callback>
  18. closeSync <flags> --fd=<fd>
  19. copyFile <flags> --src=<src>  --dest=<dest>  --flags=<flags>  --callback=<callback>
  20. copyFileSync <flags> --src=<src>  --dest=<dest>  --flags=<flags>
  21. createReadStream <flags> --path=<path>  --options=<options>
  22. createWriteStream <flags> --path=<path>  --options=<options>
  23. exists <flags> --path=<path>  --callback=<callback>
  24. existsSync <flags> --path=<path>
  25.   ...
  26. ```