https://github.com/seantrane/stshell

:shell: For efficient management of shell scripts
https://github.com/seantrane/stshell

automation bash bash-script shell shell-script

Last synced: 5 months ago
JSON representation

:shell: For efficient management of shell scripts

• Host: GitHub
• URL: https://github.com/seantrane/stshell
• Owner: seantrane
• License: apache-2.0
• Created: 2018-04-15T18:26:46.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2019-03-03T14:34:33.000Z (over 7 years ago)
• Last Synced: 2025-10-05T09:47:07.835Z (9 months ago)
• Topics: automation, bash, bash-script, shell, shell-script
• Language: Shell
• Homepage:
• Size: 95.7 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# STShell

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

[![Build Status](https://travis-ci.org/seantrane/stshell.svg?branch=master)](https://travis-ci.org/seantrane/stshell) [![codecov](https://codecov.io/gh/seantrane/stshell/branch/master/graph/badge.svg)](https://codecov.io/gh/seantrane/stshell) [![devDependencies Status](https://david-dm.org/seantrane/stshell/dev-status.svg)](https://david-dm.org/seantrane/stshell?type=dev) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![npm latest version](https://img.shields.io/npm/v/stshell/latest.svg)](https://www.npmjs.com/package/stshell) [![npm next version](https://img.shields.io/npm/v/stshell/next.svg)](https://www.npmjs.com/package/stshell) [![npm downloads per week](https://img.shields.io/npm/dw/stshell.svg)](https://www.npmjs.com/package/stshell) [![npm total downloads](https://img.shields.io/npm/dt/stshell.svg)](https://www.npmjs.com/package/stshell)

## Table of Contents

- [About the Service](#about)

  - [Features](#features)

- [Install](#install)

- [Usage](#usage)

- [Contributing](CONTRIBUTING.md)

- [License](#license)

---

## 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](https://nodejs.org/)/[npm](https://www.npmjs.com/), and/or [Yarn](https://yarnpkg.com/),

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`

```bash

# Using NPM:

npm install stshell

# Using Yarn:

yarn add stshell

```

## Usage 

### Import and use shell scripts via `node_modules` directory...

```bash

# 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

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.