1
0
Fork 0
toolkit/packages/exec
eric sciple 895bdd6dd5
remove misleading verbiage (#258)
2019-12-16 12:43:21 -05:00
..
__tests__ Unit test (#236) 2019-12-03 14:18:54 -05:00
src toolrunner should which tool before invoking (#220) 2019-11-18 16:20:01 -05:00
README.md remove misleading verbiage (#258) 2019-12-16 12:43:21 -05:00
RELEASES.md Add RELEASES.md for each package, bump tool-cache to publish (#67) 2019-08-22 13:14:49 -04:00
package-lock.json Update package versions to 1.0.0 (#42) 2019-08-07 12:56:34 -04:00
package.json bump patch version (#239) 2019-12-04 11:03:36 -05:00
tsconfig.json Add exec (#10) 2019-05-28 15:21:45 -04:00

README.md

@actions/exec

Usage

Basic

You can use this package to execute tools in a cross platform way:

const exec = require('@actions/exec');

await exec.exec('node index.js');

Args

You can also pass in arg arrays:

const exec = require('@actions/exec');

await exec.exec('node', ['index.js', 'foo=bar']);

Output/options

Capture output or specify other options:

const exec = require('@actions/exec');

let myOutput = '';
let myError = '';

const options = {};
options.listeners = {
  stdout: (data: Buffer) => {
    myOutput += data.toString();
  },
  stderr: (data: Buffer) => {
    myError += data.toString();
  }
};
options.cwd = './lib';

await exec.exec('node', ['index.js', 'foo=bar'], options);

Exec tools not in the PATH

You can specify the full path for tools not in the PATH:

const exec = require('@actions/exec');

await exec.exec('"/path/to/my-tool"', ['arg1']);