Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

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
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

The SCP parameter type.

Functions and values

Function or valueDescription
SCP setParams source target
Signature: setParams:(SCPParams -> SCPParams) -> source:string -> target:string -> unit
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

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
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

The SCP default parameters