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

SCPHelper

Conatins a task which allows to perform file copies using SCP, which is based on the Secure Shell (SSH) protocol.

Nested types and modules

TypeDescription
SCPParams

The SCP parameter type.

Functions and values

Function or valueDescription
SCP setParams source target
Signature: setParams:(SCPParams -> SCPParams) -> source:string -> target:string -> unit

Performs a SCP copy from the given source directory to the target path.

Parameters

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

Sample

1: 

SCP (fun p -> { p with ToolPath = "tools/scp.exe" }) source target
SCPDefaults
Signature: SCPParams

The SCP default parameters