@types/shelljs

call signature

(files: string[]): ShellString;

• Returns a string containing the given file, or a concatenated string containing the files if more than one file is given (a new line character is introduced between each file).

  Parameter files

  Files to use. Wildcard * accepted. A string containing the given file, or a concatenated string containing the files if more than one file is given (a new line character is introduced between each file).

call signature

(...files: string[]): ShellString;

call signature

(options: string, mode: string | number, file: string): ShellString;

• Alters the permissions of a file or directory by either specifying the absolute permissions in octal form or expressing the changes in symbols.

  This command tries to mimic the POSIX behavior as much as possible.

  Notable exceptions: - In symbolic modes, 'a-r' and '-r' are identical. No consideration is given to the umask. - There is no "quiet" option since default behavior is to run silent.

  Parameter options

  Available options: - -v: output a diagnostic for every file processed - -c: like -v but report only when a change is made - -R: change files and directories recursively

  Parameter mode

  The access mode. Can be an octal string or a symbolic mode string.

  Parameter file

  The file to use. Object with shell exit code, stderr and stdout.

call signature

(mode: string | number, file: string): ShellString;

• Alters the permissions of a file or directory by either specifying the absolute permissions in octal form or expressing the changes in symbols.

  This command tries to mimic the POSIX behavior as much as possible.

  Notable exceptions: - In symbolic modes, 'a-r' and '-r' are identical. No consideration is given to the umask. - There is no "quiet" option since default behavior is to run silent.

  Parameter mode

  The access mode. Can be an octal string or a symbolic mode string.

  Parameter file

  The file to use. Object with shell exit code, stderr and stdout.

call signature

(arg1: string, ...args: [...string[], string | CmdOptions]): ShellString;

property cwd

cwd?: string;

• Change the current working directory only for this cmd() invocation.

  process.cwd()

property maxBuffer

maxBuffer?: number;

• Raise or decrease the default buffer size for stdout/stderr.

  20,971,520 (or 20 * 1024 * 1024)

property timeout

timeout?: number;

• Change the default timeout.

  0

call signature

(options: string, source: string | string[], dest: string): ShellString;

• Copies files. The wildcard * is accepted.

  Parameter options

  Available options: - -f: force (default behavior) - -n: no-clobber - -u: only copy if source is newer than dest - -r, -R: recursive - -L: follow symlinks - -P: don't follow symlinks

  Parameter source

  The source.

  Parameter dest

  The destination. Object with shell exit code, stderr and stdout.

call signature

(source: string | string[], dest: string): ShellString;

• Copies files. The wildcard * is accepted.

  Parameter source

  The source.

  Parameter dest

  The destination. Object with shell exit code, stderr and stdout.

call signature

(options: '-c'): ShellArray;

• Clears the directory stack by deleting all of the elements.

  Parameter options

  Clears the directory stack by deleting all of the elements. Returns an array of paths in the stack, or a single path if +N or -N was specified.

call signature

(options: '+N'): ShellString;

• Displays the list of currently remembered directories.

  Parameter options

  Displays the Nth directory (counting from the left of the list printed by dirs when invoked without options), starting with zero. Returns an array of paths in the stack, or a single path if +N or -N was specified.

call signature

(options: '-N'): ShellString;

• Displays the list of currently remembered directories.

  Parameter options

  Displays the Nth directory (counting from the right of the list printed by dirs when invoked without options), starting with zero. Returns an array of paths in the stack, or a single path if +N or -N was specified.

call signature

(options: string): ShellArray | ShellString;

• Displays the list of currently remembered directories.

  Parameter options

  Available options: - -c: Clears the directory stack by deleting all of the elements. - -N: Displays the Nth directory (counting from the right of the list printed by dirs when invoked without options), starting with zero. - +N: Displays the Nth directory (counting from the left of the list printed by dirs when invoked without options), starting with zero. Returns an array of paths in the stack, or a single path if +N or -N was specified.

