CliInvoke 3.0.0-beta.1

CliInvoke

<img src="https://github.com/alastairlundy/CliInvoke/blob/main/.assets/icon.png" width="192" height="192" alt="CliInvoke Logo">

CliInvoke is a .NET library for interacting with Command Line Interfaces and wrapping around executables.

Launch processes, redirect standard input and output streams, await process completion, and much more.

Table of Contents

• Features
• Comparison vs Alternatives
• Installing CliInvoke
  • Supported Platforms
• Examples
• Middleware
• Resource Disposal
• Documentation
• Contributing to CliInvoke
• License
• Acknowledgements

Features

• Clear separation of concerns between Process Configuration Builders, Process Configuration Models, and Invokers.
• Supports .NET 10 and has few dependencies.
• Has Dependency Injection extensions to make using it a breeze.
• Support for specific specializations such as running executables or commands via Windows PowerShell or CMD on Windows ¹
• SourceLink support

¹ Specializations library distributed separately.

Comparison vs Alternatives

CliInvoke is compared against CliWrap, ProcessX, and the built-in .NET Process class across features like configuration separation, DI support, middleware, cross-platform support, and licensing.

See the full comparison table for a detailed feature-by-feature breakdown.

Installing CliInvoke

CliInvoke is available on the NuGet Gallery but can also be installed via the dotnet SDK CLI.

The package(s) to install depends on your use case:

• For use in a .NET library – Install the abstractions package, your developer users can install the Implementation and Dependency Injection packages.
• For use in a .NET app – Install the implementation package and the Dependency Injection Extensions Package

Links to packages

CliInvoke.Core Nuget CliInvoke Nuget CliInvoke.Extensions Nuget CliInvoke.Specializations Nuget

Supported Platforms

CliInvoke supports Windows, macOS, Linux, FreeBSD, Android, and potentially some other operating systems.

For more details see the list of supported platforms

Design Patterns & When to Use Them

CliInvoke provides three core design patterns for invoking processes (with DI + Middleware and the platform Specializations as composition paths). See PATTERNS.md for comprehensive documentation on each pattern, including a Which pattern should I use? decision tree.

• CliRun – Recommended default. Beginner-friendly/quickstart entrypoint. Use for basic scripting, CI/CD tasks, or simple command execution. Zero boilerplate, optional arguments with sensible defaults. Start here if you are new to CliInvoke.
• IProcessInvoker – DI-centric pattern and support for end-to-end process management. Use when building applications that need testability, dependency injection integration, or custom process configuration per invocation.
• IExternalProcess & IExternalProcessFactory – Process-like API with DI support, rich capability, stable and predictable behaviour. Use when you need granular lifecycle control, manual start/stop sequences, or power-user scenarios similar to System.Diagnostics.Process.

New to CliInvoke? Start with CliRun — it is the recommended default entry point. Reach for IProcessInvoker when you need DI or middleware, and IExternalProcess when you need process-level control. See Why CliInvoke did not copy CliWrap for the design rationale.

Examples

Beginner Friendly / Quickstart

For simple use cases, the CliRun helper provides a straightforward API to execute commands with minimal boilerplate:

using CliInvoke;
using CliInvoke.Core;

// Execute a command and get the result
ProcessResult result = await CliRun.RunAsync("dotnet", "--version");
Console.WriteLine($"Exit Code: {result.ExitCode}");

For capturing output, use RunBufferedAsync:

using CliInvoke;
using CliInvoke.Core;

// Execute and capture stdout/stderr
BufferedProcessResult result = await CliRun.RunBufferedAsync("dotnet", "--info");
Console.WriteLine(result.StandardOutput);
Console.WriteLine(result.StandardError);

CliRun is ideal for scripting, quick prototypes, and basic command execution where you don't need dependency injection or advanced configuration.

For detailed documentation on all available patterns and when to use them, see PATTERNS.md.

Advanced Configuration

For fine-grained control over process execution — custom timeouts, cancellation strategies, buffered vs. non-buffered output, and builder-based configuration — see the Configuration Guide and the Choosing your Invocation Pattern guide in the documentation portal.

Middleware

CliInvoke's ProcessInvoker supports an optional middleware system that lets you plug cross-cutting concerns — logging, validation, platform selection, retries — around the process pipeline without changing how you call it. Middleware wraps the terminal pipeline in the order you register, and call sites (ExecuteAsync, ExecuteBufferedAsync) remain identical.

Built-in middleware includes UseLogging, UsePostExitValidation, UsePowerShell, and UseCmd. Middleware can be configured by hand or through DI via the IProcessMiddlewareBuilder callback in AddCliInvoke.

For the full guide — constructor details, the IProcessMiddleware contract, DI configuration, result ownership, and the result-swap rule — see the Middleware Guide.

Resource Disposal

For the full disposal reference — ownership rules, disposal patterns, and a checklist — see the Resource Disposal Guide.

Documentation

Full documentation is available in the CliInvoke Developer Portal. Pick the path that fits you:

Other guides: Troubleshooting · Migration Guides · Building from Source

How to Build CliInvoke's code

Please see building-cliinvoke.md for how to build CliInvoke from source.

How to Contribute to CliInvoke

Please see the CONTRIBUTING.md file for code and localisation contributions.

If you want to file a bug report or suggest a potential feature to add, please check out the GitHub issues page to see if a similar or identical issue is already open. If there isn't already a relevant issue filed, please file one here and follow the respective guidance from the appropriate issue template.

License

CliInvoke is licensed under the MPL 2.0 license. You can learn more about it here

Should your project incorporate CliInvoke, ensure that the full text of CliInvoke's LICENSE.txt is either incorporated into your third-party licenses TXT file or provided as a distinct TXT file within your project's repository.

CliInvoke Assets

The CliInvoke icon is a separately-owned asset and is not licensed under MPL-2.0 like the rest of the codebase.

If you fork CliInvoke and re-distribute it, please replace the icon with your own artwork unless you have written permission from the maintainer. To request permission, open a GitHub issue tagged asset-license.

Star History

<a href="https://www.star-history.com/?repos=alastairlundy%2Fcliinvoke&type=date&logscale=&legend=top-left"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/chart?repos=alastairlundy/cliinvoke&type=date&theme=dark&legend=top-left" /> <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/chart?repos=alastairlundy/cliinvoke&type=date&legend=top-left" /> <img alt="Star History Chart" src="https://api.star-history.com/chart?repos=alastairlundy/cliinvoke&type=date&legend=top-left" /> </picture> </a>

Acknowledgements

Projects

This project would like to thank the following projects for their work:

• CliWrap for inspiring this project
• Polyfill for simplifying older TFM support

For more information, please see the THIRD_PARTY_NOTICES file.