Options for a shell execution
Options for a shell execution
(cwd shell-execution-options)
The current working directory of the executed shell. If omitted the tools current workspace root is used.
Returns: string | undefined
The current working directory of the executed shell. If omitted the tools current workspace root is used. **Returns:** `string | undefined`
(env shell-execution-options)
The additional environment of the executed shell. If omitted the parent process' environment is used. If provided it is merged with the parent process' environment.
Returns: { [key: string]: string; } | undefined
The additional environment of the executed shell. If omitted the parent process' environment is used. If provided it is merged with the parent process' environment. **Returns:** `{ [key: string]: string; } | undefined`
(executable shell-execution-options)
The shell executable.
Returns: string | undefined
The shell executable. **Returns:** `string | undefined`
(set-cwd! shell-execution-options value)
The current working directory of the executed shell. If omitted the tools current workspace root is used.
The current working directory of the executed shell. If omitted the tools current workspace root is used.
(set-env! shell-execution-options value)
The additional environment of the executed shell. If omitted the parent process' environment is used. If provided it is merged with the parent process' environment.
The additional environment of the executed shell. If omitted the parent process' environment is used. If provided it is merged with the parent process' environment.
(set-executable! shell-execution-options value)
The shell executable.
The shell executable.
(set-shell-args! shell-execution-options value)
The arguments to be passed to the shell executable used to run the task. Most shells
require special arguments to execute a command. For example bash
requires the -c
argument to execute a command, PowerShell
requires -Command
and cmd
requires both
/d
and /c
.
The arguments to be passed to the shell executable used to run the task. Most shells require special arguments to execute a command. For example `bash` requires the `-c` argument to execute a command, `PowerShell` requires `-Command` and `cmd` requires both `/d` and `/c`.
(set-shell-quoting! shell-execution-options value)
The shell quotes supported by this shell.
The shell quotes supported by this shell.
(shell-args shell-execution-options)
The arguments to be passed to the shell executable used to run the task. Most shells
require special arguments to execute a command. For example bash
requires the -c
argument to execute a command, PowerShell
requires -Command
and cmd
requires both
/d
and /c
.
Returns: string[] | undefined
The arguments to be passed to the shell executable used to run the task. Most shells require special arguments to execute a command. For example `bash` requires the `-c` argument to execute a command, `PowerShell` requires `-Command` and `cmd` requires both `/d` and `/c`. **Returns:** `string[] | undefined`
(shell-quoting shell-execution-options)
The shell quotes supported by this shell.
Returns: ShellQuotingOptions | undefined
The shell quotes supported by this shell. **Returns:** `ShellQuotingOptions | undefined`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close