Manual Pages  — CLI.LUA

Before hooking into the functionality provided by cli.lua, it must be included with a statement such as the following:

    local cli = require("cli")

For instance:

local cli = require("cli")

cli.foo = function(...)
        -- Expand args to command name and the rest of argv.  These arguments
        -- are pushed directly to the stack by loader, then handed off to
        -- cli_execute.  cli_execute then passes them on to the invoked
        -- function, where they appear as varargs that must be peeled apart into
        -- their respective components.
        local _, argv = cli.arguments(...)

        print("This is the foo command!")
        for k, v in ipairs(argv) do
                print("arg #" .. tostring(k) .. ": '" .. v .. "'")
        end
        -- Perform a loader command directly.  This will not get dispatched back
        -- to Lua, so it is acceptable to have a function of the exact same name
        -- in loader.  Lua will have the first chance to handle any commands
        -- executed at the loader prompt.
        loader.perform("foo")
end

This function may be invoked by a user at the loader prompt by simply typing foo. Arguments may be passed to it as usual, space-delimited.