DSLModule
PackageAxial.Process
Summary
| Name | Signature | Synopsis |
|---|---|---|
| (=>) | source => destination | Connects a typed input, command, specification, or terminal output endpoint. |
| cmd | cmd commandLine | Builds a command-line-shaped command while preserving every interpolation hole as one argument. |
| cmdText | cmdText commandLine | Parses a fixed command line. |
| pipe | pipe commandLines | Builds a vertical specification from safely parsed command templates. |
| merge | merge commands | Creates line-framed fan-in producers ready to connect to one consumer. |
| mergeBytes | mergeBytes commands | Creates raw-byte fan-in producers with explicitly nondeterministic chunk interleaving. |
| bash | bash program | Builds a Bash program with interpolation values passed as positional arguments. |
| sh | sh program | Builds a POSIX shell program with interpolation values passed as positional arguments. |
| pwsh | pwsh program | Builds a PowerShell 7 program with interpolation values passed through <c>$args</c>. |
| bashText | bashText program | Builds an explicitly assembled Bash program. |
| shText | shText program | Builds an explicitly assembled POSIX shell program. |
| pwshText | pwshText program | Builds an explicitly assembled PowerShell 7 program. |
| secret | secret value | Marks an interpolated value for diagnostic redaction. |
| cwd | cwd path command | No description available. |
| env | env name value command | No description available. |
| stdin | stdin source topology | Supplies a primary input source to a command or specification. |
| pipeTo | pipeTo next source | Connects stdout from a command or specification to the next command's stdin. |
| stdout | stdout target source | Configures final stdout on the specification. |
| stderr | stderr target source | Configures combined stderr on the specification. |
| timeout | timeout after source | Sets the maximum execution time for a command or specification. |
| run | run source | Runs a command or specification in the current Flow runtime. |
| capture | capture source | Runs a command or specification and captures stdout and stderr. |
| console | console source | Forwards stdout and stderr to the host console while retaining structured completion data. |
| stream | stream source | Produces a bounded stream of structured output and completion events. |
| pipeBothTo | pipeBothTo next source | Connects both stdout and stderr from the current final stage to the next command. |
| mergeStderr | mergeStderr source | Routes final stderr through final stdout targets. |
| writeTo | writeTo path source | Writes final stdout to a truncating file and runs the specification. |
| appendTo | appendTo path source | Writes final stdout to an appending file and runs the specification. |
| captureParallel | captureParallel maximumConcurrency commands | Captures commands concurrently with a fixed upper bound while preserving input order. |
Connects a typed input, command, specification, or terminal output endpoint.
Parameters
| Name | Type | Description |
|---|---|---|
| source | ^source | |
| destination | ^destination |
Returns
^result
Builds a command-line-shaped command while preserving every interpolation hole as one argument.
Parameters
| Name | Type | Description |
|---|---|---|
| commandLine | FormattableString |
Returns
ProcessSpec
Parses a fixed command line. Prefer <c>cmd $"...{value}"</c> whenever values are inserted.
Parameters
| Name | Type | Description |
|---|---|---|
| commandLine | string |
Returns
ProcessSpec
Builds a vertical specification from safely parsed command templates.
Parameters
| Name | Type | Description |
|---|---|---|
| commandLines | FormattableString seq |
Returns
ProcessSpec
Creates line-framed fan-in producers ready to connect to one consumer.
Parameters
| Name | Type | Description |
|---|---|---|
| commands | ProcessSpec seq |
Returns
ProcessSpec
Creates raw-byte fan-in producers with explicitly nondeterministic chunk interleaving.
Parameters
| Name | Type | Description |
|---|---|---|
| commands | ProcessSpec seq |
Returns
ProcessSpec
Builds a Bash program with interpolation values passed as positional arguments.
Parameters
| Name | Type | Description |
|---|---|---|
| program | FormattableString |
Returns
ProcessSpec
Builds a POSIX shell program with interpolation values passed as positional arguments.
Parameters
| Name | Type | Description |
|---|---|---|
| program | FormattableString |
Returns
ProcessSpec
Builds a PowerShell 7 program with interpolation values passed through <c>$args</c>.
Parameters
| Name | Type | Description |
|---|---|---|
| program | FormattableString |
Returns
ProcessSpec
Builds an explicitly assembled Bash program. Values in the text are not escaped by Axial.
Parameters
| Name | Type | Description |
|---|---|---|
| program | string |
Returns
ProcessSpec
Builds an explicitly assembled POSIX shell program. Values in the text are not escaped by Axial.
Parameters
| Name | Type | Description |
|---|---|---|
| program | string |
Returns
ProcessSpec
Builds an explicitly assembled PowerShell 7 program. Values in the text are not escaped by Axial.
Parameters
| Name | Type | Description |
|---|---|---|
| program | string |
Returns
ProcessSpec
Marks an interpolated value for diagnostic redaction.
Parameters
| Name | Type | Description |
|---|---|---|
| value | 'a |
Returns
SecretArgument
Parameters
| Name | Type | Description |
|---|---|---|
| path | string | |
| command | ProcessSpec |
Returns
ProcessSpec
Parameters
| Name | Type | Description |
|---|---|---|
| name | string | |
| value | string | |
| command | ProcessSpec |
Returns
ProcessSpec
Supplies a primary input source to a command or specification.
Parameters
| Name | Type | Description |
|---|---|---|
| source | InputSource | |
| topology | ProcessSpec |
Returns
ProcessSpec
Connects stdout from a command or specification to the next command's stdin.
Parameters
| Name | Type | Description |
|---|---|---|
| next | ProcessSpec | |
| source | ProcessSpec |
Returns
ProcessSpec
Configures final stdout on the specification.
Parameters
| Name | Type | Description |
|---|---|---|
| target | OutputTarget | |
| source | ProcessSpec |
Returns
ProcessSpec
Configures combined stderr on the specification.
Parameters
| Name | Type | Description |
|---|---|---|
| target | OutputTarget | |
| source | ProcessSpec |
Returns
ProcessSpec
Sets the maximum execution time for a command or specification.
<example><code>cmd $"service-device" |> timeout (TimeSpan.FromSeconds 30.0) |> capture</code></example>
Parameters
| Name | Type | Description |
|---|---|---|
| after | TimeSpan | |
| source | ProcessSpec |
Returns
ProcessSpec
Runs a command or specification in the current Flow runtime.
Parameters
| Name | Type | Description |
|---|---|---|
| source | ProcessSpec |
Returns
Flow<'a, ProcessError, ProcessResult>
Runs a command or specification and captures stdout and stderr.
Parameters
| Name | Type | Description |
|---|---|---|
| source | ProcessSpec |
Returns
Flow<'a, ProcessError, ProcessResult>
Forwards stdout and stderr to the host console while retaining structured completion data.
Parameters
| Name | Type | Description |
|---|---|---|
| source | ProcessSpec |
Returns
Flow<'a, ProcessError, ProcessResult>
Produces a bounded stream of structured output and completion events.
Parameters
| Name | Type | Description |
|---|---|---|
| source | ProcessSpec |
Returns
FlowStream<'a, ProcessError, ProcessEvent>
Connects both stdout and stderr from the current final stage to the next command.
Parameters
| Name | Type | Description |
|---|---|---|
| next | ProcessSpec | |
| source | ProcessSpec |
Returns
ProcessSpec
Routes final stderr through final stdout targets.
Parameters
| Name | Type | Description |
|---|---|---|
| source | ProcessSpec |
Returns
ProcessSpec
Writes final stdout to a truncating file and runs the specification.
Parameters
| Name | Type | Description |
|---|---|---|
| path | string | |
| source | ProcessSpec |
Returns
Flow<'a, ProcessError, ProcessResult>
Writes final stdout to an appending file and runs the specification.
Parameters
| Name | Type | Description |
|---|---|---|
| path | string | |
| source | ProcessSpec |
Returns
Flow<'a, ProcessError, ProcessResult>