call signature

(options: string, ...text: string[]): ShellString;

• Prints string to stdout, and returns string with additional utility methods like .to().

  Parameter options

  Available options: - -e: interpret backslash escapes (default) - -n: remove trailing newline from output

  Parameter text

  The text to print. Returns the string that was passed as argument.

call signature

(...text: string[]): ShellString;

• Prints string to stdout, and returns string with additional utility methods like .to().

  Parameter text

  The text to print. Returns the string that was passed as argument.

call signature

(command: string): ShellString;

• Executes the given command synchronously.

  Parameter command

  The command to execute. Returns an object containing the return code and output as string.

call signature

(
    command: string,
    options: ExecOptions & { async?: false | undefined }
): ShellString;

• Executes the given command synchronously.

  Parameter command

  The command to execute.

  Parameter options

  Silence and synchronous options. Returns an object containing the return code and output as string, or if {async: true} was passed, a ChildProcess.

call signature

(command: string, options: ExecOptions & { async: true }): child.ChildProcess;

• Executes the given command asynchronously.

  Parameter command

  The command to execute.

  Parameter options

  Silence and synchronous options. Returns an object containing the return code and output as string, or if {async: true} was passed, a ChildProcess.

call signature

(command: string, options: ExecOptions): ShellString | child.ChildProcess;

• Executes the given command.

  Parameter command

  The command to execute.

  Parameter options

  Silence and synchronous options. Returns an object containing the return code and output as string, or if {async: true} was passed, a ChildProcess.

call signature

(
    command: string,
    options: ExecOptions,
    callback: ExecCallback
): child.ChildProcess;

• Executes the given command synchronously.

  Parameter command

  The command to execute.

  Parameter options

  Silence and synchronous options.

  Parameter callback

  Receives code and output asynchronously.

call signature

(command: string, callback: ExecCallback): child.ChildProcess;

• Executes the given command synchronously.

  Parameter command

  The command to execute.

  Parameter callback

  Receives code and output asynchronously.

property async

async?: boolean | undefined;

• Asynchronous execution.

  If a callback is provided, it will be set to true, regardless of the passed value.

  false

property encoding

encoding?: string | undefined;

• Character encoding to use.

  Affects the values returned by stdout and stderr, and what is written to stdout and stderr when not in silent mode

  "utf8"

property fatal

fatal?: boolean | undefined;

• Exit when command return code is non-zero.

  false

property silent

silent?: boolean | undefined;

• Do not echo program output to the console.

  false

property code

code: number;

• The process exit code.

property stderr

stderr: string;

• The process standard error output.

property stdout

stdout: string;

• The process standard output.

call signature

(path: string[]): ShellArray;

• Returns array of all files (however deep) in the given paths.

  Parameter path

  The path(s) to search. An array of all files (however deep) in the given path(s).

call signature

(...path: string[]): ShellArray;

call signature

(options: string, regex_filter: string | RegExp, files: string[]): ShellString;

• Reads input string from given files and returns a string containing all lines of the file that match the given regex_filter. Wildcard * accepted.

  Parameter options

  Available options: - -v: Inverse the sense of the regex and print the lines not matching the criteria. - -l: Print only filenames of matching files

  Parameter regex_filter

  The regular expression to use.

  Parameter files

  The files to process. Returns a string containing all lines of the file that match the given regex_filter.

call signature

(
    options: string,
    regex_filter: string | RegExp,
    ...files: string[]
): ShellString;

call signature

(regex_filter: string | RegExp, files: string[]): ShellString;

• Reads input string from given files and returns a string containing all lines of the file that match the given regex_filter. Wildcard * accepted.

  Parameter regex_filter

  The regular expression to use.

  Parameter files

  The files to process. Returns a string containing all lines of the file that match the given regex_filter.

call signature

(regex_filter: string | RegExp, ...files: string[]): ShellString;

call signature

(options: HeadOptions, files: string[]): ShellString;

