Skip to content

Latest commit

 

History

History
50 lines (39 loc) · 1.88 KB

API.md

File metadata and controls

50 lines (39 loc) · 1.88 KB

Functions

remoteExecSync(remote, cmd, options)ExecuteResult

Execute one or multiple commands remotely.

Typedefs

ExecuteResult : Object

remoteExecSync(remote, cmd, options) ⇒ ExecuteResult

Execute one or multiple commands remotely.

Kind: global function
Returns: ExecuteResult - Execution result.

Param Type Default Description
remote object | string An object describing the remote. If a string is given, it is used as the remote host name.
remote.host string "'127.0.0.1'" Remote host name.
remote.user string "'root'" Remote user.
cmd string | Array.<string> One or more commands to execute.
options object Optional configurable options.
options.cwd string Work directory for child_process.execSync.
options.remoteCwd string Work directory for remote.
options.log string Path for the local log file.
options.remoteLog string Path for the remote log file.
options.stdout boolean Whether to print the commands to stdout.

ExecuteResult : Object

Kind: global typedef
Properties

Name Type
stdout string
stderr string
status number
signal string
error Error