CShell.Template 1.4.0

<img src="https://github.com/tomlm/CShell/raw/master/turtle.png" width="100"/>

CShell

CShell creates a runtime environment to make it easy to create C# based shell style scripts.

Description

CShell is built using MedallionShell and runs great using dotnet-script (.csx) giving you a great cross platform C# alternative to powershell and bash scripts.

CShell provides:

• The concept of a current folder with relative commands for navigating and manipulating files and folders
• The ability to smoothly invoke processes and pipe
• Helpers to make it easy to work with the output of processes

By maintaining the concept of a current folder all file and folder commands can be take absolute or relative paths just like a normal shell.

Properties

CShell exposes 3 properties which are the working environment of your script. The CurrentFolder is used to resolve relative paths for most methods, so if you call MoveFile(@"..\foo.txt", @"....\bar") it will resolve the paths and execute just like a normal shell.

Folder Methods

CShell defines a number of methods which work relative to the current folder to make it easy to manipulate folders.

File Methods

CShell defines a number of methods which work relative to the current folder to make it easy to manipulate files.

Process Methods

CShell is built using MedallionShell, which provides a great set of functionality for easily invoking processes and piping data between them. CShell adds on location awareness and helper methods to make it even easier to work with the output of processes.

// Invoke multiple commands using fluent style
var cmd1= await Run("cmd1", "args1")
    .PipeTo("cmd2", "args2", "args3")
    .PipeTo("cmd3", "args4");
var result1 = await cmd1.AsResult();

// we can even chain commands together with the pipe operator
var cmd2 = await Run("cmd1", "args1") 
    | Run("cmd2", "args2", "args3") 
    | Run("cmd3", "args4");
var result2 = await cmd2.AsResult();

// we can even chain commands together with the > operator
var = await Run("cmd1", "args1") 
    > Run("cmd2", "args2", "args3")
    > Run("cmd3", "args4");
var result3 = await cmd3.AsResult();

The CommandResult object has StandardOutput, StandardError information for further processing.

Working with results

CShell adds on helper methods to make it even easier to work with the result of a command chain.

To call a program you await on:

1. call ReadFile()/Run()/Cmd()/Bash()/echo()
2. call any chaining commands
3. end with a result call like Execute()/AsJson()/AsString()/AsXml()etc.

The result methods all take a log argument is passed set to true then the commands output will be written to standard out.

global using static CShellNet.Globals;
using CShellNet;

Console.WriteLine("Hello world!");

// run a command and interpret the json as an AccountInfo object
var account = await Cmd("az account show").AsJson<AccountInfo>();
    
// run a command and interpret the XML as an AccountInfo object
var account2 = await Cmd("az account show -o xml").AsXml<AccountInfo>();
    
// run a command interpret the result as a string.
var accountString = await Cmd("az account show").AsString();
    
// run a command and get back the CommandResult which has Succes, StatusCode, StandardInput and StandardError.
var result = await (Run("x", "foo") | Cmd("az account show")).AsResult();
if(result.Sucess)
{
    var output = result.StandardOutput;
    ...
}

CShell + dotnet-script == awesome

CShell is a dotnet library which can be used in any .net program, but it is super useful to use from a dotnet-script (.csx) file. There is a dotnet template to make it super easy to create a .csx file with CShell all set up to use.

To install dotnet-script support

dotnet tool install -g dotnet-script

To install the csx template

dotnet new --install CShell.Template

To invoke the template

dotnet new cshell

NOTE: If you want debug support from visual studio code simply run dotnet script init in the same folder.

#r "nuget: CShell, 1.4.0"
global using static CShellNet.Globals;
using CShellNet;

Console.WriteLine("Hello world!");
foreach (var arg in Args)
{
    md(arg);
    ...
}

Registering .csx files to be executable on windows

You can register dotnet-script as the default handler for .csx files by running these commands:

dotnet script register

After registering you can simple type your.csx to execute your cshell program.

CHANGELOG

V1.4.0

• Added Start() method for detached processess (you can monitor process but not access input/output)
• Added Run(Action<Option>, process, arg1, arg2) signature to control options for starting processes
• Added echo() method for piping strings/streams into .Run() commands.
• Added CShellNet.Globals which enables top-level mainless .cs/.csx projects

V1.2.3

• Added log parameters to AsJson()/AsXml()/AsResult() output standardOut/StandardError
• added Execute() as alias for AsResult() as that seems cleaner then AsResult()

v1.2.1

• Added ThrowOnError property to turn on/off throwing on command failing.

v1.2.0

• Added echo(true) echo(false) to turn on off echo of the commands
• added Cmd(".....") to allow you to execute cmd.exe functions (Example: Cmd("dir /b foo") )
• added Bash("....") to allow you to execute bash commands (Example: Bash("ls -al") )
• Upgraded MedalianShell to 1.6.1
• upgraded JSon.Net to 12.x