bpkg

kewt

2026-03-20T00:00:00+00:00

bdo-cli

2025-03-23T00:00:00+00:00

Usage

bdo help - Show all available commands
bdo create <repo-name> - Create and initialize a new repository
bdo push - Add, commit, and push changes
bdo branch <branch-name> - Create and push a new branch
bdo checkout - Reset to match remote main branch
bdo remove - Uninstall bdo-cli from your system

parse_quick_parameters.sh

2024-11-24T00:00:00+00:00

layout: post title: “parse-quick-parameters” description: “Given a docstring, configures named parameters for a bash function” category: bash tags: [bash] —

Provide a documentation string to get named function parameters. Fork of msknapp’s. Similar to docopt

Installation

Just copy the file or use package managers.

Use bkpg

Get bpkg.

To get the source version:

bpkg install matthewdeanmartin/parse_quick_parameters.sh

To get the hosted version:

bpkg install parse_quick_parameters

Use git-remote-get

This is a fancy way of just downloading git files.

pip install git-remote-get
git-remote-get ./ --owner matthewdeanmartin --repo "parse_quick_parameters.sh" deps

Usage

#!/usr/bin/env bash
source deps/parse_quick_parameters/parse_quick_parameters.sh

function do_something_quick {
    parse_quick_parameters "my_file=-f|--file,bool:run=-r|--run,name=-n|--name" "$@" || return 0
    echo "my file is: $my_file"
    echo "my name is: $name"
    echo "run is: $run"
}

>> source parse_quick_parameters.sh
>> do_something_quick --name name --run --file file
my file is: file
my name is: name
run is: true
>> do_something_quick "file" "name" --run
my file is: file
my name is: name
run is: true

Notes

Shellcheck doesn’t understand the pattern and will raise SC2154

Alternatives

getopts Builtin bash command
docopts Shell version of docopts
argparse-bash Use python’s argparse in bash

Contributing

Use Makefile. bats tests assume bats was installed with npm.

make format lint test

Credits

msknapp

drawercli

2024-06-18T00:00:00+00:00

This cli app supports using termuxlauncher as your primary launcher for Android phones, interactively and easily install. That’s simply the Termuxlauncher Add-on built with fzf🚀

Usage

drawercli …or for the help drawercli --help

shellshoccar-jpn-tukubai

2024-06-10T00:00:00+00:00

This is shellscript implementation of usp Tukubai.

Most of their commands work for line-record space-separated text files.

Some commands

self selects specified fields.

zen and han convert katakana and alphanumeric characters on specified fields into zenkaku and hankaku respectively.

sm2, sm4 and sm5 report your business.

keta aligns your data.

Author

Tpaefawzen

This is a fork of Shellshoccar-jpn’s project, which is a fork of usp-engineers-community’s project.

Licenses

Mixture of MIT, CC0 and ISC licenses

bash-db

2024-03-26T00:00:00+00:00

bash-db

Very simple Key-Value database on bash script. Depends on pre-installed software only (tested on Ubuntu 14.04 LTS):

sed
bash
grep
base64
xargs

Install

bpkg (global package)

bpkg install reddec/bash-db

Make (/usr/local/bin)

make install

Manual Installation

git clone https://github.com/reddec/bash-db
cd bash-db
chmod +x db.sh
cp db.sh /usr/local/bin/db

Usage

Command-line Tool

db <method> <database> [arguments...]

Methods:

PUT

Insert or update record.

Arg	Description
`key` (required)	Unique key. Can be used any value (also spaces if value in bracets)
`value` (optional)	Value of record. Can be used any value (also spaces if value in bracets). If value not set, STDIN will be used.

Example:

db put test.db name 'Red Dec'

GET

Get value of record by key

Arg	Description
`key` (required)	Unique key. Can be used any value (also spaces if value in bracets)

Example:

db get test.db name

LIST

Get all keys in database

No arguments

Example:

db list test.db

LAST

Get the value of the last added record

No arguments

Example:

db last test.db

DELETE

Delete record by key

Arg	Description
`key` (required)	Unique key. Can be used any value (also spaces if value in bracets)

Example:

db delete test.db name

bash-templater

2024-02-14T00:00:00+00:00

bash-templater empowers efficient templating within Bash scripts, streamlining the creation of configuration files, documentation, and more. With its intuitive syntax and powerful features, you can effortlessly craft dynamic output.

TL;DR

Installing:

 bpkg install vicentebolea/bash-templater

Using it:

templater vars < file.template

USE ME

You have this file.template:

# My template
## Author
 - @NAME@ <@EMAIL@>

And this rules file:

NAME=LEOPOLDO WINSTON
EMAIL=leothewinston\@leoserver.com

You execute this command:

templater rules < file.template

You get this:

# My template
## Author
 - LEOPOLDO WINSTON <leothewinston@leoserver.com>

The only rule

Escape the @ character like \@ in the rules file.

INSTALL ME

Use the fantastic BASH package manager BPKG and just:

bpkg install vicentebolea/bash-templater

echo-eval

2024-02-06T00:00:00+00:00

This minimalist library takes a bash command as a string, prints it with a shell prompt in front of it, then runs that command using eval.

$ jq --version
jq-1.6

This pattern minimizes the time it takes to debug your bash systems by leaving logs resembling someone typing at a terminal.

Installation

You can install this globally…

sudo bpkg install -g kj4ezj/echo-eval

…or as a project dependency.

bpkg install kj4ezj/echo-eval

If you install it as a bpkg dependency then you will need to source it in your scripts.

source deps/bin/ee

Your paths may vary.

Usage

This library takes the input you give it, prints or echoes it to the terminal with a fake shell prompt in front of it, then tries to run it as a command. For example, the output of this…

ee uname

…looks like this on Linux.

$ uname
Linux

