Skip to content

Get Started

Welcome to the MyShell documentation! This guide will help you get started with the myhsell CLI.

Concept

myshell is a CLI tool to manage and distribute custom scripts and use them in your daily work as native commands. It stores all scripts inside ~/.myshell folder and adds this to the path. This way, you can use your scripts as native commands in your terminal. myhsell also enables easy git integration to share your scripts with others and sync them across multiple devices.

Script Metadata

A script can contain metadata that provides information about the script. The metadata is a block of comments at the beginning of the script. Different metadata is encoded through different comment characters:

bash
#??This is the description
#&&comma,separated,tags
###Manual for script X
###Usage: x <arg>
###A manual can have multiple lines