1
0
Fork 0
toolkit/packages/exec
rindeal 1bc822d91f
exec: fix outdated link in README
The link was a permalink, so it pointed to a very outdated version of the file.
2024-09-11 18:54:44 +02:00
..
__tests__ Audit Fix (#1480) 2023-08-03 16:36:11 -04:00
src Update dependencies 2023-09-08 14:29:27 +00:00
LICENSE.md Add License.md to all npm packages (#548) 2020-08-25 16:26:50 -04:00
README.md exec: fix outdated link in README 2024-09-11 18:54:44 +02:00
RELEASES.md Glob 0.3.0 release (#1056) 2022-04-18 15:49:18 -04:00
package-lock.json Glob 0.3.0 release (#1056) 2022-04-18 15:49:18 -04:00
package.json Glob 0.3.0 release (#1056) 2022-04-18 15:49:18 -04: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']);