aboutsummaryrefslogtreecommitdiff
path: root/node_modules/@actions/exec/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/@actions/exec/README.md')
-rw-r--r--node_modules/@actions/exec/README.md60
1 files changed, 60 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..e3eff74
--- /dev/null
+++ b/node_modules/@actions/exec/README.md
@@ -0,0 +1,60 @@
+# `@actions/exec`
+
+## Usage
+
+#### Basic
+
+You can use this package to execute your tools on the command line 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 use it in conjunction with the `which` function from `@actions/io` to execute tools that are not in the PATH:
+
+```js
+const exec = require('@actions/exec');
+const io = require('@actions/io');
+
+const pythonPath: string = await io.which('python', true)
+
+await exec.exec(`"${pythonPath}"`, ['main.py']);
+```