@actions/io

@actions/io

Core functions for cli filesystem scenarios

Usage

mkdir -p

Recursively make a directory. Follows rules specified in man mkdir with the -p option specified:

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

await io.mkdirP('path/to/make');

cp/mv

Copy or move files or folders. Follows rules specified in man cp and man mv:

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

// Recursive must be true for directories
const options = { recursive: true, force: false }

await io.cp('path/to/directory', 'path/to/dest', options);
await io.mv('path/to/file', 'path/to/dest');

rm -rf

Remove a file or folder recursively. Follows rules specified in man rm with the -r and -f rules specified.

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

await io.rmRF('path/to/directory');
await io.rmRF('path/to/file');

which

Get the path to a tool and resolves via paths. Follows the rules specified in man which.

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

const pythonPath: string = await io.which('python', true)

await exec.exec(`"${pythonPath}"`, ['main.py']);

Similar packages

Other packages similar to @actions/io

fs-extra

fs-extra is a package that extends the native Node.js fs module with additional methods for file system operations. It provides similar functionalities to @actions/io, such as copying, moving, and removing files and directories, but it is more general-purpose and not specifically designed for GitHub Actions.

shelljs

shelljs is a portable Unix shell commands for Node.js. It provides a wide range of file system operations, including copying, moving, and removing files and directories. It is more versatile and can be used in various environments, not just GitHub Actions.

node-fs

node-fs is an extension to the built-in fs module, providing additional file system methods. It offers functionalities similar to @actions/io, such as creating directories and copying files, but it is less focused on GitHub Actions and more on general Node.js applications.