Proc 0.6.1

Dependency free reactive abstraction around Process, exposes handy static methods for the quick one-liners

Install-Package Proc -Version 0.6.1
dotnet add package Proc --version 0.6.1
<PackageReference Include="Proc" Version="0.6.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Proc --version 0.6.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Proc

A dependency free System.Diagnostics.Process supercharger.

  1. Proc.Exec() for the quick one-liners
  2. Proc.Start() for the quick one-liners
    • Use if you want to capture the console output as well as print these message in real time.
    • Proc.Start() also allows you to script StandardIn and react to messages
  3. Wraps System.Diagnostics.Process as an IObservable
    • ProcessObservable stream based wrapper
    • EventBasedObservableProcess event based wrapper
  4. Built in support to send SIGINT to any process before doing a hard SIGKILL (Process.Kill())
    • Has to be set using SendControlCFirst = true on StartArguments

Proc.Exec

Execute a process and blocks using a default timeout of 4 minutes. This method uses the same console session
as and as such will print the binaries console output. Throws a ProcExecException if the command fails to execute.
See also ExecArguments for more options

Proc.Exec("ipconfig", "/all");

Proc.Start

start a process and block using the default timeout of 4 minutes

var result = Proc.Start("ipconfig", "/all");

Provide a custom timeout and an IConsoleOutWriter that can output to console
while this line is blocking. The following example writes stderr in red.

var result = Proc.Start("ipconfig", TimeSpan.FromSeconds(10), new ConsoleOutColorWriter());

More options can be passed by passing StartArguments instead to control how the process should start.

var args = new StartArguments("ipconfig", "/all")
{
  WorkingDirectory = ..
}
Proc.Start(args, TimeSpan.FromSeconds(10));

The static Proc.Start has a timeout of 4 minutes if not specified.

result has the following properties

  • Completed true if the program completed before the timeout
  • ConsoleOut a list the console out message as LineOut
    instances where Error on each indicating whether it was written on stderr or not
  • ExitCode

NOTE ConsoleOut will always be set regardless of whether an IConsoleOutWriter is provided

ObservableProcess

The heart of it all this is an IObservable&lt;CharactersOut&gt;. It listens on the output buffers directly and does not wait on
newlines to emit.

To create an observable process manually follow the following pattern:

using (var p = new ObservableProcess(args))
{
	p.Subscribe(c => Console.Write(c.Characters));
	p.WaitForCompletion(TimeSpan.FromSeconds(2));
}

The observable is cold untill subscribed and is not intended to be reused or subscribed to multiple times. If you need to
share a subscription look into RX's Publish.

The WaitForCompletion() call blocks so that p is not disposed which would attempt to shutdown the started process.

The default for doing a shutdown is through Process.Kill this is a hard SIGKILL on the process.

The cool thing about Proc is that it supports SIGINT interoptions as well to allow for processes to be cleanly shutdown.

var args = new StartArguments("elasticsearch.bat")
{
	SendControlCFirst = true
};

This will attempt to send a Control+C into the running process console on windows first before falling back to Process.Kill.
Linux and OSX support for this flag is still in the works so thats why this behaviour is opt in.

Dealing with byte[] characters might not be what you want to program against, so ObservableProcess allows the following as well.

using (var p = new ObservableProcess(args))
{
	p.SubscribeLines(c => Console.WriteLine(c.Line));
	p.WaitForCompletion(TimeSpan.FromSeconds(2));
}

Instead of proxying byte[] as they are received on the socket this buffers and only emits on lines.

In some cases it can be very useful to introduce your own word boundaries

public class MyProcObservable : ObservableProcess
{
	public MyProcObservable(string binary, params string[] arguments) : base(binary, arguments) { }

	public MyProcObservable(StartArguments startArguments) : base(startArguments) { }

	protected override bool BufferBoundary(char[] stdOut, char[] stdErr)
	{
		return base.BufferBoundary(stdOut, stdErr);
	}
}

returning true inside BufferBoundary will yield the line to SubscribeLine(). This could be usefull e.g if your process
prompts without a new line:

Continue [Y/N]: <no newline here>

A more concrete example of this is when you call a bat file on windows and send a SIGINT signal it will always prompt:

Terminate batch job (Y/N)?

Which would not yield to SubscribeLines and block any waithandles unnecessary. ObservableProcess handles this edgecase
therefor OOTB and automatically replies with Y on stdin in this case.

Also note that ObservableProcess will yield whatever is in the buffer before OnCompleted().

EventBasedObservable

ObservableProcess's sibbling that utilizes OutputDataReceived and ErrorDataReceived and can only emit lines.

Proc

A dependency free System.Diagnostics.Process supercharger.

  1. Proc.Exec() for the quick one-liners
  2. Proc.Start() for the quick one-liners
    • Use if you want to capture the console output as well as print these message in real time.
    • Proc.Start() also allows you to script StandardIn and react to messages
  3. Wraps System.Diagnostics.Process as an IObservable
    • ProcessObservable stream based wrapper
    • EventBasedObservableProcess event based wrapper
  4. Built in support to send SIGINT to any process before doing a hard SIGKILL (Process.Kill())
    • Has to be set using SendControlCFirst = true on StartArguments

