cmd-executor

Tiny proxy object to execute arbitrary CLI commands. All calls return a promise.

Installation

1npm i cmd-executor -S

Usage

1const cmd = require('cmd-executor')
2
3// all calls return a promise, so you should wait for them to complete
4// before executing another command. You can use `.then()` or `await`.
5;(async () => {
6
7  // any attributes/functions/parameters you call on `cmd` will be parsed
8  // into a command string and executed. For example:
9
10  // will call `touch a.txt`
11  await cmd.touch('a.txt')
12
13  // will call `echo "hello, world!" > a.txt`
14  await cmd.echo('"hello, world!" > a.txt')
15
16  // since the attributes/functions are arbitrary, these are
17  // functionally equivalent to the above line:
18  //   await cmd.echo["hello, world!"]('> a.txt')
19  //   await cmd.echo['"hello, world!"']['>']('a.txt')
20
21  // only the last attribute can be called as a function
22  // so this will not work:
23  //   await cmd.echo('"hello, world!"')['>']('a.txt')
24
25  // any text the cli would print out is resolved by the promise
26  const output = await cmd.cat('a.txt')
27  console.log(output) // "hello, world!\n"
28
29  // any errors will be rejected by the promise which you can catch
30  // (or `.catch()` if not using `async`/`await`)
31  try {
32    await cmd.mkdir('a.txt')
33  } catch (e) {
34    console.log(e) // error contains "mkdir: a.txt: File exists"
35  }
36
37  // clean up the file
38  await cmd.rm('a.txt')
39})()

Advanced Usage

1// lets say you wanted a promise wrapper around `git`, you
2// could easily do this with cmd-executor
3const git = require('cmd-executor').git
4
5// and now you have complete access to the git CLI
6;(async () => {
7  await git.init()
8  await git.add('.')
9  await git.remote.add('origin', url)
10  await git.commit('-m "Initial commit"')
11})()
12
13// destructuring also works for whatever commands you want
14const { mkdir, touch, echo, cat, rm } = require('cmd-executor')
15
16;(async () => {
17  await mkdir('bork')
18  await touch('bork/file')
19  await echo('"hi!" > bork/file')
20  console.log(await cat('bork/file'))
21  await rm('-rf bork')
22})()