Module luarocks.install

Module implementing the LuaRocks "install" command. Installs binary rocks.

Functions

install_binary_rock (rock_file, no_deps) Install a binary rock.
run (..., name, version) Driver function for the "install" command.


Functions

install_binary_rock (rock_file, no_deps)
Install a binary rock.

Parameters

  • rock_file: string: local or remote filename of a rock.
  • no_deps: boolean: true if dependency check needs to be skipped

Return value:

boolean or (nil, string, [string]): True if succeeded or nil and an error message and an optional error code.
run (..., name, version)
Driver function for the "install" command.

Parameters

  • ...:
  • name: string: name of a binary rock. If an URL or pathname to a binary rock is given, fetches and installs it. If a rockspec or a source rock is given, forwards the request to the "build" command. If a package name is given, forwards the request to "search" and, if returned a result, installs the matching rock.
  • version: string: When passing a package name, a version number may also be given.

Return value:

boolean or (nil, string): True if installation was successful, nil and an error message otherwise.

Valid XHTML 1.0!