Skip to content

Latest commit

 

History

History
425 lines (357 loc) · 8.03 KB

README.md

File metadata and controls

425 lines (357 loc) · 8.03 KB
Raw

Basher Framework

______  _______ _______ _     _ _______  ______
|_____] |_____| |______ |_____| |______ |_____/
|_____] |     | ______| |     | |______ |    \_

https://www.dropbox.com/s/w43btkvfqvu548n/Basher.mov?dl=0

  • Add Zsh Plugin: ~/.oh-my-zsh/custom/includeProfileApp.zsh
  • Or, add to bash profile: ~/.profile
#!/usr/bin/env bash

# Declare Basher Framework Path
export BASHER_PATH="$HOME/basher-framework"

# shellcheck source=$BASHER_PATH/app.sh
source "$BASHER_PATH/app.sh"

Or Standalone

/usr/bin/env bash ~/basher-framework/app.sh

Application

app:boot
app:reboot
app:test

Publish Assets & Configurations

app:publish "resources/mysql.conf" "$HOME/.my.cnf"

Require scripts from the app directory.

app:require "services/service.sh"
app:require:all "services"

Build MacOS Bundle & Output to Desktop.

See: /resources/bundle/Contents/MacOS/basher

app:build

Run Commands

open ~/Desktop/Basher.app --args "os:speak 'test'"

Datetime

date:timestamp # 2019-10-28 06:00:52
date:filename  # 2019-10-28_06-01-02
date:humanized # 10/28/2019 06:01AM

Filesystem

path:is:directory $DIR
path:is:file $FILE

path:extension $FILE
path:filename $FILE
path:base $FILE
file:exists $FILE
file:is:executable $FILE
file:make:executable $FILE
file:is:writable $FILE
file:is:readable $FILE
file:is:symlink $FILE
file:not:empty $FILE
file:is:newer $FILE_A $FILE_B
file:is:older $FILE_A $FILE_B
file:equals $FILE_A $FILE_B
file:get $FILE
file:put $CONTENT $FILE
file:append $CONTENT $FILE
file:read $FILE
file:remove $FILE
file:remove:force $FILE
directory:list .
directory:files .
directory:folders .

directory:copy $DIR $DIR2
directory:force:copy $DIR $DIR2

directory:remove $DIR
directory:force:remove $DIR

directory:make $DIR
directory:change $DIR
directory:previous

directory:trim ~/Downloads 1 # Older than 1 day, with confirm
directory:trim ~/Downloads 1 true # With no confirm

directory:archive ~/Downloads /path/to/output.zip
for FILE in $(directory:files "."); do
  logger:debug "$FILE"
done
for FOLDER in $(directory:folders "."); do
  logger:debug "$FOLDER"
done

Numbers

num:is:equal 1 1
num:not:equal 1 2
num:less:than 0 1
num:greater:than 3 2
num:less:or:equal 1 2
num:greater:or:equal 3 2

Strings

str:empty ""
str:filled "not empty"
str:is:equal "my-string" "my-string"
str:not:equal "my-string" "other-string"
str:matches:regex "123" '^[0-9]+$'
str:matches:regex "asd" '^[0-9]+$'

str:replace:first $TEXT $FIND $REPLACE
str:replace:all $TEXT $FIND $REPLACE

str:length $TEXT
str:slice $TEXT 0 3

str:prefix "text-file.txt" "text-" # file.txt
str:suffix "text-file.txt" ".txt" # text-file

str:upper "test"
str:lower "TEST"

Collections

Collection state is global.

collect:make # Empty
collect:count
collect:push "Apple"
collect:push "Banana"
collect:push "Orange"
collect:all

collect:set 1 "Pizza"
collect:all

for val in $(collect:filter "Pizza"); do
  echo "Collection Has $val"
done

Functions

func:success # Last Command Succeeded
func:failed # Last Command Failed
func:inspect "my:func"
func:exists "my:func" || echo "no"
progam:exists "gitV2" || echo "no"

Processes

process:status my-script.sh
process:watch my-script.sh # start if not running
process:start my-script.sh # create my-script.sh.lock
process:stop my-script.sh # remove my-script.sh.lock
process:log my-script.sh # read my-script.sh.log
if process:running my-script.sh; then
  process:log my-script.sh 
fi

CronTab

cron:list
cron:edit

