Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
S{cripting,ystem,tack} Management (SM) Framework (Core)

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
core
.gitignore
.gitmodules
CHANGELOG
LICENSE
LICENSE.gplv3
NOTES
README.md
ROADMAP.md
VERSION
install
local

README.md

Benevolent Delectable S{cripting,ystem} Management (BDSM) Framework

(Core)

BDSM is a system scripting and DSL & management framework for beating software and systems into submission!

Goal

BDSM delivers an extensible scripting framework providing a very robust DSL. A primary tenet of BDSM is that it must handle as much pain as possible, so you don't have to! With BDSM's DSL modules, you can quickly create your own high-quality extensions, and expose their commands through BDSM's flexible command line interface (CLI).

Architecture

BDSM itself is a scripting framework that enables very rich DSL sets known as modules. BDSM lets you use the DSL to painlessly write powerful 'extensions', which are essentially named sets of scripts (directories!). With BDSM, you'll find you can install and manage a multitude of extensions - and even entire sets of extensions - providing unprecedented levels of control and automation productivity that are unleashed by the creative abilities of BDSM's energetic community of extension authors :)

Creating Extensions

There are only a few requirements when creating your own BDSM extensions. The extension must live in a dedicated directory. Within this directory are (at least) the subdirectory bin/, containing at least one executable file called 'help'.

Additionally, in the root of the extension directory you must include a text file called VERSION, with a version number that follows semantic versioning convention (http://semver.org/); that is, in the format of X.Y.Z, where X,Y and Z are positive integers.

An extension must also have a README file, in which you should explain your extension's primary purpose, and any special considerations to be kept in mind when using it.

The contents of the bin directory can be any executable file. This means, for example, that C-compiled binaries, Ruby Scripts, python, lua, etc... may all be used according to your requirements and preferences.

Of course, the extensions I write are generally in bash; but you can bring your own implements of choice to the BDSM party ;)

Additionally, if you write your extensions in bash, a nice DSL is automatically loaded for you. You can read more about the DSL in the online documentation.

~Wayne

Wayne E. Seguin wayneeseguin@gmail.com http://github.com/wayneeseguin http://twitter.com/wayneeseguin https://bdsm.beginrescueend.com/ https://rvm.beginrescueend.com/

Contributing

In the spirit of free software, everyone is encouraged to help improve this project.

Here are some ways you can contribute:

by using the latest development and release versions by reporting bugs in #beginrescueend on irc.freenode.net by suggesting new features in #beginrescueend on irc.freenode.net by writing or editing documentation, which is greatly appreciated by translating documentation to a new language, I speek tech and poor engrish by writing extensions by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace) by performing code reviews and assisting with refactoring by resolving issues by reviewing patches by donating, xoxo!

License

All BDSM Core scripts and extensions themselves are are licensed under the Apache License v2.0

Copyright (c) 2009-2011 Wayne E. Seguin

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.

License Exceptions:

bin/bdsm-ll is GNU Parallel and is licensed under the GNU GPL v3 which can be read here: http://www.gnu.org/licenses/gpl.html

Something went wrong with that request. Please try again.