route/vendor/github.com/Xe/eclier
Cadey Ratio 8aa459b429 mage: generate assetfs 2018-01-21 22:21:32 -08:00
..
.gitignore cmd/construct: start work on eclier frontend 2018-01-21 20:28:06 -08:00
Gopkg.lock cmd/construct: start work on eclier frontend 2018-01-21 20:28:06 -08:00
Gopkg.toml cmd/construct: start work on eclier frontend 2018-01-21 20:28:06 -08:00
LICENSE cmd/construct: start work on eclier frontend 2018-01-21 20:28:06 -08:00
README.md cmd/construct: start work on eclier frontend 2018-01-21 20:28:06 -08:00
builtin.go vendor: update eclier 2018-01-21 22:08:38 -08:00
command.go cmd/construct: start work on eclier frontend 2018-01-21 20:28:06 -08:00
config.ld cmd/construct: start work on eclier frontend 2018-01-21 20:28:06 -08:00
router.go mage: generate assetfs 2018-01-21 22:21:32 -08:00
script.go cmd/construct: start work on eclier frontend 2018-01-21 20:28:06 -08:00

README.md

eclier

Pronounced like eclair

The core of a command line application allowing for trivial user extension.

Every command and subcommand is its own .lua file that is either shipped as part of the built-in cartridge of commands or a plugin that the user installs.

The core contains the following:

  • A module loading system for preparing different commands for use
  • The core subcommand router

How to write plugins

Create a new file in the script home named after the plugin subcommand, for example: scripts/hello.lua:

script.verb = "hello"
script.help = "prints everyone's favorite hello world message"
script.author = "Xe" -- put your github username here
script.version = "1.0"
script.usage = ""

function(run) 
  print "Hello, world!"
end

And then run it using the example shell cli:

~/go/src/github.com/Xe/eclier:master λ go run ./example/main.go hello
Hello, world!