oubiwann/newlisp-scripts

A collection of command line wrapers

newlisp-scripts [![Build Status][travis-badge]][travis]![GitHub tag][github-tag]![newLISP versions][newlisp-v]

A collection of command line wrapers, written in newLISP

[![][newlisp-logo]][newlisp-logo-large]

Contents

• Introduction
• Dependencies
• Build & Install
• Running
• Included Utilities
• License

Introduction ↟

This repo provides a collection of command line utilities that wrap various other command line utilities that I use, though providing a much simpler (and easier-to-remember) user experience.

So far, this repo provides the following executables:

• wifi - A wrapper for a nmcli (just the access points list and the connect command)
• bat - A wrapper for the combination of commands necessary to extract current laptop battery status
• backlight - On Linux, this wraps xbacklight; on Mac OS X, it wraps AppleScript brightness settings
• mgit - A wrapper for git for running a few commands on multiple project paths
• vol - A wrapper for amixer -D pulse to set, increment, and get the master volume

Dependencies ↟

All you need is newLISP and GNU make. You will not be able to build or run the scripts unless you have run make install in your newLISP build directory.

The scripts themselves use the following libraries which come with newLISP:

• getopts

Build & Install ↟

As long as you have newlisp installed (including its modules) and on your PATH, you may build with this command:

$ make

(or make compile) and then install with this command:

$ sudo make install

>>> WARNING <<<

Be careful with that one! If you have files in INSTALL_DIR with the same name as the binaries created with make compile, they will be overwritten.

Note if you are running on *BSD, you will need to use gmake instead of make.

Running ↟

Once installed, running the scripts is just like any other *NIX executable. All scripts support the -h (or --help) option that you can examine for their simple usage. Below are some quick examples.

bat

$ bat

Battery status:
    state:               fully-charged
    percentage:          99%

wifi

$ wifi scan

*  SSID             MODE   CHAN  RATE       SIGNAL  BARS  SECURITY
   --               Infra  2     54 Mbit/s  20      ▂___  WPA2
   ATT-WIFI-5424    Infra  6     54 Mbit/s  15      ▂___  WPA2
   Managers         Infra  11    54 Mbit/s  10      ▂___  WPA1 WPA2
   hhonors          Infra  1     54 Mbit/s  84      ▂▄▆█  --
   attwifi          Infra  11    54 Mbit/s  57      ▂▄▆_  --
   Fairfield-GUEST  Infra  11    54 Mbit/s  42      ▂▄__  --
   hhonors          Infra  6     54 Mbit/s  40      ▂▄__  --
   attwifi          Infra  1     54 Mbit/s  30      ▂___  --
   hhonors          Infra  1     54 Mbit/s  29      ▂___  --
   Fairfield-GUEST  Infra  8     54 Mbit/s  24      ▂___  --
   attwifi          Infra  11    54 Mbit/s  24      ▂___  --
   Fairfield-GUEST  Infra  11    54 Mbit/s  22      ▂___  --

$ wifi join hhonors

Connecting to SSID hhonors ...
Connection with UUID '50001b43-2b58-406a-a740-ea06d5dea584' created and activated on device 'wlan0'

backlight

$ backlight 95

94.953052

$ backlight inc

100.000000

mgit

$ mgit branch ~/lab/USGS/lcmap-*

Current branch in /home/oubiwann/lab/USGS/lcmap-client-clj ...
    * master
      topic/uberconf

Current branch in /home/oubiwann/lab/USGS/lcmap-client-docs ...
    * master

Current branch in /home/oubiwann/lab/USGS/lcmap-client-py ...
    * master
      topic/get-rod

Current branch in /home/oubiwann/lab/USGS/lcmap-config ...
    * master
      topic/uberconf

Current branch in /home/oubiwann/lab/USGS/lcmap-dockerfiles ...
    * master

Current branch in /home/oubiwann/lab/USGS/lcmap-event ...
    * master
      topic/uberconf

Current branch in /home/oubiwann/lab/USGS/lcmap-ingest-py ...
      change-to-ubid
    * master

Current branch in /home/oubiwann/lab/USGS/lcmap-logger ...
    * master

Current branch in /home/oubiwann/lab/USGS/lcmap-see ...
    * master
      topic/improve-see
      topic/uberconf

vol

$ vol

30%

$ vol mute

Audio output: off

$ vol mute

Audio output: on

$ vol inc

35%

$ vol 50

50%

$ vol dec

45%

$ vol balance

Right: 45% Left: 45%

## Included Utilities [↟](#contents)

To support the writing of the scripts and executables in this repo, additions
have been made to the source that are not included in the newLISP distribution.
In particular:

**Macros**:

* ``include/clj.lsp`` - Clojure-inspired thrushing macros: ``->``, ``->>``

**Functions**:

* ``src/argparse.lsp`` - Functions for parsing script args/options when called as a script and when called as a linked executable: ``get-script``, ``get-opts``, ``default-usage``, ``argparse``
* ``src/os.lsp`` - Functions for extracting info from the OS: ``uname``


## License [↟](#contents)

Copyright © 2016 Duncan McGreggor

Distributed under the BSD 2-Clause License.


<!-- Named page links below: /-->

[travis]: https://travis-ci.org/oubiwann/newlisp-scripts
[travis-badge]: https://travis-ci.org/oubiwann/newlisp-scripts.png?branch=master
[newlisp-logo]: resources/images/logo-white-small.png
[newlisp-logo-large]: resources/images/logo-white.png
[github-tag]: https://img.shields.io/github/tag/oubiwann/newlisp-scripts.svg?maxAge=2592000
[newlisp-v]: https://img.shields.io/badge/newlisp-10.7.0-blue.svg

newlisp-scripts's Issues

Add inc/dec command to backlight script

Adjusting the brightness in increments of 10 should be fine.

Update backlight script/executable to use includes and modules

Once #2 is done, update backlight to use it.

Update wifi script/executable to use includes and modules

Once #2 is done, update wifi to use it.

Support backlight on Mac OS X

See the following for inspiration:

• http://apple.stackexchange.com/questions/34884/how-can-i-dim-the-screen-from-terminal
• http://hints.macworld.com/article.php?story=20090901021817717
• https://macosx.com/threads/screen-brightness-through-terminal.293662/

Update readme with logo, ToC, script descriptions

Update bat script/executable to use includes and modules

Once #2 is done, update bat to use it.

Create include for Clojure-inspired macros

Even though newlisp doesn't have the concept of includes, this can be "simulated" with some Makefile hacking.

Create Makefile and targets for building/installing standalone binaries

Added Travis CI Support

At the very least, assure that scripts build and binaries run (depends upon #3).

Add command-parsing getopts supplemental code to src

Add script for wrapping git pull on multiple branches at once

In bash:

for I in lcmap-*
  do
    cd $I && git stash && git pull && cd -
  done

Create a general module for shared functions

This might go in its own repo? Dunno ...

Add warnings if scripts are executed on an unsupported platform