Giter Club home page Giter Club logo

bhrshellscriptlibrary's Introduction

BHRShellScriptLibrary

What is the Shell Script Library?

The Script Library is a collection of useful bash scripts, which can be accessed by all SimpleSSH users.

Everyone can contribute to the Script Library and make his scripts available for other users.

We're happy to help you, if you need assisstance adding your scripts or have problems adding them.

How to Contribute

You can add scripts by creating a pull request to the main Script Library repository.

  1. Fork BHRScriptLibrary.
  2. Add your scripts to scripts.json by respecting the script guidelines.
  3. Validate scripts.json with http://jsonlint.com
  4. Press the green button in the upper left corner, review your changes and submit the pull request via Create Pull Request.
  5. After being reviewed, your scripts will be part of the Script Library.

Script Guidelines

All scripts are located in scripts.json. The basic structure is a an array of Groups, that have children. Each child is a Command.

File Structure Illustration:

[ 
	Group [
		Command,
		Command
		],
	Group [
		Command,
		Command,
		Command 
		]
]

A Group must have the following properties:

  • Name
  • Description
  • UID
  • Children (Array of Commands)

A Command must have the following properties:

  • Name
  • Description
  • Script
  • Show Result
  • Timeout (0 is no timeout)
  • UID

For UID generation please use http://www.guidgenerator.com.

Additional Resources:

Disclaimer

No guarantee is provided that the scripts will function properly on your system. Some require additional packages. No warranty for loss or corruption of any data.

Use the scripts at your own risk!

bhrshellscriptlibrary's People

Contributors

bhr avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.