Page: Console API

Add DeathSocketCLI to Your Machine

Add NuGet to Your Project

CLI Aliases

CLI Home

CLI Project Breakdown

CLI Validation Overview

Changing the CLI Icon

Command Methods Overview

Console API

Console and Library Tests Overview

Creating the Input Loop

DeathSocket Home

DeathSocket Project Breakdown

DeathSocketCLI Home

DeathSockets Flow

DeathSockets Internal Flow

DeathSockets Main Files Overview

Home

Introduction to Death Socket

NuGet Home

Property and Unit Tests Overview

Repository Breakdown

ScratchPad Overview

Source Code Home

Test Centre Home

TestCentre Breakdown

The CLIs Flow

Using Death Socket in Your Project

Using the Console Program

HTTPS

4 Console API

Craig edited this page 5 years ago

Here is a list of the available commands in DeathSocketCLI. Each command uses the following template:

Name

• Parameters
• Description
• Usage Example(s)

test

• N.A.
• Display a text message indicating this program is running properly.
• test

help

• N.A.
• Displays a list of available commands provided by this program.
• help

exit

• N.A.
• Exits the program.
• exit

add-default

• (image-path: string) (new-path: string)
• Takes the image at image-path applies a 10x10 grid (in white) to it and saves the result at new-path.
• add-default C:/my-images/test-image-1.png C:/converted-images/converted-test.png
• add-default "C:/path with spaces in needs double-quotes/Image1.png" C:/images/converted-test.jpg

add-grid

• (image-path: string) (no-of-rows: int) (no-of-columns: int) (pen-width: float32) (colour: string) (new-path: string)
• Adds a grid to an image, using the specified parameters, and saves it.
• add-grid "C:/path with spaces in needs double-quotes/Image1.png" 10 5 2 red C:/new-image.png
• add-grid C:/orignal-image.png 16 3 12 red C:/new-image.png

list-colours

• N.A.
• Lists out the colours this program uses to draw its grids.
• list-colours

---

List of Available Colours

DeathSocketCLI uses a handful of colours in an attempt to keep things simple for the end-user. My thinking around this is it is easier to remember something like "red" than "#ef23ed". So, here are the list of colours you can use in DeathSocketCLI:

• blue
• brown
• black
• gray
• grey
• green
• purple
• red
• white
• yellow

Table of Contents

• Home
• Introduction to Death Socket
• Repository Breakdown

As Source Code

• Source Code Home

DeathSocket

• DeathSocket Home
• DeathSocket Project Breakdown
• DeathSocket's Main Files Overview
• DeathSocket's Flow
• DeathSocket's Internal Flow
• ScratchPad Overview

DeathSocketCLI

• DeathSocketCLI Home
• C.L.I. Project Breakdown
• The C.L.I's Flow
• Creating the Input-loop
• Command-Methods Overview
• C.L.I. Validation Overview
• Changing the C.L.I. Icon

TestCentre

• TestCentre Home
• TestCentre Breakdown
• Property and Unit Tests Overview
• Console and Library Tests Overview

As a Command-Line Interface (C.L.I.)

• C.L.I. Home
• Add DeathSocketCLI to Your Machine
• Using the Console Program
• Console A.P.I.
• C.L.I. Aliases

As a NuGet

• NuGet Home
• Add NuGet to Your Project
• Using Death Socket in Your Project