Note: This API documentation is for FAKE version 4. The migration API documentation can be found here. The API documentation for the new fake 5 modules can be found here

SSHHelper

Conatins a task which allows to perform SSH operations

Nested types and modules

TypeDescription
SSHParams

The SSH parameter type.

Functions and values

Function or valueDescription
SSH setParams command
Signature: setParams:(SSHParams -> SSHParams) -> command:string -> unit

Performs a command via SSH.

Parameters

  • setParams - Function used to manipulate the default SSHParams value.
  • command - The target path. Can be something like user@host:directory/TargetFile or a local path.

Sample

1: 

SSH (fun p -> { p with ToolPath = "tools/ssh.exe" }) command
SSHDefaults
Signature: SSHParams

The SSH default parameters