You can invoke ee as a function…

ee echo test

…or as a file.

./ee.sh echo test

Some commands may need to be encased in quotes to work the way you intend. For example, dc is sensitive to whitespace.

echo-eval$ ee dc -e '1 2 + p'
$ dc -e 1 2 + p
dc: Could not open file 2
dc: Could not open file +
dc: Could not open file p
echo-eval$ ee "dc -e '1 2 + p'"
$ dc -e '1 2 + p'
3

In this example, we want the input to ee to include the pipe (|).

echo-eval$ export EXAMPLE='yeet'
echo-eval$ ee printf "$EXAMPLE" | wc -c
18
echo-eval$ ee 'printf "$EXAMPLE" | wc -c'
$ printf "$EXAMPLE" | wc -c
4

Quotes were needed to get the correct output of four characters.

bashunit

2023-09-11T00:00:00+00:00

Usage

Write tests files like:

# file: tests/my_test.sh

function test_using_snake_case() {
  assertEquals "1" "1"
  assertContains "Linux" "GNU/Linux"
}

function testUsingCamelCase() {
  assertNotContains "Linus" "GNU/Linux"
  assertMatches ".*Linu*" "GNU/Linux"
  assertExitCode "0"
}

Then run the test:

$ bashunit tests/my_test.sh

Running logic_test.sh
✓ Passed: UsingCamelCase
✓ Passed: Using snake case

Tests:      2 passed, 2 total
Assertions: 5 passed, 5 total
All tests passed

protobuf-parser-bash

2023-07-07T00:00:00+00:00

A Protobuf parser, encoder and decoder in Bash.

Install

bpkg install [-g] lafkpages/protobuf-parser-bash

records.sh

2023-06-13T00:00:00+00:00

See https://github.com/orbit-online/records.sh for the full README and more advanced use-cases.

Usage

Source the script with source "records.sh" and log messages with the lowercased loglevel as the function name:

debug 'Starting up.'
verbose 'Startup completed'
info 'Hello world!'
warning 'Careful!'
error 'Oh no!'

The method signature of the logging functions mimic that of printf: info FORMAT [ARGS...]. Which means you can format variables.

$ var=0x1f
$ info "The decimal version of %s is %d" "$var" "$var"
example.sh: The decimal version of 0x1f is 31

All log messages are output to stderr. If you want to log something to stdout simply run e.g. info 'message' 2>&1.

bash-util-lib

2022-11-12T00:00:00+00:00

Bash Utility Library - A library of bash utility functions (from output colors to parameter processing) for use in small projects.

Install

bpkg install [-g] wsi-services/bash-util-lib

Usage

source "deps/bash-util/bash-util-lib.sh"

Bats

2021-10-23T00:00:00+00:00

Usage

Write tests into *.bats files like:

#!/usr/bin/env bats

@test "addition using bc" {
  result="$(echo 2+2 | bc)"
  [ "$result" -eq 4 ]
}

Then run the test:

$ bats test.bats
 ✓ addition using bc

1 test, 0 failures

magic-version

2021-08-14T00:00:00+00:00

calculate version for CI (CODING, GitHub Actions, Jenkins)

when	version
tag	1.2.0
branch	main-3a11e12
MR	mr-123-3a11e12
PR(GitHub)	pr-123-3a11e12

bpkg install [-g] sinkcup/magic-version

Usage

export TAG_NAME=1.2.0
magic-version

1.2.0

more examples in test code

chap

2021-05-06T00:00:00+00:00

Installation

$ bpkg install [-g] kirtfitzpatrick/chap

Requirements

bash 4.0 or greater

Usage

$ chap info_msg "Hello, world."

Info: Hello, world.

$ chap -h
Usage:
  chap [-hV]
Options:
  -h|--help      Print this help dialogue and exit
  -V|--version   Print the current version and exit

Logging:
  info_msg           MESSAGE
  nominal_msg        MESSAGE
  attention_msg      MESSAGE
  warning_msg        MESSAGE
  modification_msg   MESSAGE

Evaluation:
  info_cmd           COMMAND [ MESSAGE ]
  nominal_cmd        COMMAND [ MESSAGE ]
  attention_cmd      COMMAND [ MESSAGE ]
  warning_cmd        COMMAND [ MESSAGE ]
  modification_cmd   COMMAND [ MESSAGE ]

Internal:
  echo_cmd           COMMAND
  display_link       FILE_LINK_OR_DIR_PATH
  brief_echo         OUTPUT_BUFFER
  brief_eval         COMMAND

Special purpose:
  print_header       "$0 $*"
  verify_line_count  LABEL COMPARISON_OP VALUE COMMAND
  confirm_cmd        COMMAND [ MESSAGE ]
  confirm_reset      # Reset auto-confirm

Example

#!/usr/bin/env bash
source deps/bin/chap

chap print_header "$0 $*"
chap info_msg "Let's verify line counts."
chap verify_line_count \
  "files" "-ge" 4 \
  "find . -type f -or -type l"

echo ""
chap info_msg "FYI."
chap nominal_msg "As expected."
chap attention_msg "Hey old chap, pay attention."
chap warning_msg "Something's wrong."
chap modification_msg "We're making a change."

echo ""
chap info_cmd \
  "grep -A 5 'brief_eval {' deps/bin/chap" \
  "Implementation of brief_eval."

echo ""
chap confirm_cmd "find . -name '*.sh'" \
  "Prompt to confirm or skip."

Host: Kirts-MacBook-Pro-2019.local
Command: ./demo.sh
Working Dir: /Users/kirt/Dropbox/Development/Bidpath/chap-demo

Info: Verify correct file count.
Nominal: 4 files found.
find . -type f -or -type l
./demo.sh
./deps/bin/chap -> ../chap/chap.sh
./deps/chap/chap.sh
./deps/chap/package.json

