stshell

STShell is for the efficient storage and management of shell scripts

Usage no npm install needed!

<script type="module">
  import stshell from 'https://cdn.skypack.dev/stshell';
</script>

README

STShell

STShell is for the efficient storage and management of shell scripts.

Build Status codecov devDependencies Status Greenkeeper badge semantic-release

npm latest version npm next version npm downloads per week npm total downloads

Table of Contents

About the Service

This repository is used to manage reusable shell scripts and helpers.

Most scripts are written for bash, but intended to work on most 'nix shells.

Note: Some scripts may not work as intended on Windows machines.

Features

  • Autoloading for aliases, functions, etc.
  • Well organized app-based directory structure
  • Easily add color and clean formatting to shell output

Install

Node.js/npm, and/or Yarn, can be used to load this package as a dependency. This will load STShell into the following directory inside your project root; ./node_modules/stshell

# Using NPM:
npm install stshell
# Using Yarn:
yarn add stshell

Usage

Import and use shell scripts via node_modules directory...

# Set variable for path to scripts directory:
STSHELL_SCRIPTS="./node_modules/stshell/scripts"

# Load shell support/helpers:
. "$STSHELL_SCRIPTS/support.sh"

# Run installer for Node/npm:
. "$STSHELL_SCRIPTS/apps/node/install.sh"

:point_up: more instructions coming soon.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.