COMMAND="* * * * * /usr/bin/env bash /path/to/script.sh"

cron:install "$COMMAND"
cron:uninstall "$COMMAND"

if cron:has "$COMMAND"; then
  logger:success "cron:has script.sh"
fi

# No argument to be prompted.
cron:install:laravel "project-name" 
cron:uninstall:laravel "project-name"

Remote

remote:require "http://some.app/script.sh"
remote:ping "http://some.app"

Logger

logger:divider
logger:blank
logger:debug "Hmmm..."
logger:debug "ok..."
logger:info "ready."
logger:error "Error!"
logger:alert "Security!"
logger:failed "Failed!"
logger:denied "Darn."
logger:warning "Failing..."
logger:success "Cool!"
logger:celebrate "Awesome!"
logger:input "Where to?" "ANSWER"
logger:success "Result: $ANSWER."
if logger:confirm "Are you sure?"; then
  logger:success "Completed."
else
  logger:failed "Aborted."
fi

Colors

colors:black "im black"
colors:blackb "im blackb"
colors:white "im white"
colors:whiteb "im whiteb"

colors:red "im red"
colors:redb "im redb"
colors:green "im green"
colors:greenb "im greenb"
colors:yellow "im yellow"
colors:yellowb "im yellowb"

colors:blue "im blue"
colors:blueb "im blueb"
colors:purple "im purple"
colors:purpleb "im purpleb"
colors:lightblue "im lightblue"
colors:lightblueb "im lightblueb"

Services

Projects

make:laravel my-folder-name
make:project my-folder-name
switch:project my-folder-name

Installers

Use the current working directory.

install:animatecss
install:tailwindcss
install:vuejs

Code Quality

Use the current working directory.

php:quality # php:lint && php:test
php:lint
php:test
php:dusk

Database

make:database:env my_database
make:myconf

has:database my_database
drop:database my_database
make:database my_database

database:export my_database ~/backup.sql
database:import my_database ~/backup.sql

GIT

git:setup
git:connect
git:ignore
git:readme
git:save
git:save "custom message"
git:sync
git:reset
git:branch dev
git:branch gh-pages fresh
git:branch:delete dev
git:switch master

Supervisord

  • resources/supervisord/supervisord.conf
  • resources/supervisord/programs/*.conf
  • storage/logs/supervisord.log
supervisor:install
supervisor:control
supervisor:logs
supervisor:start
supervisor:stop
supervisor:pid

MacOS Launch Agent

supervisor:install:agent
supervisor:uninstall:agent

Chrome

No argument for 127.0.0.1

chrome:serve
chrome:serve "test.local"

PhpStorm

phpstorm:launch
phpstorm:open project-name

Operating System (MacOS)

os:speak "text"
os:notify "Title" "text"
os:confirm  "Title" "text"

Slack

slack:notify "my-channel" "Yo." "#ff0000"
slack:success "my-channel" "Something went right."
slack:warning "my-channel" "Something is strange."
slack:failed "my-channel" "Something went wrong."

Cloud Backups

rclone:install
rclone:config
rclone:config:edit
rclone:sync my-sftp-connection /home/forge /backups/forge /backups/server.log
rclone:sync:cdn my-cdn-connection my-bucket /backups/cdn /backups/cdn.log

Example backup.sh

cron:install "0 18 * * 0 ~/basher-framework/backup.sh > /dev/null 2>&1"
#!/usr/bin/env bash
# Runs Sundays @ 6:00pm
# cron:install "0 18 * * 0 ~/basher-framework/backup.sh > /dev/null 2>&1"
source /Users/builder/.profile

# App Backup
function backup:app(){
  local CONNECTION=sfprimary
  local SOURCE=/home/forge
  local DESTINATION=~/Backups/sfprimary-app
  local LOG=~/Backups/logs/app-$(date:filename).log
  rclone:sync $CONNECTION $SOURCE $DESTINATION "$LOG"
  open -a Console "$LOG"
}

# CDN Backup
function backup:cdn(){
  local CONNECTION=sfprimary-cdn
  local SOURCE=my-bucket
  local DESTINATION=~/Backups/sfprimary-cdn
  local LOG=~/Backups/logs/cdn-$(date:filename).log
  rclone:sync:cdn $CONNECTION $SOURCE $DESTINATION "$LOG"
  open -a Console "$LOG"
}
backup:app
backup:cdn