AlastairLundy.CliInvoke.Core 1.3.0

AlastairLundy.CliInvoke.Core

This package contains Process Running and handling abstractions as well as common types used by implementing classes.

For an implementing package, check out AlastairLundy.CliInvoke.

Key Abstractions:

• IProcessFactory
• Piping:
  • IProcessPipeHandler
• Builders:
  • IEnvironmentVariablesBuilder
  • IProcessResourcePolicyBuilder
  • IUserCredentialBuilder

Some primitives added include:

Result Types

• ProcessResult - For basic process result information
• BufferedProcessResult - String copies of Standard Output and Standard Error + basic process result information.
• PipedProcessResult - Process result information + Standard output and Standard Error pipes for more advanced piping scenarios.

Other Primitives

• ProcessResultValidation - An enum representing whether process result validation should be performed or not.
• ProcessConfiguration - A model class for representing Process configurations.

Table of Contents

• Features
• Installing CliInvoke.Core
  • Compatibility
• Examples
• Contributing to CliInvoke.Core
• License
• Acknowledgements

Features

• Easy to use safe Process Running classes and interfaces
• Models that help abstract away some of the complicated nature of Process objects
• Compatible with .NET Standard 2.0 and 2.1 ^1
• SourceLink support

^1 - Polyfill is a dependency only required for .NET Standard 2.0 and 2.1 users. Microsoft.Bcl.HashCode is a dependency only required for .NET Standard 2.0 users.

How to install and use CliInvoke.Core

CliInvoke.Core is available on Nuget.

Installing CliInvoke.Core

CliInvoke.Core packages can be installed via the .NET SDK CLI, Nuget via your IDE or code editor's package interface, or via the Nuget website.

Supported Platforms

CliInvoke.Core can be added to any .NET Standard 2.0, .NET Standard 2.1, .NET 8, or .NET 9 supported project.

The following table details which target platforms are supported for running Processes.

^2 - See the Process class documentation for more info.

^3 - lack of IOS support implies Lack of watchOS support since watchOS is based on IOS.

Note: This library has not been tested on Android or Tizen.

Examples

One of the main use cases for CliInvoke.Core is intended to be safe Process Running.

Safe Process Running

CliInvoke.Core offers safe abstractions around Process Running to avoid accidentally not disposing of Processes after they are executed.

IProcessFactory provides for this in

IProcessFactory

IProcessFactory is an interface for enabling easy Process Creation, Running, and Disposal depending on the methods used.

The From method and its overloads provide for easy standalone process creation. The StartNew method provides for creating and starting new processes easily.

The ContinueWhenExitAsync and ContinueWhenExitBufferedAsync methods provide for safe process running, and disposal after a Process has exited.

This example shows how it might be used:

using AlastairLundy.CliInvoke.Core;
// Using namespaces for Dependency Injection code ommitted for clarity

      // Dependency Injection setup code ommitted for clarity

    IProcessFactory _processFactory = serviceProvider.GetRequiredService<IProcessFactory>();
    
    // Define processStartInfo here.
    
    Process process1 = _processFactory.From(processStartInfo);
    
    // This process that is returned is a Process that has been started.
    Process process2 = _processFactory.StartNew(processStartInfo);
    
    // Wait for the Process to finish before safely disposing of it.
   ProcessResult result = await processFactory.ContinueWhenExitAsync(process2);
    
        
    ProcessResult result = await _processRunner.ExecuteProcessAsync(process, ProcessResultValidation.None);

Asynchronous methods in IProcessFactory also allow for an optional CancellationToken parameter.

Some overloads for ContinueWhenExitAsync and ContinueWhenExitBufferedAsync allow for specifying ProcessResultValidation.

How to Contribute

Thank you in advance for considering contributing to CliInvoke.

Please see the CONTRIBUTING.md file for code and localization 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 is not already a relevant issue filed, please file one here and follow the respective guidance from the appropriate issue template.

Thanks.

License

CliInvoke.Core is licensed under the MPL 2.0 license. If you modify any of CliInvoke.Core's files, then the modified files must be licensed under the MPL 2.0.

If you use CliInvoke.Core in your project, please make an exact copy of the contents of CliInvoke.Core' LICENSE.txt file available either in your third party licenses txt file or as a separate txt file.

Acknowledgements

Projects

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

• Microsoft.Bcl.HashCode for providing a backport of the HashCode class and static methods to .NET Standard 2.0

For more information, please see the THIRD_PARTY_NOTICES file.