AxialAxial
  • Docs
  • Packages
  • GitHub
  • Axial.Process
    • Axial
    • Axial.Process
    • Axial.HttpClient
    • Packages
  • 0.11.1
    • 0.11.3
    • 0.11.2
    • 0.11.1
    • 0.11.0
    • 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

Axial.Process

DSLInputOutputEndpointConnectorProcessRunnerProcessErrorProcessHostEnvironmentProcessStreamStageDefaultsCapturedOutputIHasProcessIProcessInputSourceOutputChannelOutputFramingOutputRetentionOutputTargetProcessCommandProcessCompletionProcessInputProcessIoFailureProcessLineFailureProcessObservationFailureProcessOutputProcessOutputFailureProcessPlanProcessResultProcessRunException<'error>ProcessSpecProcessStagePlanProcessStageTimeoutProcessStartFailureProcessStreamError<'error>ProcessTimeoutSecretArgumentStageFailureStageResultTestProcessTestProcessHostEnvironment

On This Page

    Axial.Process

    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
    • DSL recipes
    • FlowStream integration

    API Reference

    • Axial.Process
      • DSL
        • Operations
          • (=>)
          • cmd
          • cmdText
          • pipe
          • mergeStdout
          • mergeStdoutBytes
          • bash
          • sh
          • pwsh
          • bashText
          • shText
          • pwshText
          • secret
          • cwd
          • env
          • stdinFrom
          • stdoutTo
          • stderrTo
          • stdoutToFile
          • stdoutToAppendFile
          • stderrToFile
          • stderrToAppendFile
          • stdinFromText
          • stdinFromBytes
          • stdinFromFile
          • timeout
          • stdoutToConsole
          • stdoutToDiscard
          • stdoutToInheritHandles
          • stderrToConsole
          • stderrToDiscard
          • stderrToInheritHandles
          • stdinFromInheritHandles
          • withoutTimeout
          • framing
          • maxLineLength
          • maxOutputBytes
          • stageDefaults
          • overallTimeout
          • drainTimeout
          • captureAll
          • captureNothing
          • captureStderrAll
          • captureStderrNothing
          • toFlow
          • streamOutputs
          • streamStdout
          • streamStderr
          • streamStdoutLines
          • streamStderrLines
          • mergeStderr
          • captureTail
          • captureStderrTail
          • mapFinalCommand
          • pipeTo
          • pipeStdoutAndStderrTo
          • captureParallelSpecifications
          • captureParallel
        • Input
          • Operations
            • empty
            • text
            • bytes
            • file
            • inheritHandles
            • flowStream
            • stream
        • Output
          • Operations
            • console
            • inheritHandles
            • discard
            • file
            • appendFile
            • callback
            • tee
            • stream
            • textWriter
        • EndpointConnector
          • Operations
            • Connect
            • Connect
            • Connect
            • Connect
            • Connect
            • Connect
      • Process
        • Operations
          • toSpecification
          • ofCommand
          • commandArgs
          • command
          • commandText
          • fileName
          • arguments
          • tryWorkingDirectory
          • environmentVariables
          • acceptedExitCodes
          • arg
          • secretArg
          • workingDirectory
          • environment
          • removeEnvironment
          • encoding
          • successCodes
          • timeout
          • withoutTimeout
          • stdinFrom
          • stdoutTo
          • stderrTo
          • stdoutToConsole
          • stdoutToFile
          • stdoutToAppendFile
          • stdoutToDiscard
          • stdoutToInheritHandles
          • stderrToConsole
          • stderrToFile
          • stderrToAppendFile
          • stderrToDiscard
          • stderrToInheritHandles
          • stdinFromText
          • stdinFromBytes
          • stdinFromFile
          • stdinFromInheritHandles
          • mapFinalCommand
          • connect
          • pipe
          • pipeStdoutAndStderr
          • mergeSpecifications
          • mergeStdout
          • mergeStderr
          • framing
          • maxLineLength
          • maxOutputBytes
          • stageDefaults
          • overallTimeout
          • drainTimeout
          • setCapture
          • captureAll
          • captureTail
          • captureNothing
          • captureStderrAll
          • captureStderrTail
          • captureStderrNothing
          • render
          • planSpecification
          • plan
          • renderPlan
          • service
          • toFlowSpecification
          • toFlow
          • createOutputStream
          • streamOutputs
          • streamStdout
          • streamStderr
          • lineStream
          • streamStdoutLines
          • streamStderrLines
          • live
          • createHost
          • liveHost
          • unwrapRun
          • run
          • runWith
          • tryRun
          • tryRunWith
          • test
        • Runner
          • Operations
            • Run
            • Run
            • Run
            • RunWith
            • RunWith
            • RunWith
            • TryRun
            • TryRun
            • TryRun
            • TryRunWith
            • TryRunWith
            • TryRunWith
      • ProcessError
        • Operations
          • describe
          • exitCode
      • ProcessHostEnvironment
        • Operations
          • live
          • liveWithConsole
          • ofParts
          • test
      • ProcessStream
        • Operations
          • map
          • filter
          • take
          • takeWhile
          • toFlowStream
          • runFold
          • runCollect
          • runDrain
          • runForEach
          • runForEachFlow
          • runFoldFlow
      • StageDefaults
        • Operations
          • empty
          • workingDirectory
          • environment
          • removeEnvironment
          • encoding
          • successCodes
          • timeout
          • stdoutCapture
          • stderrCapture
      • CapturedOutput
        • Representation
          • Text
          • Bytes
          • Truncated
          • Available
      • IHasProcess
        • Operations
          • Process
      • IProcess
        • Operations
          • Execute
      • InputSource
        • Union cases
          • IsFile
          • IsStream
          • IsEmpty
          • IsText
          • IsInherit
          • IsBytes
          • Empty
          • Text
          • Bytes
          • File
          • Inherit
          • Stream
      • OutputChannel
        • Union cases
          • IsStdOut
          • IsStdErr
          • StdOut
          • StdErr
      • OutputFraming
        • Union cases
          • IsChunks
          • IsLines
          • Chunks
          • Lines
      • OutputRetention
        • Union cases
          • IsNothing
          • IsTail
          • IsAll
          • Nothing
          • Tail
          • All
      • OutputTarget
        • Union cases
          • IsConsole
          • IsFile
          • IsAppendFile
          • IsSink
          • IsDiscard
          • IsCallback
          • IsInherit
          • IsSinkFactory
          • IsTee
          • Console
          • Inherit
          • Discard
          • File
          • AppendFile
          • Callback
          • Sink
          • Tee
          • SinkFactory
      • ProcessCommand
      • ProcessCompletion
        • Union cases
          • IsStoppedEarly
          • IsCompleted
          • Completed
          • StoppedEarly
      • ProcessError
        • Union cases
          • IsLineTooLong
          • IsStageFailed
          • IsStageTimedOut
          • IsObservationUnavailable
          • IsStartFailed
          • IsOverallTimedOut
          • IsOutputFailed
          • IsIoFailed
          • IsOutputTooLarge
          • IsInputFailed
          • StartFailed
          • StageTimedOut
          • OverallTimedOut
          • StageFailed
          • IoFailed
          • InputFailed
          • OutputFailed
          • LineTooLong
          • OutputTooLarge
          • ObservationUnavailable
      • ProcessHostEnvironment
        • Representation
          • Process
          • Console
          • Clock
      • ProcessInput
        • Operations
          • Defaults
          • DrainTimeout
          • Framing
          • Map
          • Map
          • MaxLineLength
          • MaxOutputBytes
          • MergeStderr
          • OverallTimeout
          • Render
          • ToSpecification
          • ToSpecification
      • ProcessIoFailure
        • Representation
          • Message
      • ProcessLineFailure
        • Representation
          • Stage
          • OriginalChannel
          • Limit
      • ProcessObservationFailure
        • Representation
          • Stage
          • Channel
      • ProcessOutput
        • Representation
          • Stage
          • ObservedChannel
          • OriginalChannel
          • Text
          • Timestamp
      • ProcessOutputFailure
        • Representation
          • Stage
          • Channel
          • Limit
          • Command
      • ProcessPlan
        • Representation
          • Commands
          • Stages
          • Connections
          • MergeStdErr
          • Framing
          • MaxLineLength
          • MaxOutputBytes
          • OverallTimeout
          • DrainTimeout
      • ProcessResult
        • Representation
          • StdErrCaptureAvailable
          • StdOutCaptureAvailable
          • StdErrTruncated
          • StdOutTruncated
          • ExitCode
          • ExitCodes
          • StdOut
          • StdErr
          • StdOutCapture
          • StdErrCapture
          • Stages
          • StartedAt
          • Duration
      • ProcessRunException<'error>
        • Operations
          • ``.ctor``
          • Cause
      • ProcessSpec
        • Representation
          • Commands
          • Connections
          • Leaves
          • Defaults
          • MergeStdErr
          • Framing
          • MaxLineLength
          • MaxOutputBytes
          • OverallTimeout
          • DrainTimeout
          • Mode
      • ProcessStagePlan
        • Representation
          • Stage
          • Command
          • WorkingDirectory
          • Environment
          • Encoding
          • SuccessCodes
          • Timeout
          • StdIn
          • StdOut
          • StdErr
          • StdOutCapture
          • StdErrCapture
          • Provenance
      • ProcessStageTimeout
        • Representation
          • Stage
          • Command
          • Timeout
      • ProcessStartFailure
        • Representation
          • Command
          • Message
      • ProcessStream<'env, 'value>
      • ProcessStreamError<'error>
        • Union cases
          • IsProcessFailed
          • IsConsumerFailed
          • ProcessFailed
          • ConsumerFailed
      • ProcessTimeout
        • Representation
          • Specification
          • Timeout
      • SecretArgument
      • StageDefaults
        • Representation
          • WorkingDirectory
          • Environment
          • Encoding
          • SuccessCodes
          • Timeout
          • StdOutCapture
          • StdErrCapture
      • StageFailure
        • Representation
          • Stage
          • Result
      • StageResult
        • Representation
          • Stage
          • Command
          • ExitCode
          • Succeeded
          • StartedAt
          • Duration
          • StdOutCapture
          • StdErrCapture
      • TestProcess
        • Operations
          • ``.ctor``
          • Clear
          • RunHandler
          • ExecuteHandler
          • Outputs
          • RunSpecs
          • Result
      • TestProcessHostEnvironment
        • Representation
          • Environment
          • Process
          • Console
          • Clock