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

Commands and composition

Describe commands, arguments, and pipelines before execution.

DSLInputOutputEndpointConnectorStageDefaultsInputSourceProcessCommandProcessInputProcessSpecSecretArgument

Execution and host services

Run process workflows and provide live or test process services.

ProcessRunnerProcessHostEnvironmentIHasProcessIProcessTestProcessTestProcessHostEnvironment

Output and streaming

Capture, route, and consume process output.

ProcessStreamCapturedOutputOutputChannelOutputFramingOutputRetentionOutputTargetProcessCompletionProcessOutputProcessStreamError<'error>

Results and failures

Inspect successful results, process plans, and expected failures.

ProcessErrorProcessIoFailureProcessLineFailureProcessObservationFailureProcessOutputFailureProcessPlanProcessResultProcessRunException<'error>ProcessStagePlanProcessStageTimeoutProcessStartFailureProcessTimeoutStageFailureStageResult

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