odb / shml

SHell Markup Language | Style Framework for The Terminal

SHML v.1.1.0

SHML is a shell framework for faster and easier script development.

Why

HTML has CSS, terminals have "ANSI/VT100 Control Sequences". SHML makes is easy to apply some style to your shell scripts without trying to remember that Yellow = \033[33m instead Yellow is $(color yellow).

1-liner Install

# Unix-like
$ sudo bash -c 'curl -L https://raw.githubusercontent.com/odb/shml/1.1.0/shml.sh -o /usr/local/bin/shml && chmod +x /usr/local/bin/shml'

# Homebrew
$ brew install shml

# npm
$ npm install -g shml

Download

You can just download SHML without installing it...

Git

$ git clone https://github.com/odb/shml.git

wget

$ wget https://raw.githubusercontent.com/odb/shml/master/shml.sh

Sourcing

In order to use SHML you must tell your shell environment where it is located. Lets assume that we are writing a BASH script and want to use SHML.

If you installed in using the 1-liner above you would do:

#!/usr/bin/env bash
source $(which shml)

If you downloaded SHML using git or wget you would do:

#!/usr/bin/env bash
source ./shml.sh

Examples

#!/usr/bin/env bash
source "$(which shml)"

echo "
$(fgcolor red)
This will make the text red...
$(fgcolor end)
"

View all examples: https://odb.github.io/shml/getting-started/

Contributing

Contributions are more than welcome. Before submitting ANY new features please read the Contribution Guidelines.

To report any bugs or if you have a feature request feel free to open an issue.

Updating The Docs

Updating the docs requires Ruby/Jekyll to generate & view locally.

Run once:

$ cd docs/
$ gem install bundler
$ bundle install

Generate and serve:

$ bundle exec jekyll s --watch

Then go to: http://localhost:4000/shml/

shml's Issues

Remove Runnable Demo links

Runnable got acquired and shut down the service.

Need to remove the "Demo on Runnable" images in docs and README

1.1.0 post-release tasks

• Update Homebrew
• Tweet
• Promote on BootstrapCDN?
• Update npm
• Update nokogiri ~> 1.8.2 - https://cl.ly/1I2v2p2c313T
• Fix latest e.g. https://raw.githubusercontent.com/odb/shml/latest/shml.sh

You can install shml with Awesome package manager

Hi, I created Awesome package manager and I can install your repo using it.

After installing the Awesome:

awesome -i odb/shml shml.sh

If you can put it in your README, it will be awesome.

Thanks.

Shin

Error when sourcing

Error Message

/usr/local/bin/shml:360: = not found

Line 358 - 365

# Usage / Examples
##
if [ "$0" == "$BASH_SOURCE" ]; then

if [[ $@ =~ .*-v.* ]]; then
  echo "shml version ${SHML_VERSION}"
  exit 0
fi

Add basic installer.

I'd like to add an installer modeled after the one used in odb/shunt. Not sure about the adding to path though, as this isn't technically an executable. If done, I'm thinking it could be sourced with:

source "$(which shml.sh)"

Feedback welcome.

Apple product used in photos

Please remove Apple from something that is connected to the FSF.

"Command not found" in OSX

Keep getting this:

Remove 2nd example in Docs under `npm`

Somehow the source instructions was added under npm install. It should be removed.

Link: https://odb.github.io/shml/getting-started/#Install

cc: @Mandihamza

[Security] nokogiri dependency

@jmervine is this something we need to worry about?

https://github.com/odb/shml/network/dependencies#30372747

tests run against version of shml in shunt...

shunt includes shml, therefore tests are running against that version and not the local shml... no good.

Rework tests...

The current abstraction of tests tests.sh sourcing *_tests.sh files makes it harder to tell where the error is coming from. Tests need to be reworked.

Controlling the Prompt with not-printable sequences.

My bash prompt work incorrect when use shml.
If prompt line too long, then text will overwrite the screen of current line and hard to see.

This bug appear because non-printable sequences. I fix this after add "\[" and "\]" in fgcolor and bgcolor.

Further reading:

• https://www.gnu.org/software/bash/manual/bashref.html#Controlling-the-Prompt

PR
#51

Docs: Switch to Kramdown

Need to replace redcarpet with kramdown:

The page build completed successfully, but returned the following warning:

You are currently using the 'redcarpet' Markdown engine, which is no longer supported by GitHub Pages and may cease working at any time. To ensure your site continues to build, remove the 'markdown' setting in your site's '_config.yml' file and confirm your site renders as expected. For more information, see https://help.github.com/articles/updating-your-markdown-processor-to-kramdown/.

The problem is when we switch to Kramdown we have issues with rendering:

Replace icon characters with codes (where possible).

Currently attributes (bold, italics, etc) aren't working...

I haven't been able to confirm if this is isolated to me or not, @jdorfman mind testing on a Mac? I'm running on Ubuntu / xterm.

`confirm` function

Add confirm with usage like so:

# with success callback
on_succes() {
    echo "Success"
}
confirm "Did you succeed?" "on_success"

# with success and failure callbacks
on_failure() {
    echo "Failed"
}
confirm "Did you succeed?" "on_success" "on_failure"

# w/o callbacks
config "Did you succeed?" && echo "Why yes, yes I did!"

@jdorfman thoughts?