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

Proc

Module to start or run processes, used in combination with the CreateProcess API.

Example

1: 
2: 
3: 
4: 
5: 
6: 

#r "paket: 
nuget Fake.Core.Process //"
open Fake.Core
CreateProcess.fromRawCommand "./folder/mytool.exe" ["arg1"; "arg2"]
|> Proc.run
|> ignore
namespace Fake
namespace Fake.Core
Multiple items
module CreateProcess

from Fake.Core.CreateProcessExt

--------------------
module CreateProcess

from Fake.Core

--------------------
type CreateProcess<'TRes> =
  private { Command: Command
            TraceCommand: bool
            WorkingDirectory: string option
            Environment: EnvMap option
            Streams: StreamSpecs
            Hook: IProcessHook<'TRes> }
    member CommandLine : string
val fromRawCommand : command:FilePath -> args:seq<string> -> CreateProcess<ProcessResult<unit>>
module Proc

from Fake.Core
val run : c:CreateProcess<'a> -> 'a
val ignore : value:'T -> unit

Functions and values

Function or valueDescription
Proc.run(c)
Signature: c:CreateProcess<'a> -> 'a
Type parameters: 'a

Like start but waits for the result synchronously.
Proc.start(c)
Signature: c:CreateProcess<'?17604> -> Task<'?17604>
Type parameters: '?17604

Starts the given process and waits for the Result task. (see startRaw documentation). In most common scenarios the Result includes the Raw task or the exit-code one way or another.
Proc.startAndAwait(c)
Signature: c:CreateProcess<'?17606> -> Async<'?17606>
Type parameters: '?17606

Convenience method when you immediatly want to await the result of 'start', just note that when used incorrectly this might lead to race conditions (ie if you use StartAsTask and access reference cells in CreateProcess after that returns)
Proc.startRaw(c)
Signature: c:CreateProcess<'?17600> -> Task<AsyncProcessResult<'?17600>>
Type parameters: '?17600

Starts a process. The process has been started successfully after the returned task has been completed. After the task has been completed you retrieve two other tasks: - One Raw-Task to indicate when the process exited (and return the exit-code for example) - One Result-Task for the final result object.

Note: The Result task might finish while the Raw task is still running, this enables you to work with the result object before the process has exited. For example consider a long running process where you are only interested in the first couple of output lines
Proc.startRawSync(c)
Signature: c:CreateProcess<'?17602> -> AsyncProcessResult<'?17602>
Type parameters: '?17602

Similar to startRaw but waits until the process has been started.