DSLModule

PackageAxial.Process

Summary

NameSignatureSynopsis
(=>)source => destinationConnects a typed input, command, specification, or terminal output endpoint.
cmdcmd commandLineBuilds a command-line-shaped command while preserving every interpolation hole as one argument.
cmdTextcmdText commandLineParses a fixed command line.
pipepipe commandLinesBuilds a vertical specification from safely parsed command templates.
mergemerge commandsCreates line-framed fan-in producers ready to connect to one consumer.
mergeBytesmergeBytes commandsCreates raw-byte fan-in producers with explicitly nondeterministic chunk interleaving.
bashbash programBuilds a Bash program with interpolation values passed as positional arguments.
shsh programBuilds a POSIX shell program with interpolation values passed as positional arguments.
pwshpwsh programBuilds a PowerShell 7 program with interpolation values passed through <c>$args</c>.
bashTextbashText programBuilds an explicitly assembled Bash program.
shTextshText programBuilds an explicitly assembled POSIX shell program.
pwshTextpwshText programBuilds an explicitly assembled PowerShell 7 program.
secretsecret valueMarks an interpolated value for diagnostic redaction.
cwdcwd path commandNo description available.
envenv name value commandNo description available.
stdinstdin source topologySupplies a primary input source to a command or specification.
pipeTopipeTo next sourceConnects stdout from a command or specification to the next command's stdin.
stdoutstdout target sourceConfigures final stdout on the specification.
stderrstderr target sourceConfigures combined stderr on the specification.
timeouttimeout after sourceSets the maximum execution time for a command or specification.
runrun sourceRuns a command or specification in the current Flow runtime.
capturecapture sourceRuns a command or specification and captures stdout and stderr.
consoleconsole sourceForwards stdout and stderr to the host console while retaining structured completion data.
streamstream sourceProduces a bounded stream of structured output and completion events.
pipeBothTopipeBothTo next sourceConnects both stdout and stderr from the current final stage to the next command.
mergeStderrmergeStderr sourceRoutes final stderr through final stdout targets.
writeTowriteTo path sourceWrites final stdout to a truncating file and runs the specification.
appendToappendTo path sourceWrites final stdout to an appending file and runs the specification.
captureParallelcaptureParallel maximumConcurrency commandsCaptures commands concurrently with a fixed upper bound while preserving input order.

(=>)

source => destination
Member
Connects a typed input, command, specification, or terminal output endpoint.

Parameters

NameTypeDescription
source^source
destination^destination

Returns

^result

cmd

cmd commandLine
Member
Builds a command-line-shaped command while preserving every interpolation hole as one argument.

Parameters

NameTypeDescription
commandLineFormattableString

Returns

ProcessSpec

cmdText

cmdText commandLine
Member
Parses a fixed command line. Prefer <c>cmd $"...{value}"</c> whenever values are inserted.

Parameters

NameTypeDescription
commandLinestring

Returns

ProcessSpec

pipe

pipe commandLines
Member
Builds a vertical specification from safely parsed command templates.

Parameters

NameTypeDescription
commandLinesFormattableString seq

Returns

ProcessSpec

merge

merge commands
Member
Creates line-framed fan-in producers ready to connect to one consumer.

Parameters

NameTypeDescription
commandsProcessSpec seq

Returns

ProcessSpec

mergeBytes

mergeBytes commands
Member
Creates raw-byte fan-in producers with explicitly nondeterministic chunk interleaving.

Parameters

NameTypeDescription
commandsProcessSpec seq

Returns

ProcessSpec

bash

bash program
Member
Builds a Bash program with interpolation values passed as positional arguments.

Parameters

NameTypeDescription
programFormattableString

Returns

ProcessSpec

sh

sh program
Member
Builds a POSIX shell program with interpolation values passed as positional arguments.

Parameters

NameTypeDescription
programFormattableString

Returns

ProcessSpec

pwsh

pwsh program
Member
Builds a PowerShell 7 program with interpolation values passed through <c>$args</c>.

Parameters

NameTypeDescription
programFormattableString

Returns