call signature

(options: HeadOptions, ...files: string[]): ShellString;

call signature

(files: string[]): ShellString;

call signature

(...files: string[]): ShellString;

property "-n"

'-n': number;

• Show the first lines of the files.

call signature

(options: string, source: string, dest: string): ShellString;

• Links source to dest. Use -f to force the link, should dest already exist.

  Parameter options

  Available options: - -s: Create a symbolic link, defaults to a hardlink - -f: Force creation

  Parameter source

  The source.

  Parameter dest

  The destination. Object with shell exit code, stderr and stdout.

call signature

(source: string, dest: string): ShellString;

• Links source to dest. Use -f to force the link, should dest already exist.

  Parameter source

  The source.

  Parameter dest

  The destination. Object with shell exit code, stderr and stdout.

call signature

(options: string, paths: string[]): ShellArray;

• Returns array of files in the given path, or in current directory if no path provided.

  Parameter options

  Available options: - -R: recursive - -A: all files (include files beginning with ., except for . and ..) - -L: follow symlinks - -d: list directories themselves, not their contents - -l: list objects representing each file, each with fields containing ls -l output fields. See fs.Stats for more info

  Parameter paths

  Paths to search. An array of files in the given path(s).

call signature

(options: string, ...paths: string[]): ShellArray;

call signature

(paths: string[]): ShellArray;

• Returns array of files in the given path, or in current directory if no path provided.

  Parameter paths

  Paths to search. An array of files in the given path(s).

call signature

(...paths: string[]): ShellArray;

call signature

(options: string, dir: string[]): ShellString;

• Creates directories.

  Parameter options

  Available options: - -p: full paths, will create intermediate dirs if necessary

  Parameter dir

  The directories to create. Object with shell exit code, stderr and stdout.

call signature

(options: string, ...dir: string[]): ShellString;

call signature

(dir: string[]): ShellString;

• Creates directories.

  Parameter dir

  Directories to create. Object with shell exit code, stderr and stdout.

call signature

(...dir: string[]): ShellString;

call signature

(options: string, source: string | string[], dest: string): ShellString;

• Moves files. The wildcard * is accepted.

  Parameter options

  Available options: - -f: force (default behavior) - -n: no-clobber

  Parameter source

  The source.

  Parameter dest

  The destination. Object with shell exit code, stderr and stdout.

call signature

(source: string | string[], dest: string): ShellString;

• Moves files. The wildcard * is accepted.

  Parameter source

  The source.

  Parameter dest

  The destination. Object with shell exit code, stderr and stdout.

call signature

(options: string, dir: '+N'): ShellArray;

• When no arguments are given, popd removes the top directory from the stack and performs a cd to the new top directory.

  The elements are numbered from 0 starting at the first directory listed with dirs; i.e., popd is equivalent to popd +0. Returns an array of paths in the stack.

  Parameter options

  Available options: - -n: Suppresses the normal change of directory when removing directories from the stack, so that only the stack is manipulated - -q: Suppresses output to the console.

  Parameter dir

  Removes the Nth directory (counting from the left of the list printed by dirs), starting with zero. Returns an array of paths in the stack.

call signature

(options: string, dir: '-N'): ShellArray;

• When no arguments are given, popd removes the top directory from the stack and performs a cd to the new top directory.

  The elements are numbered from 0 starting at the first directory listed with dirs; i.e., popd is equivalent to popd +0. Returns an array of paths in the stack.

  Parameter options

  Available options: - -n: Suppresses the normal change of directory when removing directories from the stack, so that only the stack is manipulated - -q: Suppresses output to the console.

  Parameter dir

  Removes the Nth directory (counting from the right of the list printed by dirs), starting with zero. Returns an array of paths in the stack.

call signature

(options: string, dir: string): ShellArray;