Proc.Exec

Execute a process and blocks using a default timeout of 4 minutes. This method uses the same console session
as and as such will print the binaries console output. Throws a ProcExecException if the command fails to execute.
See also ExecArguments for more options

Proc.Exec("ipconfig", "/all");

Proc.Start

start a process and block using the default timeout of 4 minutes

var result = Proc.Start("ipconfig", "/all");

Provide a custom timeout and an IConsoleOutWriter that can output to console
while this line is blocking. The following example writes stderr in red.

var result = Proc.Start("ipconfig", TimeSpan.FromSeconds(10), new ConsoleOutColorWriter());

More options can be passed by passing StartArguments instead to control how the process should start.

var args = new StartArguments("ipconfig", "/all")
{
  WorkingDirectory = ..
}
Proc.Start(args, TimeSpan.FromSeconds(10));

The static Proc.Start has a timeout of 4 minutes if not specified.

result has the following properties

  • Completed true if the program completed before the timeout
  • ConsoleOut a list the console out message as LineOut
    instances where Error on each indicating whether it was written on stderr or not
  • ExitCode

NOTE ConsoleOut will always be set regardless of whether an IConsoleOutWriter is provided

ObservableProcess

The heart of it all this is an IObservable&lt;CharactersOut&gt;. It listens on the output buffers directly and does not wait on
newlines to emit.

To create an observable process manually follow the following pattern:

using (var p = new ObservableProcess(args))
{
	p.Subscribe(c => Console.Write(c.Characters));
	p.WaitForCompletion(TimeSpan.FromSeconds(2));
}

The observable is cold untill subscribed and is not intended to be reused or subscribed to multiple times. If you need to
share a subscription look into RX's Publish.

The WaitForCompletion() call blocks so that p is not disposed which would attempt to shutdown the started process.

The default for doing a shutdown is through Process.Kill this is a hard SIGKILL on the process.

The cool thing about Proc is that it supports SIGINT interoptions as well to allow for processes to be cleanly shutdown.

var args = new StartArguments("elasticsearch.bat")
{
	SendControlCFirst = true
};

This will attempt to send a Control+C into the running process console on windows first before falling back to Process.Kill.
Linux and OSX support for this flag is still in the works so thats why this behaviour is opt in.

Dealing with byte[] characters might not be what you want to program against, so ObservableProcess allows the following as well.

using (var p = new ObservableProcess(args))
{
	p.SubscribeLines(c => Console.WriteLine(c.Line));
	p.WaitForCompletion(TimeSpan.FromSeconds(2));
}

Instead of proxying byte[] as they are received on the socket this buffers and only emits on lines.

In some cases it can be very useful to introduce your own word boundaries

public class MyProcObservable : ObservableProcess
{
	public MyProcObservable(string binary, params string[] arguments) : base(binary, arguments) { }

	public MyProcObservable(StartArguments startArguments) : base(startArguments) { }

	protected override bool BufferBoundary(char[] stdOut, char[] stdErr)
	{
		return base.BufferBoundary(stdOut, stdErr);
	}
}

returning true inside BufferBoundary will yield the line to SubscribeLine(). This could be usefull e.g if your process
prompts without a new line:

Continue [Y/N]: <no newline here>

A more concrete example of this is when you call a bat file on windows and send a SIGINT signal it will always prompt:

Terminate batch job (Y/N)?

Which would not yield to SubscribeLines and block any waithandles unnecessary. ObservableProcess handles this edgecase
therefor OOTB and automatically replies with Y on stdin in this case.

Also note that ObservableProcess will yield whatever is in the buffer before OnCompleted().

EventBasedObservable

ObservableProcess's sibbling that utilizes OutputDataReceived and ErrorDataReceived and can only emit lines.

Release Notes

See https://github.com/elastic/nullean/proc/releases

Showing the top 1 GitHub repositories that depend on Proc:

Repository Stars
elastic/elasticsearch-net
Elasticsearch.Net & NEST

Version History

Version Downloads Last updated
0.6.1 4,350 6/20/2019
0.6.0 87 6/20/2019
0.5.0 55 6/20/2019
0.4.3 4,156 3/29/2019
0.4.2 109 2/13/2019
0.4.1 142 11/28/2018
0.4.0 117 11/28/2018
0.3.8 113 11/27/2018
0.3.7 11,680 8/31/2018
0.3.6 199 8/27/2018
0.3.5 155 8/27/2018
0.3.4 150 8/27/2018
0.3.3 162 8/23/2018
0.3.2 154 8/17/2018
0.3.1 176 8/17/2018
0.3.0 156 8/17/2018
0.2.1 7,154 5/30/2018
0.2.0 201 5/30/2018
0.1.10 284 5/7/2018
0.1.9 192 5/7/2018
0.1.8 291 5/7/2018
0.1.7 206 5/7/2018
0.1.6 210 5/7/2018
0.1.5 207 5/7/2018
0.1.4 350 4/18/2018
0.1.3 267 2/17/2018
0.1.1 270 2/12/2018