shellman

Shell script snippet

Math example

Stopwatch example

fn... / fx... example

Requirements

• vscode
• bashdb (If you need to debug your scripts)

Usage

Install extension in vscode by:

ext install Remisa.shellman

Start typing and Shellman will provide you available commands.

For more convenience similar commands are grouped into same prefixes. Here is an overview:

bash

Shebang should be used as the first line of your script. You can replace bash with any other installed scripting language like node or python.

cmd...

Run external commands and check if operation succeeded.

color...

Write colorful

directory...

Directory operations

func...

Snippets related to function.

for...

Iterate different collections/arrays...

file...

File operations

format...

Write in bold, italic, dim, reverse format.

if...

Wide range of logical conditions which are more common in bash scripts.

math...

Math operations

string...

String utilities

stopwatch...

Start and stop, stopwatch and read elapsed time.

fn / fx

fn...

inserts a whole function into script. Function declaration should proceed its usage.

fx...

Call function which is declared by fn...

Functions

• banner simple
  • print a banner with provided title.
  • example: banner_simple "my title"
• banner color
  • print a color banner.
  • example: banner_color red "my title"
• import
  • Organize your project and reuse functions. Import functions from other shell script files. Default import directory is lib. This directory should be where the calling script exists and contain library files with .sh extension. For example if libname.sh contains some useful functions and exists in lib directory, you can import those functions into your script and call them.
  • example: import "somefile" will import all defined functions in somefile.sh from lib directory where calling script resides.
• scan
  • Scan host's port range (tcp/udp)

List of commands

Release Notes

2.1.0

• Documentation improved.
• import function (fn/fx) added.
  • Import functions from other shell script files.
• options function (fn/fx) added.
  • Provide a list of options to user.

2.0.0

• math...
  • math constants (π, e, Ω, ...)
  • math operations (with precision).

1.5.1

• string substring typo fixed.

1.5.0

• region: A region for specific purpose (functions, variables...)
• string manipulation
  • string length: length of string in characters.
  • string trim: remove leading and trailing white space(s).
  • string trim left: remove leading white space(s).
  • string trim right: remove trailing white space(s).
  • string trim all: remove all white space(s).
  • string replace: find all occurrences of a substrings and replace them.
  • string reverse: reverse string characters.
  • string toLower: convert string to lowercase.
  • string toUpper: convert string to uppercase.
  • string substring: part of the string from offset with [length] characters.
  • string contains: check whether string contains substring.
  • string indexOf: first index of substring in string.

1.4.0

• assign array: assign elements to an array.
• ip ...
  • ips: array of local IPs.
  • ip info: public ip information (country, city...).
  • ip public: public ip address.
• random number: generate random integer x such as min < x < max.
• service manage: manage service operations via systemctl.
• timeout: run command within a time frame. Cancel command if not finished within x seconds.
• fn/fx
  • scan: scan host's port range and find open ports (tcp/udp).

1.3.0

• stopwatch
• fn... / fx... whole function and usage insertion.
  • fn banner simple: insert function to print a banner.
  • fn banner color: insert function to print a color banner.

1.2.0

• Check last command success/failure via cmd...
• Directory operations via directory...

1.1.2

• Fixed vscode marketplace header color contrast

1.1.1

• Minor bugs fixed
• Write colorful text
• Write formatted text (bold, italic, dim, reverse)
• Snippet documentation added

0.0.1

Initial release