• When no arguments are given, popd removes the top directory from the stack and performs a cd to the new top directory.

  The elements are numbered from 0 starting at the first directory listed with dirs; i.e., popd is equivalent to popd +0. Returns an array of paths in the stack.

  Parameter options

  Available options: - -n: Suppresses the normal change of directory when removing directories from the stack, so that only the stack is manipulated - -q: Suppresses output to the console.

  Parameter dir

  You can only use -N and +N. Returns an array of paths in the stack.

call signature

(dir: '+N'): ShellArray;

• When no arguments are given, popd removes the top directory from the stack and performs a cd to the new top directory.

  The elements are numbered from 0 starting at the first directory listed with dirs; i.e., popd is equivalent to popd +0. Returns an array of paths in the stack.

  Parameter dir

  Removes the Nth directory (counting from the left of the list printed by dirs), starting with zero. Returns an array of paths in the stack.

call signature

(dir: '-N'): ShellArray;

• When no arguments are given, popd removes the top directory from the stack and performs a cd to the new top directory.

  The elements are numbered from 0 starting at the first directory listed with dirs; i.e., popd is equivalent to popd +0. Returns an array of paths in the stack.

  Parameter dir

  Removes the Nth directory (counting from the right of the list printed by dirs), starting with zero. Returns an array of paths in the stack.

call signature

(dir: string): ShellArray;

• When no arguments are given, popd removes the top directory from the stack and performs a cd to the new top directory.

  The elements are numbered from 0 starting at the first directory listed with dirs; i.e., popd is equivalent to popd +0. Returns an array of paths in the stack.

  Parameter dir

  You can only use -N and +N. Returns an array of paths in the stack.

call signature

(): ShellArray;

• When no arguments are given, popd removes the top directory from the stack and performs a cd to the new top directory.

  The elements are numbered from 0 starting at the first directory listed with dirs; i.e., popd is equivalent to popd +0. Returns an array of paths in the stack.

  Returns an array of paths in the stack.

call signature

(options: string, dir: '+N'): ShellArray;

• Saves the current directory on the top of the directory stack and then cd to dir. With no arguments, pushd exchanges the top two directories.

  Parameter options

  Available options: - -n: Suppresses the normal change of directory when adding directories to the stack, so that only the stack is manipulated - -q: Suppresses output to the console.

  Parameter dir

  Brings the Nth directory (counting from the left of the list printed by dirs, starting with zero) to the top of the list by rotating the stack. Returns an array of paths in the stack.

call signature

(options: string, dir: '-N'): ShellArray;

• Saves the current directory on the top of the directory stack and then cd to dir. With no arguments, pushd exchanges the top two directories.

  Parameter options

  Available options: - -n: Suppresses the normal change of directory when adding directories to the stack, so that only the stack is manipulated - -q: Suppresses output to the console.

  Parameter dir

  Brings the Nth directory (counting from the right of the list printed by dirs, starting with zero) to the top of the list by rotating the stack. Returns an array of paths in the stack.

call signature

(options: string, dir: string): ShellArray;

• Saves the current directory on the top of the directory stack and then cd to dir. With no arguments, pushd exchanges the top two directories.

  Parameter options

  Available options: - -n: Suppresses the normal change of directory when adding directories to the stack, so that only the stack is manipulated - -q: Suppresses output to the console.

  Parameter dir

  Makes the current working directory be the top of the stack, and then executes the equivalent of cd dir. Returns an array of paths in the stack.

call signature

(dir: '+N'): ShellArray;

• Saves the current directory on the top of the directory stack and then cd to dir. With no arguments, pushd exchanges the top two directories.

  Parameter dir

  Brings the Nth directory (counting from the left of the list printed by dirs, starting with zero) to the top of the list by rotating the stack. Returns an array of paths in the stack.

call signature

(dir: '-N'): ShellArray;

• Saves the current directory on the top of the directory stack and then cd to dir. With no arguments, pushd exchanges the top two directories.

  Parameter dir

  Brings the Nth directory (counting from the right of the list printed by dirs, starting with zero) to the top of the list by rotating the stack. Returns an array of paths in the stack.

