Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 1.89 KB

README.md

File metadata and controls

46 lines (30 loc) · 1.89 KB

Overview

This script is a good template to write Erlang (escript) scripts. It's based on the original Bash3 Boilerplate. The most common things needed in a command-line script are handled and all that's needed is to fill in the actual runtime code.

Just as with Bash3 Boilerplate, the script is Delete-Key-Friendly. The one and only script, main.escript(https://github.com/WarpEngineer/escript_boilerplate/blob/master/main.escript), can be used by removing the parts you don't need. To maintain Portability, the script does not use anything fancy so it should work with any recent version of Erlang.

Features

  • Configuration by environment variables
  • Simple command-line argument parsing that requires no external dependencies. Definitions are optionally parsed from help info, ensuring there will be no duplication
  • Helpful magic variables like __file and __dir
  • Logging that supports colors and is compatible with Syslog Severity levels

Installation

All you need is the main.escript file. Use curl or wget to download the source and save it as your script. Then you can start deleting the unwanted bits, and adding your own logic.

wget https://github.com/WarpEngineer/escript_boilerplate/blob/master/main.escript
vim main.escript

Author

License

Copyright (c) 2016-2018 A. G. Madi. Licensed under APLv2.