diff options
| author | Egor Tensin <egor@tensin.name> | 2025-12-16 16:49:47 +0100 |
|---|---|---|
| committer | Egor Tensin <egor@tensin.name> | 2025-12-16 16:49:47 +0100 |
| commit | 1d134f39e7ded438b1de12160f6ec7f99eafb8f7 (patch) | |
| tree | d277bd11747332b962c109b419f95ede150fb6a9 /node_modules/@actions/exec/README.md | |
| parent | workflows/test: upgrade actions (diff) | |
| download | cleanup-path-1d134f39e7ded438b1de12160f6ec7f99eafb8f7.tar.gz cleanup-path-1d134f39e7ded438b1de12160f6ec7f99eafb8f7.zip | |
bump dependencies
Diffstat (limited to '')
| -rw-r--r-- | node_modules/@actions/exec/README.md | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/node_modules/@actions/exec/README.md b/node_modules/@actions/exec/README.md new file mode 100644 index 0000000..53a6bf5 --- /dev/null +++ b/node_modules/@actions/exec/README.md @@ -0,0 +1,57 @@ +# `@actions/exec` + +## Usage + +#### Basic + +You can use this package to execute tools in a cross platform way: + +```js +const exec = require('@actions/exec'); + +await exec.exec('node index.js'); +``` + +#### Args + +You can also pass in arg arrays: + +```js +const exec = require('@actions/exec'); + +await exec.exec('node', ['index.js', 'foo=bar']); +``` + +#### Output/options + +Capture output or specify [other options](https://github.com/actions/toolkit/blob/d9347d4ab99fd507c0b9104b2cf79fb44fcc827d/packages/exec/src/interfaces.ts#L5): + +```js +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: + +```js +const exec = require('@actions/exec'); + +await exec.exec('"/path/to/my-tool"', ['arg1']); +``` |
