CreateProcess - A simple and powerful Process library for C#

Examples

    [Test]
    public void RedirectToFile()
    {
        var shell = ProcessShell.Create();
        shell.Run(
            CreateProcess.FromCommandLine(@"C:\Program Files\Git\usr\bin\bash.exe", "-c", "echo test single argument")
            > Redirect.Output.ToFile("test.txt", true)
            > Redirect.Output.ToFile("second.txt", true)
            );
        Assert.AreEqual("test single argument\n", File.ReadAllText("test.txt"));
        Assert.AreEqual("test single argument\n", File.ReadAllText("second.txt"));
    }
    
    [Test]
    public void RedirectFromFileAndPipeToCat()
    {
        var shell = ProcessShell.Create();
        File.WriteAllTextAsync("test.txt", "RedirectFromFileAndPipeToCat");
        shell.AppendPath(@"C:\Program Files\Git\usr\bin");
        shell.Run(
            CreateProcess.FromCommandLine(@"C:\Program Files\Git\usr\bin\bash.exe", "-c", "cat")
            < Redirect.FromFile("test.txt")
            > Redirect.Output.ToFile("output.txt", true)
        );
        Assert.AreEqual("RedirectFromFileAndPipeToCat", File.ReadAllText("output.txt"));
    }
    
    [Test]
    public void RedirectMultipleFilesAndPipeToCat()
    {
        var shell = ProcessShell.Create();
        File.WriteAllTextAsync("test.txt", "RedirectFromFileAndPipeToCat");
        File.WriteAllTextAsync("test2.txt", "SecondFile");
        shell.AppendPath(@"C:\Program Files\Git\usr\bin");
        shell.Run(
            CreateProcess.FromCommandLine(@"C:\Program Files\Git\usr\bin\bash.exe", "-c", "cat")
            < Redirect.FromFile("test.txt")
            < Redirect.FromFile("test2.txt")
            > Redirect.Output.ToFile("output.txt", true)
        );
        Assert.AreEqual("RedirectFromFileAndPipeToCatSecondFile", File.ReadAllText("output.txt"));
    }
    
    [Test]
    public void RedirectToFileAndPipeToCat()
    {
        var shell = ProcessShell.Create();
        shell.AppendPath(@"C:\Program Files\Git\usr\bin");
        shell.Run(
            CreateProcess.FromCommandLine(@"C:\Program Files\Git\usr\bin\bash.exe", "-c", "echo test single argument")
            > Redirect.Output.ToFile("test.txt", true)
            | CreateProcess.FromCommandLine(@"C:\Program Files\Git\usr\bin\bash.exe", "-c", "cat 1>&2")
            > Redirect.Error.ToFile("other.txt", true)
        );
        Assert.AreEqual("test single argument\n", File.ReadAllText("test.txt"));
        Assert.AreEqual("test single argument\n", File.ReadAllText("other.txt"));
    }
    
    [Test]
    public void RedirectToFileAndPipeToCatCheckAllExitCodes()
    {
        var shell = ProcessShell.Create();
        shell.AppendPath(@"C:\Program Files\Git\usr\bin");
        shell.Run(
            CreateProcess.FromCommandLine(@"C:\Program Files\Git\usr\bin\bash.exe", "-c", "echo test single argument")
            > Redirect.Output.ToFile("test.txt", true)
            == 0
            | CreateProcess.FromCommandLine(@"C:\Program Files\Git\usr\bin\bash.exe", "-c", "cat -; exit 1")
            == 1
            | CreateProcess.FromCommandLine(@"C:\Program Files\Git\usr\bin\bash.exe", "-c", "cat 1>&2")
            > Redirect.Error.ToFile("other.txt", true)
            == 0
        );
        Assert.AreEqual("test single argument\n", File.ReadAllText("test.txt"));
        Assert.AreEqual("test single argument\n", File.ReadAllText("other.txt"));
    }

    [Test]
    public void ExitCodeThrows()
    {
        var shell = ProcessShell.Create();
        Assert.ThrowsAsync<ProcessErroredException>(() =>
            shell.RunAsync(
                CreateProcess.FromCommandLine(@"C:\Program Files\Git\usr\bin\bash.exe", "-c", "exit 1")
                > Redirect.Output.ToFile("test.txt", true)
            ));
    }
    
    [Test]
    public async Task ExitCodeCheckCanBeDisabled()
    {
        var shell = ProcessShell.Create();
        var r = await shell.RunAsync(
            (CreateProcess.FromCommandLine(@"C:\Program Files\Git\usr\bin\bash.exe", "-c", "exit 1")
            > Redirect.Output.ToFile("test.txt", true))
            == Option.DisableNullCheck
        );
        
        Assert.AreEqual(1, r.Results.Count);
        Assert.AreEqual(1, r.Results[0].ExitCode);
    }

    
    [Test]
    public void ExitCodeThrowsWhenCheckedForAnyValue()
    {
        var shell = ProcessShell.Create();
        Assert.ThrowsAsync<ProcessErroredException>(() =>
            shell.RunAsync(
                CreateProcess.FromCommandLine(@"C:\Program Files\Git\usr\bin\bash.exe", "-c", "exit 2")
                > Redirect.Output.ToFile("test.txt", true)
                == 1
            ));
    }
    [Test]
    public async Task ExitCodeCanBeCheckedForAnyValue()
    {
        var shell = ProcessShell.Create();
        await shell.RunAsync(
            CreateProcess.FromCommandLine(@"C:\Program Files\Git\usr\bin\bash.exe", "-c", "exit 2")
            > Redirect.Output.ToFile("test.txt", true)
            == 2
        );
    }
    
    [Test]
    public async Task PipeToMemory()
    {
        var pipe = CreateProcessPipe.Create();
        var readerTask = pipe.ToStringAsync();
        var shell = ProcessShell.Create();
        await shell.RunAsync(
            CreateProcess.FromCommandLine(@"C:\Program Files\Git\usr\bin\bash.exe", "-c", "echo test")
            > Redirect.Output.ToPipe(pipe)
            == 0
        );
        
        var data = await readerTask;
        
        Assert.AreEqual("test\n", data);
    }

Why?

• I'm the creator of the rock solid foundation used by the FAKE-Build system
• I always wanted to build a simple layer on top of the CreateProcess API in FAKE.
• The API is now C# first as C# has imho caught up with F#
• Fully unit-testable API
• Design the API to be as typed and as composable as possible

Alternatives

• https://github.com/madelson/MedallionShell - Another well designed general purpose library
• https://github.com/Tyrrrz/CliWrap - Very powerful/good abstractions. If you are doing shell work this one might be worth a look.
• https://github.com/mayuki/Chell - Again shell-based, if you do shell work take a look.
• https://github.com/Cysharp/ProcessX - A bit limited in what you can do
• https://github.com/jamesmanning/RunProcessAsTask - also quite limited
• https://github.com/twitchax/Sheller

By the way the libraries are not mutually exclusive. For example you could use the argument API from CreateProcess combined with CliWrap. In particular CreateProcess offers:

• Argument Serialization and Parsing
• Utils for resolving files from PATH
• Process creation
• Combinators for process results (to get typed again)