node-cmd

Node.js commandline/terminal interface.

Simple commandline, terminal, or shell 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 MIT Licence.

Methods

method	arguments	functionality	returns
run	command, callback	runs a command asynchronously	args for callback err,data,stderr
runSync	command	runs a command synchronously	obj {err,data,stderr}

Examples

1
2//*nix
3
4    var cmd=require('node-cmd');
5
6//*nix supports multiline commands
7    
8    cmd.runSync('touch ./example/example.created.file');
9
10    cmd.run(
11        `cd ./example
12ls`,
13        function(err, data, stderr){
14            console.log('examples dir now contains the example file along with : ',data)
15        }
16    );
17

1
2//Windows
3
4    var cmd=require('node-cmd');
5
6//Windows multiline commands are not guaranteed to work try condensing to a single line.
7    
8    const syncDir=cmd.runSync('cd ./example & dir');
9
10    console.log(`
11    
12        Sync Err ${syncDir.err}
13        
14        Sync stderr:  ${syncDir.stderr}
15
16        Sync Data ${syncDir.data}
17    
18    `);
19
20    cmd.run(`dir`,
21        function(err, data, stderr){
22            console.log('the node-cmd dir contains : ',data)
23        }
24    );
25

1
2//clone this repo!
3
4    var cmd=require('node-cmd');
5    
6    const syncClone=cmd.runSync('git clone https://github.com/RIAEvangelist/node-cmd.git');
7
8    console.log(syncClone);
9    

Getting the CMD Process ID

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

Running a python shell from node

1const cmd=require('node-cmd');
2
3const processRef=cmd.run('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