CliInvoke.Specializations 2.3.0

CliInvoke.Specializations

This readme covers the CliInvoke Specializations library.

Looking for the CliInvoke Readme?

Usage

CliInvoke.Specializations comes with three specializations as of 1.0.0:

• CmdProcessConfiguration — An easier way to execute processes and commands through cmd.exe (Only supported on Windows)
• ClassicPowershellProcessConfiguration — An easier way to execute processes and commands through Windows PowerShell (Only supported on Windows)
• PowershellProcessConfiguration — An easier way to execute processes and commands through the modern Cross-Platform open source PowerShell (PowerShell is not installed by CliInvoke and is expected to be installed if you plan to use it.)

All Command specialization classes come with an already configured TargetFilePath that points to the relevant executable.

CmdProcessConfiguration

The CmdProcessConfiguration TargetFilePath points to Windows' copy of cmd.exe. This is only supported on Windows.

using CliInvoke.Core;
using CliInvoke.Builders;
using CliInvoke.Core.Builders;
using CliInvoke.Core.Extensibility.Factories;

using CliInvoke.Specializations.Configurations;
using CliInvoke.Specializations;

    // ServiceProvider and Dependency Injection code ommitted for clarity
    
    IProcessInvoker _processInvoker = serviceProvider.GetRequiredService<IProcessInvoker>();
  IRunnerProcessFactory _runnerProcessFactory = serviceProvider.GetRequiredService<IRunnerProcessFactory>();
  
  //Create your runner configuration.
         ProcessConfiguration runnerConfig = new CmdProcessConfiguration("Your arguments go here",
                    // Set standard input, output, and error
          false, true, true, Environment.SystemDirectory);
  
  // Create your configuration to be run.
  ProcessConfiguration config = new ProcessConfiguration("Path/To/Exe",
  false, true, true, "With/Arguments")
  
  // Creates a ProcessConfiguration that will use the runner configuration to run the desired configuration.
  ProcessConfiguration processToRun = _runnerProcessFactory.CreateRunnerConfiguration(config, runnerConfig);
  
  BufferedProcessResult result = await _processInvoker.ExecuteBufferedAsync(processToRun);

If the result of the command being run is not of concern you can call ExecuteAsync() instead of ExecuteBufferedAsync() and ignore the returned ProcessResult like so:

using CliInvoke.Core;
using CliInvoke.Builders;
using CliInvoke.Core.Builders;
using CliInvoke.Core.Extensibility.Factories;

using CliInvoke.Specializations.Configurations;
using CliInvoke.Specializations;

    // ServiceProvider and Dependency Injection code ommitted for clarity
    
    IProcessInvoker _processInvoker = serviceProvider.GetRequiredService<IProcessInvoker>();
  IRunnerProcessFactory _runnerProcessFactory = serviceProvider.GetRequiredService<IRunnerProcessFactory>();
  
  //Create your runner configuration.
         ProcessConfiguration runnerConfig = new CmdProcessConfiguration("Your arguments go here",
                    // Set standard input, output, and error
          false, true, true, Environment.SystemDirectory);
  
  // Create your configuration to be run.
  ProcessConfiguration config = new ProcessConfiguration("Path/To/Exe",
  false, true, true, "With/Arguments")
  
  // Creates a ProcessConfiguration that will use the runner configuration to run the desired configuration.
  ProcessConfiguration processToRun = _runnerProcessFactory.CreateRunnerConfiguration(config, runnerConfig);
  
  ProcessResult result = await _processInvoker.ExecuteAsync(processToRun);

ClassicPowershellProcessConfiguration

The ClassicPowershellCommand is a specialized Command class with an already configured TargetFilePath that points to Windows' copy of powershell.exe.

This is only supported on Windows.

using CliInvoke.Core;
using CliInvoke.Builders;
using CliInvoke.Core.Builders;
using CliInvoke.Core.Extensibility.Factories;

using CliInvoke.Specializations.Configurations;
using CliInvoke.Specializations;

    // ServiceProvider and Dependency Injection code ommitted for clarity
    
    IProcessInvoker _processInvoker = serviceProvider.GetRequiredService<IProcessInvoker>();
  IRunnerProcessFactory _runnerProcessFactory = serviceProvider.GetRequiredService<IRunnerProcessFactory>();
  
  //Create your runner configuration.
         ProcessConfiguration runnerConfig = new CmdProcessConfiguration("Your arguments go here",
                    // Set standard input, output, and error
          false, true, true, Environment.SystemDirectory);
  
  // Create your configuration to be run.
  ProcessConfiguration config = new ProcessConfiguration("Path/To/Exe",
  false, true, true, "With/Arguments")
  
  // Creates a ProcessConfiguration that will use the runner configuration to run the desired configuration.
  ProcessConfiguration processToRun = _runnerProcessFactory.CreateRunnerConfiguration(config, runnerConfig);
  
  BufferedProcessResult result = await _processInvoker.ExecuteBufferedAsync(processToRun);

PowershellProcessConfiguration

The PowershellProcessConfiguration's TargetFilePath points to the installed copy of cross-platform PowerShell if it is installed.

This is only supported on platforms that cross-platform PowerShell supports.

using CliInvoke.Core;
using CliInvoke.Builders;
using CliInvoke.Core.Builders;
using CliInvoke.Core.Extensibility.Factories;

using CliInvoke.Specializations.Configurations;
using CliInvoke.Specializations;

    // ServiceProvider and Dependency Injection code ommitted for clarity
    
    IProcessInvoker _processInvoker = serviceProvider.GetRequiredService<IProcessInvoker>();
  IRunnerProcessFactory _runnerProcessFactory = serviceProvider.GetRequiredService<IRunnerProcessFactory>();
  
  //Create your runner configuration.
         ProcessConfiguration runnerConfig = new CmdProcessConfiguration("Your arguments go here",
                    // Set standard input, output, and error
          false, true, true, Environment.SystemDirectory);
  
  // Create your configuration to be run.
  ProcessConfiguration config = new ProcessConfiguration("Path/To/Exe",
  false, true, true, "With/Arguments")
  
  // Creates a ProcessConfiguration that will use the runner configuration to run the desired configuration.
  ProcessConfiguration processToRun = _runnerProcessFactory.CreateRunnerConfiguration(config, runnerConfig);
  
  BufferedProcessResult result = await _processInvoker.ExecuteBufferedAsync(processToRun);

Licensing

CliInvoke and CliInvoke Specializations are licensed under the MPL 2.0 license.

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