From a9d5622be2a5f30374dc38a81354c4e1c0d2e099 Mon Sep 17 00:00:00 2001 From: Craig Date: Mon, 17 Jun 2019 18:01:26 +0100 Subject: [PATCH] create Using the CLI page. --- Home.md | 2 +- Using-the-Console-Program.md | 61 ++++++++++++++++++++++++++++++++++++ 2 files changed, 62 insertions(+), 1 deletion(-) create mode 100644 Using-the-Console-Program.md diff --git a/Home.md b/Home.md index c65d924..fc67a35 100644 --- a/Home.md +++ b/Home.md @@ -37,7 +37,7 @@ Before continuing, I recommend you are familiar with the following; refer to it as this (instead of "testing library") throughout the wiki. 4. The console project uses a NuGet package called - Console.Waterworks. I will usually refer to as "C.W." + Console.Waterworks. I will usually refer to it as "C.W." 5. In an attempt to keep a level of consistency, I will abbreviate words with a full-stop. So, "HTML" will be written as H.T.M.L. This is because I usually abbreviate "non-tech." words diff --git a/Using-the-Console-Program.md b/Using-the-Console-Program.md new file mode 100644 index 0000000..a1c2548 --- /dev/null +++ b/Using-the-Console-Program.md @@ -0,0 +1,61 @@ +In this repository is a traditional .Net 4.7 console called +DeathSocketCLI. It allows you to utilise the features in the +repository’s main project without writing code. The other project’s +name is DeathSocket and it is a .Net Standard 2.0 library. I should, +also, point out DeathSocketCLI does not come with an installer but you +can run it wherever .Net 4.7 is. + +This section assumes you have already have DeathSocketCLI on your +machine. If you do not, please use the following link to learn how +to do that; + +- [Adding DeathSocketCLI to your Machine](Adding-DeathSocket-to-your-Machine) + +To operate the CLI, you enter commands and its required arguments; +Which is similar to how other CLI’s work. With that said, I build the +CLI with Console.Waterworks (C.W.) so it does not work exactly like +PowerShell, for example. This means you need to put aside your +assumptions if you are a regular user of shells, terminals, consoles +and prompts. + +Because the focus of this wiki is on DeathSocketCLI, I +will not go into too much detail here about C.W. Having said that, you can +find out more about C.W. by using the following links; + +- [Console.Waterworks Repository](https://gitlab.com/craig.oates/Console.Waterworks) +- [Console.Waterworks Wiki](https://gitlab.com/craig.oates/Console.Waterworks/wikis/home) +- [Console.Waterworks.Core Repository](https://gitlab.com/craig.oates/Console.Waterworks.Core) +- [Console.Waterworks.Core Wiki](https://gitlab.com/craig.oates/Console.Waterworks.Core/wikis/home) + +When you start the console, you will see something similar to the +following image; + +IMAGE OF CLI AT START. + +From here, you can begin entering +commands. Before continuing, it is worth noting the help command. When +you enter help into the prompt, the console will list out all the +commands the program has to offer. + +IMAGE OF HELP SECTION IN CLI. + +If you would like to view the source code of the commands, you can +peruse through them all using the following link; + +- [Commands.fs](https://gitlab.com/craig.oates/Death-Socket/blob/master/DeathSocketCLI/Commands.fs) + +If you go through the “help” section, you will notice most of the +commands have input arguments. From your point-of-view, they are +typical (input) types (int, string Etc.). There are limitations to +these arguments but they are outside the scope of this wiki. If you +would like to know more about about these limitations, please use the +following link; + +- [Coerce List](https://gitlab.com/craig.oates/Console.Waterworks/wikis/Coercion-Types-List) + +After a while, you should start to get proficient with +DeathSocketCLI. When you do, the command names might start feeling a +little clunky and long-winded. If that is the case, you can head over +the aliases section. The link for that section is as follows; + +- [CLI Aliases](CLI-Aliases)