call signature

(dir: string): ShellArray;

• Saves the current directory on the top of the directory stack and then cd to dir. With no arguments, pushd exchanges the top two directories.

  Parameter dir

  Makes the current working directory be the top of the stack, and then executes the equivalent of cd dir. Returns an array of paths in the stack.

call signature

(): ShellArray;

• Saves the current directory on the top of the directory stack and then cd to dir. With no arguments, pushd exchanges the top two directories.

  Returns an array of paths in the stack.

call signature

(options: string, files: string[]): ShellString;

• Removes files. The wildcard * is accepted.

  Parameter options

  Available options: - -f: force - -r, -R: recursive

  Parameter files

  Files to remove. Object with shell exit code, stderr and stdout.

call signature

(options: string, ...files: string[]): ShellString;

call signature

(files: string[]): ShellString;

• Removes files. The wildcard * is accepted.

  Parameter files

  Files to remove. Object with shell exit code, stderr and stdout.

call signature

(...files: string[]): ShellString;

call signature

(
    options: string,
    searchRegex: string | RegExp,
    replacement: string,
    files: string[]
): ShellString;

• Reads an input string from file and performs a JavaScript replace() on the input using the given search regex and replacement string or function.

  Parameter options

  Available options: - -i: Replace contents of 'file' in-place. Note that no backups will be created!

  Parameter searchRegex

  The regular expression to use for search.

  Parameter replacement

  The replacement.

  Parameter files

  The files to process. The new string after replacement.

call signature

(
    options: string,
    searchRegex: string | RegExp,
    replacement: string,
    ...files: string[]
): ShellString;

call signature

(
    searchRegex: string | RegExp,
    replacement: string,
    files: string[]
): ShellString;

• Reads an input string from file and performs a JavaScript replace() on the input using the given search regex and replacement string or function.

  Parameter searchRegex

  The regular expression to use for search.

  Parameter replacement

  The replacement.

  Parameter files

  The files to process. The new string after replacement.

call signature

(
    searchRegex: string | RegExp,
    replacement: string,
    ...files: string[]
): ShellString;

property execPath

execPath: string | null;

• Absolute path of the Node binary. Default is null (inferred).

property fatal

fatal: boolean;

• If true the script will die on errors. Default is false.

property globOptions

globOptions: glob.IOptions;

• Passed to glob.sync() instead of the default options ({}).

property silent

silent: boolean;

• Suppresses all command output if true, except for echo() calls. Default is false.

property verbose

verbose: boolean;

• Will print each executed command to the screen.

  false

method reset

reset: () => void;

• Reset shell.config to the defaults.

property cat

cat: CatFunction;

• Returns a string containing the given pipeline, or a concatenated string containing the pipelines if more than one input stream is given (a new line character is introduced between each input).

  A string containing the given pipeline, or a concatenated string containing the pipelines if more than one input stream is given (a new line character is introduced between each input).

property exec

exec: ExecFunction;

• Executes the given command.

  Parameter command

  The command to execute.

  Parameter options

  Silence and synchronous options.

  Parameter callback

  Receives code and output asynchronously. Returns an object containing the return code and output as string, or if {async: true} or a callback was passed, a ChildProcess.

property grep

grep: GrepFunction;

• Reads input string from given files and returns a string containing all lines of the file that match the given regex_filter. Wildcard * accepted.

  Parameter options

  Available options: - -v: Inverse the sense of the regex and print the lines not matching the criteria. - -l: Print only filenames of matching files

  Parameter regex_filter

  The regular expression to use. Returns a string containing all lines of the file that match the given regex_filter.

property head

head: HeadFunction;

• Read the start of a pipeline input.

property sed

sed: SedFunction;

