Skip to content

m4chinations/shell-to-english

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

shell-to-english

converts shell to plain english

examples

require('shell-to-english')('ls -art')
//list all files, sorted oldest first by modification time in the current directory

how?

parses shell AST using https://github.com/grncdr/js-shell-parse. then further argument parsing is done by https://github.com/substack/minimist. then english generation is hard-coded with the help of https://github.com/janl/mustache.js.

see cd.js for a simple example.

tests

npm test or mocha

things will go wrong

things will go wrong - please file an issue with the full shell string that messed up the program. better yet, dive in and make a PR

About

converts shell to plain english

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published