Skip to content

pablomayobre/obey

Repository files navigation

OBEY

GitHub release license

OBEY is a tool that helps you automate tasks in your project by providing a simple way to execute Lua functions from your terminal.

Docs

All the documentation can be found in the Wiki

This README is just a short version with minimal explanation.

Install

Install OBEY using LuaRocks!

luarocks install obey

For other ways to install OBEY check the Install section in the Wiki

Usage

Create a commands.lua file in your directory.

The file must return a table with functions.

local commands = {}

commands.example = function ()
  print "example"
end

return commands

Then you can run the functions with OBEY through the command line

obey example

> example

For more usage information check the Usage section in the Wiki

License

OBEY is licensed under the terms of the MIT License

Copyright (c) 2017 - Pablo A. Mayobre (Positive07)