Docs
Packages
GitHub
Axial.Process
Axial
Axial.Process
Axial.HttpClient
Packages
0.9.1
0.10.0
0.9.3
0.9.2
0.9.1
0.9.0
0.8.0
0.7.1
0.7.0
light
dark
Axial.Process
IProcess
Type
Package
Axial.Process
Interprets process specifications as lazy Axial workflows for a concrete host platform.
Specification
Kind
Type
Members
2
Examples
0
Run
Signature
this.Run
Stream
Signature
this.Stream
Summary
Name
Signature
Synopsis
Operations
Run
this.Run
Returns a lazy workflow that runs the specification when composed into a Flow runtime.
Stream
this.Stream
Returns a lazy, backpressured stream of output and completion events.
Operations
kind:member
Run
this.Run
Member
Returns a lazy workflow that runs the specification when composed into a Flow runtime.
Parameters
Name
Type
Description
specification
ProcessSpec
Returns
Flow<
unit
, ProcessError, ProcessResult>
kind:member
Stream
this.Stream
Member
Returns a lazy, backpressured stream of output and completion events.
Parameters
Name
Type
Description
specification
ProcessSpec
Returns
FlowStream<
unit
, ProcessError, ProcessEvent>
Axial.Process
Filter
Overview
Home
API Reference
Docs
Commands and composition
Output capture and destinations
Streaming output
Failures and transcripts
Scripts
Fable
Worked examples
Run a process in an application Flow
API Reference
Axial.Process
DSL
Operations
(=>)
cmd
cmdText
pipe
merge
mergeBytes
bash
sh
pwsh
bashText
shText
pwshText
secret
cwd
env
stdin
pipeTo
stdout
stderr
timeout
toFlow
capture
console
run
runWith
stream
pipeBothTo
mergeStderr
writeTo
appendTo
captureParallel
Input
Operations
empty
text
bytes
file
read
produce
stream
Output
Operations
capture
captureTail
console
inheritHandles
discard
file
appendFile
callback
tee
stream
textWriter
EndpointConnector
Operations
Connect
Connect
Connect
ToSpecification
Process
Operations
commandArgs
command
commandText
fileName
arguments
tryWorkingDirectory
environmentVariables
acceptedExitCodes
arg
secretArg
workingDirectory
environment
removeEnvironment
encoding
successCodes
render
pipe
pipeBoth
merge
stdin
stdout
stderr
mergeStderr
framing
timeout
plan
service
toFlow
capture
console
stream
live
runWith
run
ProcessError
Operations
describe
exitCode
CapturedOutput
Representation
Text
Bytes
Truncated
IHasProcess
Operations
Process
IProcess
Operations
Run
Stream
InputSource
Union cases
IsFile
IsRead
IsEmpty
IsProduce
IsText
IsBytes
Empty
Text
Bytes
File
Read
Produce
OutputChannel
Union cases
IsStdOut
IsStdErr
StdOut
StdErr
OutputFraming
Union cases
IsLines
IsChunks
Chunks
Lines
OutputTarget
Union cases
IsFile
IsCapture
IsSink
IsAppendFile
IsInherit
IsDiscard
IsCallback
IsTee
IsCaptureTail
IsConsole
Capture
CaptureTail
Console
Inherit
Discard
File
AppendFile
Callback
Sink
Tee
ProcessCancellation
Representation
Message
ProcessError
Union cases
IsStageFailed
IsCanceled
IsStartFailed
IsIoFailed
IsTimedOut
StartFailed
TimedOut
Canceled
StageFailed
IoFailed
ProcessEvent
Union cases
IsCompleted
IsOutput
Output
Completed
ProcessHostEnvironment
Representation
Process
Console
ProcessIoFailure
Representation
Message
ProcessOutput
Representation
Stage
Channel
Text
Timestamp
ProcessPlan
Representation
Commands
StdIn
StdOut
StdErr
Connections
MergeStdErr
Framing
Timeout
ProcessResult
Representation
ExitCode
ExitCodes
StdOut
StdErr
StdOutCapture
StdErrCapture
Stages
StartedAt
Duration
ProcessSpec
Representation
Commands
StdIn
StdOut
StdErr
Connections
Leaves
MergeStdErr
Framing
Timeout
ProcessStartFailure
Representation
Command
Message
ProcessTimeout
Representation
Specification
Timeout
SecretArgument
StageFailure
Representation
Stage
Result
StageResult
Representation
Stage
Command
ExitCode
Succeeded
StartedAt
Duration
StdErrTail