Information

Install

dotnet add package Sheller

Test

dotnettest --filter os~nix

dotnettest --filter os~win

Compatibility

Examples

Basic

varechoResult=awaitSheller.Builder.UseShell("/bin/bash").WithEnvironmentVariable("MY_VAR","lol").UseExecutable("echo").WithArgument("$MY_VAR").ExecuteAsync();varexitCode=result.ExitCode;// 0varstandardOutput=result.StandardOutput;// "lol\n"varstandardError=result.StandardError;// ""varstartTime=result.StartTime;varendTime=result.EndTime;varrunTime=result.RunTime;

varresult=awaitSheller.Builder.UseShell<Bash>().WithEnvironmentVariable("MY_VAR",varValue).UseExecutable<Echo>().WithArgument("$MY_VAR").ExecuteAsync();varechoValue=result;// "lol"

Reusable Objects

varshell=Builder.UseShell<Bash>().WithEnvironmentVariable("MY_VAR","cool");varanotherShell1=shell.WithEnvironmentVariable("MY_VAR_2","beans");varanotherShell2=shell.WithEnvironmentVariable("MY_VAR_2","stuff");varechoResult1=anotherShell1.UseExecutable<Echo>().WithArgument("$MY_VAR$MY_VAR_2").ExecuteAsync();//result: "coolbeans".varechoResult2=anotherShell1.UseExecutable<Echo>().WithArgument("$MY_VAR$MY_VAR_2").ExecuteAsync();//result: "coolstuff".

Environment Variables

varresult=awaitBuilder.UseShell<Bash>().WithEnvironmentVariable("MY_VAR",expected).UseExecutable<Echo>().WithArgument("$MY_VAR").ExecuteAsync();

Standard Output/Error

awaitBuilder.UseShell<Bash>().UseExecutable<Echo>().WithArgument("saythings").WithStandardOutputHandler(Console.WriteLine).WithStandardErrorHandler().ExecuteAsync();

Standard Input

varechoResult=awaitBuilder.UseShell<Bash>().UseExecutable("read var1; read var2; echo $var1$var2").WithStandardInput("cool").WithStandardInput("library").ExecuteAsync();// echoResult is "coollibrary".

Input Request Handler

varechoResult=awaitBuilder.UseShell<Bash>().UseExecutable($"read var1; echo $var1").UseInputRequestHandler((stdout,stderr)=>{// Process stdout or stderr, if needed.// Process is blocked, waiting for this input.returnTask.FromResult("awesome");}).ExecuteAsync();// echoResult is "awesome".

No Throw

awaitBuilder.UseShell<Bash>().UseExecutable("foo").UseNoThrow().ExecuteAsync();

Result Selector

varechoErrorCode=awaitBuilder.UseShell<Bash>().UseExecutable<Echo>().WithArgument("dummy").ExecuteAsync(cr=>{returncr.ExitCode;});// echoErrorCode is 0.

Execution Timeout

awaitBuilder.UseShell<Bash>().UseExecutable<Sleep>().WithArgument("10").UseTimeout(TimeSpan.FromSeconds(5)).ExecuteAsync();

Post Execution Wait

varechoValue=awaitBuilder.UseShell<Bash>().UseExecutable<Echo>().WithArgument("dummy").WithWait(async cr=>{returnSomethingThatIsATask();}).UseWaitTimeout(TimeSpan.FromSeconds(30)).ExecuteAsync();

Reactive

varevents=newList<string>();varcommand1=Builder.UseShell<Bash>().UseExecutable("echo").WithArgument(expected).WithSubscribe(o=>{o.Where(ev=>ev.Type==CommandEventType.StandardOutput).Select(ev=>ev.Data).Do(data=>{events.Add(data);}).Subscribe();}).ExecuteAsync();

Cancellation

using(varctSource=newCancellationTokenSource()){ctSource.CancelAfter(TimeSpan.FromSeconds(5));Builder.UseShell<Bash>().UseExecutable<Sleep>().WithArgument("10").WithCancellationToken(ctSource.Token).ExecuteAsync();}

Character Encoding

varechoValue=awaitBuilder.UseShell<Bash>().UseExecutable<Echo>().WithArgument("😋").UseStandardOutputEncoding(Encoding.ASCII).ExecuteAsync();// echoValue is "????".

StartInfo Transform

varechoValue=awaitBuilder.UseShell<Bash>().UseExecutable<Echo>().WithArgument(expected).UseStartInfoTransform(si=>{si.WorkingDirectory="/";}).ExecuteAsync();

Roll Your Own

publicinterfaceIKubectl:IExecutable<IKubectl>{IKubectlWithKubeConfig(stringconfigPath);IKubectlWithApply(stringyamlPath);}publicclassKubectl:Executable<IKubectl>,IKubectl{// Allows the `Executable` base class to "create and clone" a new instance for chanining.protectedoverrideExecutable<IKubectl>Create()=>newKubectl();// Sets the underlying executable of this executable type.publicKubectl():base("kubectl"){}publicIKubectlWithKubeConfig(stringconfigPath)=>this.WithArgument($"--kubeconfig={configPath}");publicIKubectlWithApply(stringyamlPath)=>this.WithArgument("apply","-f",yamlPath);}...var result=awaitBuilder.UseShell<Bash>().UseExecutable<Kubectl>().WithKubeConfig("kube_config.yaml").WithApply("my_app.yaml").ExecuteAsync();

License

The MIT License (MIT)Copyright (c) 2019 Aaron RoneyPermission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included in allcopies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THESOFTWARE.