A cross-platform C# library for executing bash commands with strongly-typed results. Works on Windows (via WSL), Linux, and macOS.
Get Started
$ dotnet add package BashSharpReadme
BashSharp
A cross-platform C# library for executing bash commands with strongly-typed results. Works on Windows (via WSL), Linux, and macOS.
Features
- Execute bash commands and get strongly-typed results
- Cross-platform support (Windows via WSL, Linux, and macOS)
- Async/await support with cancellation and timeout
- Error handling and exit code tracking
- Strongly-typed command results via custom result models
- Efficient streaming output handling for large outputs
Installation
Install via NuGet:
dotnet add package BashSharp
Prerequisites
- .NET 8.0 or later
- On Windows: Windows Subsystem for Linux (WSL) with Debian
- On Linux/macOS: bash shell
Usage
Basic Command Execution
// Simple execution - returns success/failure
bool success = await BashCommandService.ExecuteCommand("echo 'Hello World'");
// Get exit code
int exitCode = await BashCommandService.ExecuteCommandWithCode("ls -la");
// Get strongly-typed results
public class LsResult : ICommandResult
{
public List<string> Files { get; private set; } = new();
public int ExitCode { get; private set; }
public void SetExitCode(int exitCode) => ExitCode = exitCode;
public void ParseResult(string output)
{
Files = output.Split('\n')
.Where(line => !string.IsNullOrWhiteSpace(line))
.ToList();
}
public void ParseError(string error) { }
}
var result = await BashCommandService.ExecuteCommandWithResults<LsResult>("ls");
foreach (var file in result.Files)
{
Console.WriteLine(file);
}