Manual Pages  — CLI.LUA

cli.lua – FreeBSD Lua CLI module

DESCRIPTION Adding new commands Default Commands Exported Functions SEE ALSO AUTHORS

cli.lua contains the main functionality required to add new CLI commands, which can be executed at the loader prompt.

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

    local cli = require("cli")

New loader commands may be created by adding functions to the object returned by requiring the cli.lua module.

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.

The following functions are exported from cli.lua:

cli.arguments(...)
	Takes varargs passed on the stack from loader(8) to cli_execute, splits them out into two return values: the command name, traditionally argv[0], and the rest of argv.

The cli.lua file was originally written by Kyle Evans <Mt kevans@FreeBSD.org>.