msnode-cmd

Node.js commandline/terminal interface.

Simple commandline or terminal interface to allow you to run cli or bash style commands as if you were in the terminal.

Run commands asynchronously, and if needed can get the output as a string.

NPM Stats

npm info :

See npm trends and stats for node-cmd

GitHub info :

Package details websites :

• GitHub.io site. A prettier version of this site.
• NPM Module. The npm page for the node-cmd module.

This work is licenced via the DBAD Public Licence.

Methods

method	arguments	functionality
run	command	runs a command asynchronously
get	command,callback	runs a command asynchronously, when the command is complete all of the stdout will be passed to the callback

Examples

1
2    var cmd=require('node-cmd');
3
4    cmd.get(
5        'pwd',
6        function(err, data, stderr){
7            console.log('the current working dir is : ',data)
8        }
9    );
10
11    cmd.run('touch example.created.file');
12
13    cmd.get(
14        'ls',
15        function(err, data, stderr){
16            console.log('the current dir contains these files :\n\n',data)
17        }
18    );
19
20    cmd.get(
21        `
22            git clone https://github.com/RIAEvangelist/node-cmd.git
23            cd node-cmd
24            ls
25        `,
26        function(err, data, stderr){
27            if (!err) {
28               console.log('the node-cmd cloned dir contains these files :\n\n',data)
29            } else {
30               console.log('error', err)
31            }
32
33        }
34    );
35

With promises

this example by @stephen-last

1
2import Promise from 'bluebird'
3import cmd from 'node-cmd'
4
5const getAsync = Promise.promisify(cmd.get, { multiArgs: true, context: cmd })
6
7getAsync('node -v').then(data => {
8  console.log('cmd data', data)
9}).catch(err => {
10  console.log('cmd err', err)
11})
12

Accessing the CMD Process

If you need PIDs, stdio,stdin, stdout, stderr, etc. access, for use in your code, or cleaning up, @freemany added in some functionality to get a reference to the child process as the returned value of the get and run calls.

Getting Process ID

1
2    var cmd=require('../cmd.js');
3
4    var process=cmd.get('node');
5    console.log(process.pid);
6

Running a python shell from node

1const cmd=require('../cmd.js');
2
3const processRef=cmd.get('python -i');
4let data_line = '';
5
6//listen to the python terminal output
7processRef.stdout.on(
8  'data',
9  function(data) {
10    data_line += data;
11    if (data_line[data_line.length-1] == '\n') {
12      console.log(data_line);
13    }
14  }
15);
16
17const pythonTerminalInput=`primes = [2, 3, 5, 7]
18for prime in primes:
19    print(prime)
20
21`;
22
23//show what we are doing
24console.log(`>>>${pythonTerminalInput}`);
25
26//send it to the open python terminal
27processRef.stdin.write(pythonTerminalInput);
28

Output :

1
2>>>primes = [2, 3, 5, 7]
3for prime in primes:
4    print(prime)
5
6
72
83
95
107
11
12