Proc 0.9.1
dotnet add package Proc --version 0.9.1
NuGet\Install-Package Proc -Version 0.9.1
<PackageReference Include="Proc" Version="0.9.1" />
paket add Proc --version 0.9.1
#r "nuget: Proc, 0.9.1"
// Install Proc as a Cake Addin #addin nuget:?package=Proc&version=0.9.1 // Install Proc as a Cake Tool #tool nuget:?package=Proc&version=0.9.1
Proc
A dependency free System.Diagnostics.Process
supercharger.
Proc.Exec()
for the quick one-linersProc.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
- Wraps
System.Diagnostics.Process
as anIObservable
ProcessObservable
stream based wrapperEventBasedObservableProcess
event based wrapper
- Built in support to send
SIGINT
to any process before doing a hardSIGKILL
(Process.Kill()
)- Has to be set using
SendControlCFirst = true
onStartArguments
- Has to be set using
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 timeoutConsoleOut
a list the console out message asLineOut
instances whereError
on each indicating whether it was written onstderr
or notExitCode
NOTE ConsoleOut
will always be set regardless of whether an IConsoleOutWriter
is provided
ObservableProcess
The heart of it all this is an IObservable<CharactersOut>
. 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.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 is compatible. |
.NET Framework | net461 is compatible. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETFramework 4.6.1
- System.Reactive (>= 5.0.0)
-
.NETStandard 2.0
- System.Reactive (>= 5.0.0)
-
.NETStandard 2.1
- System.Reactive (>= 5.0.0)
-
net8.0
- System.Reactive (>= 5.0.0)
NuGet packages (2)
Showing the top 2 NuGet packages that depend on Proc:
Package | Downloads |
---|---|
Elastic.Elasticsearch.Managed
Provides an observable ElasticsearchNode abstraction that can be used to wrap an elasticsearch process. Also ships with an cluster abstraction that can start one or more ElasticsearchNode's |
|
Proc.Fs
Dependency free reactive abstraction around Process, exposes handy static methods for the quick one-liners |
GitHub repositories (3)
Showing the top 3 popular GitHub repositories that depend on Proc:
Repository | Stars |
---|---|
elastic/elasticsearch-net
This strongly-typed, client library enables working with Elasticsearch. It is the official client maintained and supported by Elastic.
|
|
elastic/apm-agent-dotnet
|
|
opensearch-project/opensearch-net
OpenSearch .NET Client
|
Version | Downloads | Last updated |
---|---|---|
0.9.1 | 197 | 12/3/2024 |
0.9.0 | 508 | 12/2/2024 |
0.8.2 | 1,887 | 10/2/2024 |
0.8.1 | 5,097 | 1/16/2024 |
0.8.0 | 647 | 1/15/2024 |
0.7.3 | 552 | 1/8/2024 |
0.7.2 | 524 | 1/7/2024 |
0.7.1 | 425 | 1/6/2024 |
0.7.0 | 432 | 1/5/2024 |
0.6.2 | 67,335 | 8/28/2019 |
0.6.1 | 215,630 | 6/20/2019 |
0.6.0 | 1,239 | 6/20/2019 |
0.5.0 | 1,182 | 6/20/2019 |
0.4.3 | 5,769 | 3/29/2019 |
0.4.2 | 1,289 | 2/13/2019 |
0.4.1 | 1,353 | 11/28/2018 |
0.4.0 | 1,322 | 11/28/2018 |
0.3.8 | 1,338 | 11/27/2018 |
0.3.7 | 15,007 | 8/31/2018 |
0.3.6 | 1,457 | 8/27/2018 |
0.3.5 | 1,417 | 8/27/2018 |
0.3.4 | 1,415 | 8/27/2018 |
0.3.3 | 1,411 | 8/23/2018 |
0.3.2 | 1,494 | 8/17/2018 |
0.3.1 | 1,447 | 8/17/2018 |
0.3.0 | 1,438 | 8/17/2018 |
0.2.1 | 9,795 | 5/30/2018 |
0.2.0 | 1,525 | 5/30/2018 |
0.1.10 | 1,620 | 5/7/2018 |
0.1.9 | 1,431 | 5/7/2018 |
0.1.8 | 1,612 | 5/7/2018 |
0.1.7 | 1,486 | 5/7/2018 |
0.1.6 | 1,557 | 5/7/2018 |
0.1.5 | 1,527 | 5/7/2018 |
0.1.4 | 1,694 | 4/18/2018 |
0.1.3 | 1,599 | 2/17/2018 |
0.1.1 | 1,646 | 2/12/2018 |