Info: FYI.
Nominal: As expected.
Attention: Hey old chap, pay attention.
Warning: Something’s wrong.
Modification: We’re making a change.

Info: Implementation of brief_eval.
grep -A 5 ‘brief_eval {‘ deps/bin/chap
function chap_brief_eval {
CMD=$1
OUTPUT=$(eval “${CMD}”)

chap_brief_echo “${OUTPUT}”
}

Info: Prompt to confirm or skip.
find . -name ‘*.sh’
Execute (a=all, s=skip):
Initiated at: 15:22:37
./demo.sh
./deps/chap/chap.sh
Completed at: 15:22:37

passmenu

2021-03-30T00:00:00+00:00

This package integrates pass and dmenu. It gets all passwords from ~/.password-store, pipes them to dmenu, and selection is copied to clipboard.

Usage

passmenu

lcov.sh

2020-06-01T00:00:00+00:00

Coverage framework for Shell projects

Usage

Add the following code [[ -z "${LCOV_DEBUG}" ]] || set -x on top of source file you want in a coverage report, see below example:

#!/bin/bash
[[ -z "${LCOV_DEBUG}" ]] || set -x

welcome () {
    echo "Hi $1, I'm testable code"
}

welcome "John"

Now, run from command line the following command:

lcov.sh FILE...

warp

2019-05-07T00:00:00+00:00

Tired of figuring out the relative path to a file, so you can copy it? Tire no more! Warp is a small bash tool to move or copy a file from one location to another.

Basic Usage

To copy a file in a directory in one terminal, to the directory of another terminal, first warp in the file

warp in foo.txt

In the other terminal, warp copy it

warp cp .

npm-publish

2018-09-14T00:00:00+00:00

A npm module publisher.

Usage

PACKAGE_NAME=<name> NEW_VERSION=<version> npm-publish

uget

2018-01-11T00:00:00+00:00

Downloads a file from an url choosing between wget or curl, or gently warns that the current system can’t make the download. This packages frees the package developer the responsability to check the downloads utility in the target user computer.

Usage

uget THERESOURCEURI

rmate

2017-06-28T00:00:00+00:00

Description

This shell script needs to be installed on a remote machine to allow editing files using TextMate 2 (TM2). TM2 needs to be configured accordingly to accept either local or remote clients.

Local clients

It’s a good idea to allow access to TM2 only for local clients. In this case it’s required to open a SSH connection to the remote system and specify a remote tunnel in addition:

ssh -R 52698:localhost:52698 user@example.com

After log-in on the remote system a file can be edited by just executing

rmate test.txt

Remote clients

On some machines, where port forwarding is not possible, for example due to a missing ssh daemon, it’s required to set TM2 to allow access for “remote clients”. After log-in on the remote machine a file can be edited by executing

rmate -H textmate-host test.txt

Requirements

A bash with compiled support for “/dev/tcp” is required.

Usage

Edit specified file

$ ./rmate [arguments] [--] file-path

Read text from stdin

$ echo "hello TextMate" | ./rmate [arguments] -

Arguments

-H, --host HOST  Connect to HOST. Use 'auto' to detect the host from SSH.
-p, --port PORT  Port number to use for connection.
-w, --[no-]wait  Wait for file to be closed by TextMate.
-l, --line LINE  Place caret on line number after loading file.
+N               Alias for --line, if N is a number (eg.: +5).
-m, --name NAME  The display name shown in TextMate.
-t, --type TYPE  Treat file as having specified type.
-n, --new        Open in a new window (Sublime Text).
-f, --force      Open even if file is not writable.
-v, --verbose    Verbose logging messages.
-h, --help       Display this usage information.
    --version    Show version and exit.

Default parameter configuration

Some default parameters (host and port) can be configured by defining them as the environment variables RMATE_HOST and RMATE_PORT or by putting them in a configuration file. The configuration files loaded are /etc/rmate.rc and ~/.rmate.rc, e.g.:

host: auto  # prefer host from SSH_CONNECTION over localhost
port: 52698

Alternative notation for configuration file is:

host=auto
port=52698

The precedence for setting the configuration is (higher precedence counts):

default (localhost, 52698)
/etc/rmate.rc
~/.rmate/rmate.rc
~/.rmate.rc
environment variables (RMATE_HOST, RMATE_PORT)

bash-backup

2017-06-19T00:00:00+00:00

Usage

$ git clone git@github.com:newsdict/bash-backup.git
$ cd bash-backup
$ cp env-example .env

Edit .env file

$ bash backup.sh [--debug]

Multiple Targets

$ git clone git@github.com:newsdict/bash-backup.git
$ cd bash-backup
$ cp env-example .env-sample1

Edit .env-sample1 file

$ cp env-example .env-sample2

Edit .env-sample2 file

$ sh backup.sh [--debug] sample1
$ sh backup.sh [--debug] sample2

Flow

Archive the datas. (tar.gz or tar.bz2 or zip)
mysqldump - only mysql yet….
Rearchive the 1 and 2 (tar.gz or tar.bz2 or zip)
Upload to S3. (Generation management) - only s3 yet…….

Environments

Temporary Directory

temporary_directory=tmp

log name

log_name=logs/backup.$now.log

backup filename

backup_filename=backup

display messages

display_messages=1

Execute archive

archive=1

Archive paths or files

declare -a archive_paths=(
    "/var/www/html"
    "/etc/nginx"
)

Compression type of backup

commpression_type=gzip

gzip: *.tar.gz
zip: *.zip
bzip2: *.tar.bz2

Execute database

database=1

Database Type for Dump

declare -A database_conf=(
    ["engine"]="mysql" # mysql only
    ["name"]="sample1_database" # database name
    ["username"]="user1" # username
    ["password"]="pass" # password
    ["host"]="127.0.0.1" # host
    ["port"]=3306 # port
)

Storage type for backup files

storage_type=s3

s3 only

s3 info

declare -A s3_conf=(
    ["keep"]=5
    ["access_key"]=""
    ["secret"]=""
    ["bucket"]="backup"
    ["path"]="test"
    ["region"]="ap-northeast-1"
)

wipe modules

2017-05-03T00:00:00+00:00

A little agent that removes the node_modules folder of non-active projects

Why

If you’re a Javascript developer, you know the node_modules directory holds thousands or even millions of files, resulting in taking a lot of space in your hard disk.

Enter wipe-modules, a little agent that wipes (eats, literally) that big node_modules directory of non-active projects.

Why in Earth would you want to have those monster-sized node_modules folders on inactive projects? You got your package.json to recreate it whenever you want, right?

Usage

$ wipe-modules --help

  Usage: wipe-modules [path] [days]

  Path:
    The full path of your code directory

  Days:
    The days you want to set to mark projects as inactive

  Example: wipe-modules ~/code 30

  That will remove the node_modules of your ~/code projects
  whose been inactive for 30 days or more.

Using cron

wipe-modules can be executed as a background job using using cron

The default included cron-file file holds the following syntax:

0 11 * * * $HOME/bin/wipe-modules ~/code_dir 30

That is the crontab (cron table) file, it instructs cron to run the wipe-modules ~/code_dir 30 script everyday at 11:00 am.

Edit the cron-file to match your own needs, see how to set up a crontab for more info.

Now set the cron-file crontab file in cron using:

$ crontab ~/path_to_cronfile/cron-file

And you’re done!

To check if you’ve successfully added your crontab type:

$ crontab -l

It should display your crontab.

To edit a crontab, use crontab -e and to delete all crontabs use crontab -r.

Note that crontab -r will destroy all your crontabs, that’s why it’s a good idea to keep your crontab commands in a cron-file.

Cron is only supported in unix operating systems.

License

MIT © Enrique Benitez

tldr bash client

2017-02-06T00:00:00+00:00

A fully-functional bash client for the tldr project, providing poignant examples of terminal commands.

Version: 0.3

Installation

Download the tldr bash script to the install location:

location=/usr/local/bin/tldr  # elevated privileges needed for some locations
sudo wget -qO $location https://raw.githubusercontent.com/pepa65/tldr-bash-client/master/tldr
sudo chmod +x $location

If the location is not in $PATH, you need to specify the path to run it. Alternately, you can do sudo bpkg-install pepa65/tldr if you have bpkg installed.

Prerequisites

coreutils, less, grep, unzip, curl / wget

Usage

 USAGE: tldr [option] [platform/]command

 [platform/]command:          Show page for command (from platform)

 platform is optionally one of: common, linux, osx, sunos

 option is optionally one of:
  -l, --list [platform]:      Show all available pages (from platform)
  -r, --render file:          Render a local file as tldr markdown
  -m, --markdown command:     Show the markdown source for command
  -c, --cache:                Cache all pages by downloading archive from repo
  -u, --update:               Re-download index file from repo
  -v, --version:              Version number and repo location
  [-h, -?, --help]:           This help overview

 All pages and the index are cached locally under $HOME/.local/share/tldr
 By default, the cached copies will be freshly downloaded after 60 days.

Customization

The 5 elements in TLDR markup that can be styled with these colors and backgrounds (last one specified will be used) and modes (more can apply):

Colors: Black, Red, Green, Yellow, Blue, Magenta, Cyan, White
BG: BlackBG, RedBG, GreenBG, YellowBG, BlueBG, MagentaBG, CyanBG, WhiteBG
Modes: Bold, Underline, Italic, Inverse

Newline can be added to the style list to add a newline before the element and Space to add a space at the start of the line (style items are separated by space, lower/uppercase mixed allowed)

TLDR_TITLE_STYLE (defaults to: Newline Space Bold Yellow)
TLDR_DESCRIPTION_STYLE (defaults to: Space Yellow)
TLDR_EXAMPLE_STYLE (defaults to: Newline Space Bold Green)
TLDR_CODE_STYLE (defaults to: Space Bold Blue)
TLDR_VALUE_ISTYLE (defaults to: Space Bold Cyan)

The Value style (above) is an Inline style: doesn’t take Newline or Space

Inline styles for help text: default, URL, option, platform, command, header

TLDR_DEFAULT_ISTYLE (defaults to: White)
TLDR_URL_ISTYLE (defaults to: Yellow)
TLDR_HEADER_ISTYLE (defaults to: Bold)
TLDR_OPTION_ISTYLE (defaults to: Bold Yellow)
TLDR_PLATFORM_ISTYLE (defaults to: Bold Blue)
TLDR_COMMAND_ISTYLE (defaults to: Bold Cyan)
TLDR_FILE_ISTYLE (defaults to: Bold Magenta)

Color/BG (Newline and Space also allowed) for error and info messages

TLDR_ERROR_COLOR (defaults to: Newline Space Red)
TLDR_INFO_COLOR (defaults to: Newline Space Green)

How many days before freshly downloading a potentially stale page

TLDR_EXPIRY (defaults to: 60)

Alternative location of pages cache

TLDR_CACHE (not set by default)

Contributing

Please file an issue for a question, a bug or a feature request. Or even better, send a pull request!

License

Original client by Ray Lee http://github.com/raylee/tldr (MIT license)

Relicensed under GPLv3+

osxbootstrap

2016-09-12T00:00:00+00:00

hr

2016-07-04T00:00:00+00:00

Tired of not finding things in your terminal because there’s a lot of logs and garbage? Tired of destroying the Enter key by creating a “void zone” in your terminal so that you can see the error that you’re trying to debug?

Use the old <hr /> tag, but in your terminal.

shpec

2015-05-05T00:00:00+00:00

This package provides a command for testing your shell scripts.

Using shpec

shpec’s repo itself is using shpec, so feel free to use it as an example.

Here is the basic structure that you’ll want:

└── shpec
    └── an_example_shpec.sh
    └── another_shpec.sh

Then to run your tests:

shpec [shpec_files]

If you’d like your tests to run automatically when they change, we recommend the entr utility:

find . -name "*_shpec.sh" | entr shpec

Examples

shpec’s own tests are a great place to start. For more examples, see the wiki page

Matchers

The general format is:

assert matcher arguments

where matcher is one of the following:

Binary Matchers

equal         # equality
unequal       # inequality
gt            # algebraic '>'
lt            # algebraic '<'
match         # regex match
no_match      # lack of regex match

Unary Matchers

present       # string presence
blank         # string absence
file_present  # file presence
file_absent   # file absence
symlink       # tests a symlink's target
test          # evaluates a test string

Custom Matchers

Custom matchers are loaded from shpec/matchers/*.sh.

For example, here’s how you’d create a still_alive matcher:

# in shpec/matchers/network.sh
still_alive() {
  ping -oc1 "$1" > /dev/null 2>&1
  assert equal "$?" 0
}

Then you can use that matcher like any other:

# in shpec/network_shpec.sh
describe "my server"
  it "serves responses"
    assert still_alive "my-site.com"
  end
end

Installation

You can either install with bpkg

$ bpkg install rylnd/shpec

or with curl

sh -c "`curl -L https://raw.github.com/rylnd/shpec/master/install.sh`"

or with antigen for zsh by putting antigen bundle rylnd/shpec in your .zshrc

clock

2015-04-19T00:00:00+00:00

Install

Available as a bpkg

bpkg install [-g] lordvlad/clock

Usage

clock <command> [<task>] [<options>]

Commands

clock help show the help
clock in clock in, will clock out any running task
clock out clock out
clock log show all log entries, or log entries for <task>
clock list show sums for all tasks

Task

If no task is specified, the current working directory will be used as task identifier

Options

-m|--message record additional message when clocking in/out
-f|--file where to save the clocks, defaults to $HOME/.clocks
--by-task sort log entries by task for clock log
--gt=DATE with clock log, show only entries after DATE, with clock list sum up only entries after DATE. DATE can be any string that unix’ date understands
--lt=DATE with clock log, show only entries before DATE, with clock list sum up only entries before DATE. DATE can be any string that unix’ date understands

Examples

$ mkdir -p tasks/{work,sleep}
$ clock in tasks/work
> clocked in /home/lordvlad/tasks/work
$ clock in tasks/sleep
> clocked out /home/lordvlad/tasks/work
> clocked in /home/lordvlad/tasks/sleep
$ clock out
> clocked out /home/lordvlad/tasks/sleep
$ clock log
> Tue 21 Apr 2015 06:31:24 PM UTC 00:01:23        /home/lordvlad/tasks/work
> Tue 21 Apr 2015 06:32:47 PM UTC 00:00:04        /home/lordvlad/tasks/sleep
$ clock list
> 00:00:04        /home/lordvlad/tasks/sleep
> 00:01:23        /home/lordvlad/tasks/work

is.sh

2015-04-14T00:00:00+00:00

is.sh allows you to write conditions which can be read by average human being.

Usage

var=123

if is equal $var 123.0; then
    echo "it just works"
fi

if is not a substring $var "foobar"; then
    echo "and it's easy to read"
fi

Available conditions

is equal <valueA> <valueB> - checks if values are the same or if they are equal numbers
is matching <value> <regexp> - checks if whole value matches to regular expression
is substring <value> <string> - checks if first value is a part of second one
is empty <value> - checks if value is empty
is number <value> - checks if value is a number
is gt <numberA> <numberB> - true if first number is greater than second one
is lt <numberA> <numberB> - true if first number is less than second one
is ge <numberA> <numberB> - true if first number is greater than or equal to second one
is le <numberA> <numberB> - true if first number is less than or equal to second one
is file <path> - checks if it is a file
is dir <path> - checks if it is a directory
is link <path> - checks if it is a symbolic link
is existent <path> - checks if there is a file or directory or anything else with this path
is readable <path> - checks if file is readable
is writeable <path> - checks if file is writeable
is executable <path> - checks if file is executable
is older <pathA> <pathB> - checks if first file is older than second one
is newer <pathA> <pathB> - checks if first file is newer than second one
is true <value> - true if value is equal “true” or “0”
is false <value> - oposite of is true <value>

Negations

You can negate any condition by putting not in front of it:

$ is a number "abc" && echo "number"
$ is not a number "abc" && echo "not a number"
not a number

node-reinstall

2015-03-04T00:00:00+00:00

This package re-installs Node.js and NPM using NVM or Nave.

Usage

node-reinstall can typically be run as-is, though you can specify several arguments to customize to your liking.

$ node-reinstall -h
node-reinstall
        completely re-installs Node & NPM and any global node modules.
        It re-installs Node using NVM or Nave

Usage:  node-reinstall [--nave|--nvm|--nvm-latest] [-h|--help] [-v|--version] [NODE_VERSION]

Commands:

        node-reinstall                  re-install node and npm using nvm
        node-reinstall [-h|--help]      show help
        node-reinstall [-v|--version]   show the node-reinstall version number
        node-reinstall [-f|--force]     installs defaults without user confirmation
        node-reinstall --nave           re-install using nave
        node-reinstall --nvm            re-install using stable nvm - the default
        node-reinstall --nvm-latest     re-install using latest nvm - creationix/nvm:master
        node-reinstall 0.12             specify a default node version - currently

gdub

2014-10-20T00:00:00+00:00

gdub (gw on the command line) is a gradle / gradlew wrapper. Not to be confused with the Gradle Wrapper, gw uses the Gradle Wrapper on projects where one is configured, and falls back to use the gradle from the $PATH if a wrapper is not available. Also, gw is 66% shorter to type than gradle and 78% shorter to type than ./gradlew. That’s science.

Anywhere you happen to be on your project, you can run the Gradle tasks of your project by typing gw <tasks>, regardless of whether you use the Gradle Wrapper in your project or not.

gw works by looking upwards from your current directory and will run the nearest build.Gradle file with the nearest gradlew. If a gradlew cannot be found, it will run the nearest build.Gradle with your system’s Gradle. This is probably always what you want to do if you are running Gradle from within a project tree that uses the Gradle build system.

bashsh

2014-10-01T00:00:00+00:00

Improves your Bash scripts.

Usage

The following shebang

#!/usr/bin/env bashsh-0

gives you:

set -e by default:

$ echo hello ; false ; echo world

will only print hello.

CMD for showing executed commands in bold on stderr:

$ CMD git status

CMD_STR prints the string in bold on stderr and runs it with eval:

$ CMD_STR 'gitk --all &'

MSG prints a remark in bold on stderr, formatted as a comment:

$ MSG hello world

prints # hello world.

READ_P works like read -p but prints the first parameter using MSG:

$ READ_P 'What is your name? ' your_name

QUOTED prints the given arguments in a way that is safe to pass to commands:

$ echo "My arguments are: $(QUOTED "$@")"

You can find a few examples in the examples directory.

Caveats / known limitations

You cannot just

bpkg install bashsh

to install bashsh locally (it is forced to install globally anyway), because if you use

#!/usr/bin/env ./relative/path/to/bashsh-0

the path of the command supplied to env will be interpreted as relative to the working directory, not to the script’s directory.

markdown

2014-06-17T00:00:00+00:00

markdown.bash is a Markdown interpreter using only traditional Unix tools. Specifically, it only uses bash, sed, grep, and cut (in one small instance).

$ bpkg install markdown.bash

Usage

Use it just like any other Unix program - by either passing files to it or piping input into it.

# Converts `test.md` to HTML and sends to
# standard output
markdown.sh samples/test.md

# Concatenates all the files and converts
# them all from Markdown to HTML into `output.html`
markdown.sh file1 file2 file3 > output.html

# Also accepts Markdown piped into it
echo "# heading1\n\nparagraph" | markdown.sh

wifi

2014-06-16T00:00:00+00:00

This package provides convenient commands to manage your wifi networks.

$ bpkg install -g wifi

Usage

Some commands require root privileges to access wifi info.

# List currently available wifi networks.
sudo wifi.sh scan

# Connect to best network
sudo wifi.sh connect

# Add a network to file.
sudo wifi.sh add <SSID> <passphrase>

# Show current interface
wifi.sh interface

# this defaults to the LAST interface
# it finds, for me, this is the most recent USB wifi
# dongle I plugged in.

# Set interface manually like this:
sudo INTERFACE=wlan0 wifi.sh connect

# Set wpa_supplicant.conf location
sudo WPA_CONF=/etc/wpa_supplicant.conf wifi.sh connect

umq

2014-06-16T00:00:00+00:00

This package makes easy to handle TCP requests on the command-line.

You can both send and receive messages with the portability only Bash can offer.

$ bpkg install umq -g

Usage

umq is quite a toolbox - there are several ways you can use it.

Let’s take a server, for example. The following will create a server and listen on localhost port 3000 for all incoming TCP messages.

$ umq recv 3000 | { \
  while read -r line; do \
    echo "got: '$line'"; \
  done; \
}

You can connect and read from the server by using umq itself:

$ umq recv localhost 3000

Pushing data is just as easy:

$ echo "ping" | umq push localhost 3000

# It should yield the following response
# on the umq server:
got: 'ping'

umq’s API

usage: umq <command> [-hV]

examples:
$ echo "hello world" | umq push localhost 3000
$ umq recv localhost 3000 | while read line; do \
  echo "msg: $line"; done

commands:
  push <host> <port>      push message to host with port
  recv <host> <port>      receive message on host with port
  help <command>          see more information on a command

options:
  -h, --help              display this message
  -V, --version           output version

Real-life Examples

CPU Histogram

Using umq with the histo viewer allows for data to be streamed via TCP to a histogram chart. See cpu-stream for a preview.

`wall` server

Streaming messages to all users via the wall program. See wall-server.

rtail

2014-06-16T00:00:00+00:00

Sometimes you just want to quickly access the final contents of a file on a remote SSH host. Well, now you can do it.

$ bpkg install -g rtail

Usage

# The following will open `/var/log/host.log` on
# on `somehost.com` as if it was on our machine
$ rtail user@somehost.com -f /var/log/host.log

# All options
$ rtail --help
rtail [-hvV] [ssh_options] [user@] [tail_options] [files...]
-v, --verbose   enable verbose output
-h, --help      display this message
-V, --version   output version

[ssh_options]   ssh options
[tail_options]  tail options

recho

2014-06-16T00:00:00+00:00

This package makes easy to send quick strings across SSH hosts.

$ bpkg install -g recho

Usage

# The following will create a file `/var/log/dump`
# on `somehost.com` under `user` with the content `beep`
$ recho user@somehost.com beep > /var/log/dump

# All options
$ recho --help
recho [-hvV] [ssh_options] [user@] [echo_options] [string]
-v, --verbose   enable verbose output
-h, --help      display this message
-V, --version   output version

[ssh_options]   ssh options
[echo_options]  echo options

osx-screencast

2014-06-16T00:00:00+00:00

Easily create a screencast on OS X in a few commands. Inspired from this gist.

$ bpkg install -g osx-screencast

Usage

For an animated example visit the GitHub page on the links below.

The osx-screencast-record command basically just opens up an application with open -a defaulting to Quicktime Player as the application that gets opened. The -a or --application can be used to override this values.

Record

$ osx-screencast record
Opening `Quicktime Player'...

Record your screen in the application you’ve chosen and save the file. You will need to know the path to the file you’ve saved because it will be the source of the osx-screencast-export command.

Export

The osx-screencast-export command wraps the use of ffmpeg and convert with default arguments. You can define the output fps for a video with the -f or --fps option. The default is 10. The delay between each frame in the output can be defined in milliseconds with the -d or --delay option. The default is 5. The output scale can be defined with the -s or --scale option. The default is 320:-1. See this link for more information on ffmpeg scaling.

$ osx-screencast export screencast.mov screencast.gif -s '720:-1'
Transcoding frames...
Converting and writing to destination...
Ok! (screencast.mov => screencast.gif)

api

osx-screencast

usage: osx-screenshot [-hV]
or: osx-screenshot record [-h] [-a application]
or: osx-screenshot export [-h] [-f fps] [-s scale] [-d delay] <src> <dest>

record

usage: osx-screenshot-record [-h]
or: osx-screenshot-record [-a application]

options:
-a,--application     Set screen recording application  (Default: 'Quicktime Player')
-h,--help            Show this message

export

usage: osx-screenshot-export [-h]
or: osx-screenshot-export [-f fps] [-s scale] [-d delay] <src> <dest>

options:
-f,--fps        Frames per second (Default: 10)
-s,--scale      Output scaling (Default: 320:-1)
-d,--delay      Frame delay
-h,--help       Show this message

nman

2014-06-16T00:00:00+00:00

This package adds the convenience of man pages to the node.js API.

$ bpkg install nman -g

Usage

Just use nman along with the node API you’d like to view. Some examples:

# For the File System module
$ nman fs

# ...and the console
$ nman console

# The name is the same as you'd `require` it
# For the "Assertion Testing", just like you
# would `require(assert)`, do...
$ nman assert

NOTE: It requires an active internet connection. It does not come with the docs nor stores offline as they are requested.

json.sh

2014-06-16T00:00:00+00:00

yo, so it’s a json parser written in bash

Pipe json to it, and it traverses the json objects and prints out the path to the current object (as a JSON array) and then the object, without whitespace.

$ bpkg install -g json.sh

Usage

$ json_parse < package.json
["name"]  "JSON.sh"
["version"]  "0.0.0"
["description"]  ""
["homepage"]  "http://github.com/dominictarr/JSON.sh"
["repository","type"]  "git"
["repository","url"]  "https://github.com/dominictarr/JSON.sh.git"
["repository"]  {"type":"git","url":"https://github.com/dominictarr/JSON.sh.git"}
["bin","json_parse"]  "./JSON.sh"
["bin"]  {"json_parse":"./JSON.sh"}
["dependencies"]  {}
#  ... etc

# Here's a more complex example:
#... try it and see
curl registry.npmjs.org/express | ./JSON.sh | egrep '\["versions","[^"]*"\]'

Options

-b Brief output. Combines ‘Leaf only’ and ‘Prune empty’ options.
-l Leaf only. Only show leaf nodes, which stops data duplication.
-p Prune empty. Exclude fields with empty values.
-h Show help text.

dots

2014-06-16T00:00:00+00:00

The goal of dots is to automate the process of getting your operating system from a stock build to a fully functional machine.

dots should be the first thing you download and run to get your computer set up. Dots differs from dotfiles, beacause dots installs and configures applications as well as builds your profile.

$ bpkg install dots

Supported Operating systems:

Mac OS X

The OSX build does the following:

install homebrew
installs binaries (graphicsmagick, python, sshfs, ack, git, etc.)
sets OSX defaults
installs applications via homebrew-cask (one-password, sublime-text, virtualbox, nv-alt, iterm2, etc.)
sets up the ~/.bash_profile

Ubuntu (server)

The Ubuntu build does the following:

dash => bash
creates a user
installs git and curl
sets up the ssh keys
configures fail2ban
sets up the firewall
installs docker

Usage

Usage: dots [options] [command] [args ...]

Options:

-v, --version Get the version
-h, --help This message

Commands:

reload        Reload the dotfiles
boot <os>     Bootstrap the given operating system
update        Update dots

dbu

2014-06-16T00:00:00+00:00

dbu (Dropbox Uploader) is a BASH script which can be used to upload, download, list or delete files from Dropbox, an online file sharing, synchronization and backup service.

It’s written in BASH scripting language and only needs cURL.

Why use this script?

Portable: It’s written in BASH scripting and only needs cURL (curl is a tool to transfer data from or to a server, available for all operating systems and installed by default in many linux distributions).
Secure: It’s not required to provide your username/password to this script, because it uses the official Dropbox API for the authentication process.

Please refer to the Wiki for tips and additional information about this project. The Wiki is also the place where you can share your scripts and examples related to Dropbox Uploader.

$ bpkg install -g dbu

Usage

The dbu package comes with two executables - dropbox_uploader.sh and dropShell.sh.

Dropbox Uploader

This script receives commands, pretty much like git. The syntax is quite simple:

dropbox_uploader.sh COMMAND [PARAMETERS]...

[%%]: Optional param
<%%>: Required param

Available commands

upload <LOCAL_FILE/DIR …> <REMOTE_FILE/DIR> Upload a local file or directory to a remote Dropbox folder. If the file is bigger than 150Mb the file is uploaded using small chunks (default 4Mb); in this case a . (dot) is printed for every chunk successfully uploaded and a * (star) if an error occurs (the upload is retried for a maximum of three times). Only if the file is smaller than 150Mb, the standard upload API is used, and if the -p option is used the default curl progress bar is displayed during the upload process. The local file/dir parameter supports wildcards expansion.
download <REMOTE_FILE/DIR> [LOCAL_FILE/DIR] Download file or directory from Dropbox to a local folder
delete <REMOTE_FILE/DIR> Remove a remote file or directory from Dropbox
move <REMOTE_FILE/DIR> <REMOTE_FILE/DIR> Move or rename a remote file or directory
copy <REMOTE_FILE/DIR> <REMOTE_FILE/DIR> Copy a remote file or directory
mkdir Create a remote directory on DropBox
list [REMOTE_DIR] List the contents of the remote Dropbox folder
share Get a public share link for the specified file or directory
info Print some info about your Dropbox account
unlink Unlink the script from your Dropbox account

Optional parameters

**-f ** Load the configuration file from a specific file
-s Skip already existing files when download/upload. Default: Overwrite
-d Enable DEBUG mode
-q Quiet mode. Don’t show progress meter or messages
-p Show cURL progress meter
-k Doesn’t check for SSL certificates (insecure)

Examples

dropbox_uploader.sh upload /etc/passwd /myfiles/passwd.old
dropbox_uploader.sh upload *.zip /
dropbox_uploader.sh download /backup.zip
dropbox_uploader.sh delete /backup.zip
dropbox_uploader.sh mkdir /myDir/
dropbox_uploader.sh upload "My File.txt" "My File 2.txt"
dropbox_uploader.sh share "My File.txt"
dropbox_uploader.sh list

DropShell

DropShell is an interactive DropBox shell, based on DropBox Uploader:

# Launching the DropShell...
$ dropShell.sh
DropShell v0.2
The Intractive Dropbox SHELL
Andrea Fabrizi - andrea.fabrizi@gmail.com

Type help for the list of the available commands.

andrea@Dropbox:/$ ls
[D] 0       Apps
[D] 0       Camera Uploads
[D] 0       Public
[D] 0       scripts
[D] 0       Security
[F] 105843  notes.txt
andrea@DropBox:/ServerBackup$ get notes.txt

clip

2014-06-16T00:00:00+00:00

Really simple clipboard manager in Bash. You can access it via command-line or inside shell scripts.

$ bpkg install -g clip

Usage

Store: only stores single value:

$ echo foo | clip

Read: read stored value:

$ clip

NOTE: It does not interface with the actual system clipboard. It has it’s own.

github

2014-06-15T00:00:00+00:00

This package allows you to perform GitHub actions on your shell scripts.

$ bpkg install github

Usage

This is how you’d use it via command-line. Note that to use some commands you need to authenticate first.

# Authentication
$ github auth jwerle
Enter host password for user 'jwerle':
  info: Storing access token

# Read token:
$ github token get
cf02301afdsfsbff6b06fdsfsbad2c225fdsfdsf

# Request feeds with authenticated user:
$ github request GET /feeds
{
  "timeline_url": "https://github.com/timeline",
  "user_url": "https://github.com/{user}",
  "current_user_public_url": "https://github.com/jwerle",
  "_links": {
    "timeline": {
      "href": "https://github.com/timeline",
      "type": "application/atom+xml"
    },
    "user": {
      "href": "https://github.com/{user}",
      "type": "application/atom+xml"
    },
    "current_user_public": {
      "href": "https://github.com/jwerle",
      "type": "application/atom+xml"
    }
  }
}

To see an example of a shell script and more info, go to the GitHub repository below.

term

2014-06-01T00:00:00+00:00

This package allows you to manipulate colors, cursor position and make animations on the terminal.

$ bpkg install -g term

Usage

term works by accepting commands, just like git.

# It's supposed to output green-ish underlined text
$ { term color green; } && { term underline; } && { echo heyaaaa; }
heyaaaa

term’s API

usage: term [-hV] <command> [args]

commands:

write <code>           Write a terminal escape code
cursor <op>            Perform operation to cursor
color <color>          Set terminal color by name (See colors)
background <color>     Set terminal background by name (See colors)
move <x> <y>           Move to (x, y)
transition <x> <y>     Transition to (x, y)
clear <section>        Clear terminal section by name (See sections)
reset                  Reset the terminal escape code sequence
bright                 Write bright escape code
dim                    Write dim escape code
underline              Write underline escape code
blink                  Write blink escape code
reverse                Write reverse escape code
hidden                 Write hidden escape code

colors:

black                  $ term color black
red                    $ term color red
green                  $ term color green
yellow                 $ term color yellow
blue                   $ term color blue
magenta                $ term color magenta
cyan                   $ term color cyan
white                  $ term color white
gray|grey              $ term color gray

sections:

start                  Start of line
end                    End of line
up                     Upper section
down                   Lower section
line                   Current line
screen                 Entire screen

bpkg

kewt

Links

bdo-cli

Usage

Links

parse_quick_parameters.sh

Installation

Use bkpg

Use git-remote-get

Usage

Notes

Alternatives

Contributing

Credits

drawercli

Usage

Links

shellshoccar-jpn-tukubai

Some commands

Links

Author

Licenses

bash-db

bash-db

Install

bpkg (global package)

Make (/usr/local/bin)

Manual Installation

Usage

Command-line Tool

PUT

Example:

GET

Example:

LIST

Example:

LAST

Example:

DELETE

Example:

Links

bash-templater

TL;DR

USE ME

The only rule

INSTALL ME

Links

echo-eval

Installation

Usage

Links

bashunit

Usage

Links

protobuf-parser-bash

Install

Links

records.sh

Usage

Links

bash-util-lib

Install

Usage

Links

Bats

Usage

Links

magic-version

Usage

Links

chap

Installation

Requirements

Usage

Example

Links

passmenu

Usage

Links