ProcessSpec

bashText

bashText program
Member
Builds an explicitly assembled Bash program. Values in the text are not escaped by Axial.

Parameters

NameTypeDescription
programstring

Returns

ProcessSpec

shText

shText program
Member
Builds an explicitly assembled POSIX shell program. Values in the text are not escaped by Axial.

Parameters

NameTypeDescription
programstring

Returns

ProcessSpec

pwshText

pwshText program
Member
Builds an explicitly assembled PowerShell 7 program. Values in the text are not escaped by Axial.

Parameters

NameTypeDescription
programstring

Returns

ProcessSpec

secret

secret value
Member
Marks an interpolated value for diagnostic redaction.

Parameters

NameTypeDescription
value'a

Returns

SecretArgument

cwd

cwd path command
Member

Parameters

NameTypeDescription
pathstring
commandProcessSpec

Returns

ProcessSpec

env

env name value command
Member

Parameters

NameTypeDescription
namestring
valuestring
commandProcessSpec

Returns

ProcessSpec

stdin

stdin source topology
Member
Supplies a primary input source to a command or specification.

Parameters

NameTypeDescription
sourceInputSource
topologyProcessSpec

Returns

ProcessSpec

pipeTo

pipeTo next source
Member
Connects stdout from a command or specification to the next command's stdin.

Parameters

NameTypeDescription
nextProcessSpec
sourceProcessSpec

Returns

ProcessSpec

stdout

stdout target source
Member
Configures final stdout on the specification.

Parameters

NameTypeDescription
targetOutputTarget
sourceProcessSpec

Returns

ProcessSpec

stderr

stderr target source
Member
Configures combined stderr on the specification.

Parameters

NameTypeDescription
targetOutputTarget
sourceProcessSpec

Returns

ProcessSpec

timeout

timeout after source
Member
Sets the maximum execution time for a command or specification. <example><code>cmd $"service-device" |&gt; timeout (TimeSpan.FromSeconds 30.0) |&gt; capture</code></example>

Parameters

NameTypeDescription
afterTimeSpan
sourceProcessSpec

Returns

ProcessSpec

run

run source
Member
Runs a command or specification in the current Flow runtime.

Parameters

NameTypeDescription
sourceProcessSpec

Returns

Flow<'a, ProcessError, ProcessResult>

capture

capture source
Member
Runs a command or specification and captures stdout and stderr.

Parameters

NameTypeDescription
sourceProcessSpec

Returns

Flow<'a, ProcessError, ProcessResult>

console

console source
Member
Forwards stdout and stderr to the host console while retaining structured completion data.

Parameters

NameTypeDescription
sourceProcessSpec

Returns

Flow<'a, ProcessError, ProcessResult>

stream

stream source
Member
Produces a bounded stream of structured output and completion events.

Parameters

NameTypeDescription
sourceProcessSpec

Returns

FlowStream<'a, ProcessError, ProcessEvent>

pipeBothTo

pipeBothTo next source
Member
Connects both stdout and stderr from the current final stage to the next command.

Parameters

NameTypeDescription
nextProcessSpec
sourceProcessSpec

Returns

ProcessSpec

mergeStderr

mergeStderr source
Member
Routes final stderr through final stdout targets.

Parameters

NameTypeDescription
sourceProcessSpec

Returns

ProcessSpec

writeTo

writeTo path source
Member
Writes final stdout to a truncating file and runs the specification.

Parameters

NameTypeDescription
pathstring
sourceProcessSpec

Returns

Flow<'a, ProcessError, ProcessResult>

appendTo

appendTo path source
Member
Writes final stdout to an appending file and runs the specification.

Parameters

NameTypeDescription
pathstring
sourceProcessSpec

Returns

Flow<'a, ProcessError, ProcessResult>

captureParallel

captureParallel maximumConcurrency commands
Member
Captures commands concurrently with a fixed upper bound while preserving input order.

Parameters

NameTypeDescription
maximumConcurrencyint
commandsProcessSpec seq

Returns

Flow<'a, ProcessError, ProcessResult list>