• Reads an input string from pipeline and performs a JavaScript replace() on the input using the given search regex and replacement string or function.

  Parameter options

  Available options: - -i: Replace contents of 'file' in-place. Note that no backups will be created!

  Parameter searchRegex

  The regular expression to use for search.

  Parameter replacement

  The replacement. The new string after replacement.

property sort

sort: SortFunction;

• Return the contents of the pipeline, sorted line-by-line.

  Parameter options

  Available options: - -r: Reverse the results - -n: Compare according to numerical value

property tail

tail: TailFunction;

• Read the end of a pipeline input.

property uniq

uniq: UniqFunction;

• Filter adjacent matching lines from input.

  Parameter options

  Available options: - -i: Ignore case while comparing - -c: Prefix lines by the number of occurrences - -d: Only print duplicate lines, one for each group of identical lines

method to

to: (file: string) => void;

• Analogous to the redirection operator > in Unix, but works with JavaScript strings (such as those returned by cat, grep, etc).

  Like Unix redirections, to() will overwrite any existing file!

  Parameter file

  The file to use.

method toEnd

toEnd: (file: string) => void;

• Analogous to the redirect-and-append operator >> in Unix, but works with JavaScript strings (such as those returned by cat, grep, etc).

  Parameter file

  The file to append to.

construct signature

new (value: string): ShellString;

• Wraps a string (or array) value. This has all the string (or array) methods, but also exposes extra methods: .to(), .toEnd(), and all the pipe-able methods (ex. .cat(), .grep(), etc.).

  This can be easily converted into a string by calling .toString().

  This type also exposes the corresponding command's stdout, stderr, and return status code via the .stdout (string), .stderr (string), and .code (number) properties respectively.

  Construct signature allows for:

  var foo = new ShellString('hello world');

  as per example in shelljs docs: https://github.com/shelljs/shelljs#shellstringstr

  Parameter value

  The string value to wrap. A string-like object with special methods.

construct signature

new (value: string[]): ShellArray;

call signature

(value: string): ShellString;

• Wraps a string (or array) value. This has all the string (or array) methods, but also exposes extra methods: .to(), .toEnd(), and all the pipe-able methods (ex. .cat(), .grep(), etc.).

  This can be easily converted into a string by calling .toString().

  This type also exposes the corresponding command's stdout, stderr, and return status code via the .stdout (string), .stderr (string), and .code (number) properties respectively.

  Parameter value

  The string value to wrap. A string-like object with special methods.

call signature

(value: string[]): ShellArray;

call signature

(options: string, files: string[]): ShellString;

• Return the contents of the files, sorted line-by-line. Sorting multiple files mixes their content (just as unix sort does).

  Parameter options

  Available options: - -r: Reverse the results - -n: Compare according to numerical value

call signature

(options: string, ...files: string[]): ShellString;

call signature

(files: string[]): ShellString;

• Return the contents of the files, sorted line-by-line. Sorting multiple files mixes their content (just as unix sort does).

call signature

(...files: string[]): ShellString;

call signature

(options: TailOptions, files: string[]): ShellString;

call signature

(options: TailOptions, ...files: string[]): ShellString;

call signature

(files: string[]): ShellString;

call signature

(...files: string[]): ShellString;

property "-n"

'-n': number;

• Show the last lines of files.

call signature

(options: TouchOptionsLiteral | TouchOptionsArray, files: string[]): ShellString;

call signature

(
    options: TouchOptionsLiteral | TouchOptionsArray,
    ...files: string[]
): ShellString;

call signature

(files: string[]): ShellString;

call signature

(...files: string[]): ShellString;

property "-d"

'-d'?: string | undefined;

property "-r"

'-r'?: string | undefined;

call signature

(options: string, input: string, output?: string): ShellString;

• Filter adjacent matching lines from input.

  Parameter options

  Available options: - -i: Ignore case while comparing - -c: Prefix lines by the number of occurrences - -d: Only print duplicate lines, one for each group of identical lines

call signature

(input: string, output?: string): ShellString;

• Filter adjacent matching lines from input.