Execute e obtenha a saída de um comando shell em node.js

Em um node.js, gostaria de encontrar uma maneira de obter a saída de um comando de terminal Unix. Há alguma maneira de fazer isso?

function getCommandOutput(commandString){
    // now how can I implement this function?
    // getCommandOutput("ls") should print the terminal output of the shell command "ls"
}

É assim que faço em um projeto em que estou trabalhando agora.

var exec = require('child_process').exec;
function execute(command, callback){
    exec(command, function(error, stdout, stderr){ callback(stdout); });
};

Exemplo: Recuperando o usuário git

module.exports.getGitUser = function(callback){
    execute("git config --global user.name", function(name){
        execute("git config --global user.email", function(email){
            callback({ name: name.replace("\n", ""), email: email.replace("\n", "") });
        });
    });
};

Você está procurando child_process

var exec = require('child_process').exec;
var child;

child = exec(command,
   function (error, stdout, stderr) {
      console.log('stdout: ' + stdout);
      console.log('stderr: ' + stderr);
      if (error !== null) {
          console.log('exec error: ' + error);
      }
   });

Como apontado por Renato, existem alguns pacotes exec síncronos por aí agora também, veja sync-exec que pode ser mais o que você está procurando. Lembre-se, porém, de que o node.js foi projetado para ser um servidor de rede de alto desempenho com thread único, então, se é para isso que você está procurando, fique longe de coisas do tipo sync-exec, a menos que você o use apenas durante a inicialização ou alguma coisa.

Se você está usando o node posterior a 7.6 e não gosta do estilo de retorno de chamada, você também pode usar a promisifyfunção do node-util com async / awaitpara obter comandos shell que sejam lidos de forma limpa. Aqui está um exemplo de resposta aceita, usando esta técnica:

const { promisify } = require('util');
const exec = promisify(require('child_process').exec)

module.exports.getGitUser = async function getGitUser () {
  const name = await exec('git config --global user.name')
  const email = await exec('git config --global user.email')
  return { name, email }
};

Isso também tem o benefício adicional de retornar uma promessa rejeitada em comandos com falha, que pode ser tratada try / catchdentro do código assíncrono.

Graças à resposta do Renato, criei um exemplo realmente básico:

const exec = require('child_process').exec

exec('git config --global user.name', (err, stdout, stderr) => console.log(stdout))

Ele apenas imprimirá seu nome de usuário git global :)

Requisitos

Isso exigirá Node.js 7 ou posterior com suporte para Promises e Async / Await.

Solução

Crie uma função de wrapper que aproveite as promessas de controlar o comportamento do child_process.execcomando.

Explicação

Usando promessas e uma função assíncrona, você pode imitar o comportamento de um shell retornando a saída, sem cair em um inferno de callback e com uma API bem organizada. Usando a awaitpalavra - chave, você pode criar um script de fácil leitura e, ao mesmo tempo, realizar o trabalho child_process.exec.

Amostra de código

const childProcess = require("child_process");

/**
 * @param {string} command A shell command to execute
 * @return {Promise<string>} A promise that resolve to the output of the shell command, or an error
 * @example const output = await execute("ls -alh");
 */
function execute(command) {
  /**
   * @param {Function} resolve A function that resolves the promise
   * @param {Function} reject A function that fails the promise
   * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
   */
  return new Promise(function(resolve, reject) {
    /**
     * @param {Error} error An error triggered during the execution of the childProcess.exec command
     * @param {string|Buffer} standardOutput The result of the shell command execution
     * @param {string|Buffer} standardError The error resulting of the shell command execution
     * @see https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback
     */
    childProcess.exec(command, function(error, standardOutput, standardError) {
      if (error) {
        reject();

        return;
      }

      if (standardError) {
        reject(standardError);

        return;
      }

      resolve(standardOutput);
    });
  });
}

Uso

async function main() {
  try {
    const passwdContent = await execute("cat /etc/passwd");

    console.log(passwdContent);
  } catch (error) {
    console.error(error.toString());
  }

  try {
    const shadowContent = await execute("cat /etc/shadow");

    console.log(shadowContent);
  } catch (error) {
    console.error(error.toString());
  }
}

main();

Saída de amostra

root:x:0:0::/root:/bin/bash
[output trimmed, bottom line it succeeded]

Error: Command failed: cat /etc/shadow
cat: /etc/shadow: Permission denied

Experimente online.

Repl.it .

Fontes externas

Promessas .

child_process.exec.

Mesa de apoio Node.js .