LuaRocks Wiki: luarocks

Anonymous users must enter captcha below.

Don't put anything here

Page Parameters

Page Name (for URL)

Page Title

Show Advanced Options

Page Content

Don't put anything here

'''luarocks''' is the command-line interface for LuaRocks, a module deployment system for Lua.

== Usage ==

:'''luarocks <nowiki>[</nowiki>--server=''server'' | --only-server=''server''<nowiki>]</nowiki> <nowiki>[</nowiki>--tree=''tree''<nowiki>]</nowiki> <nowiki>[</nowiki>--only-sources=''url''<nowiki>]</nowiki> <nowiki>[</nowiki>''VAR''=''VALUE''<nowiki>]</nowiki>... ''command'' <nowiki>[</nowiki>''argument''<nowiki>]</nowiki>'''

Variables from the "variables" table of the [[Config file format|configuration file]] can be overriden with VAR=VALUE assignments.

{| cellspacing=0px cellpadding=10px border=1px bordercolor=black align=center
| --server=''server'' || Fetch rocks/rockspecs from this server (takes priority over config file)
|-
| --only-server=''server'' || Fetch rocks/rockspecs from this server only (overrides any entries in the config file)
|-
| --only-sources=''url'' || Restrict downloads of sources to URLs starting with the given URL. For example, --only-sources=http://luarocks.org will allow LuaRocks to download sources only if the URL given in the rockspec starts with http://luarocks.org . 
|-
| --tree=''tree'' || Which tree to operate on.
|}

== Supported commands ==

{| cellspacing=0px cellpadding=10px border=1px bordercolor=black align=center
| [[build]]   || Build/compile and install a rock.
|-
| [[download]]|| Download a specific rock or rockspec file from a rocks server.
|-
| [[help]]    || Help on commands.
|-
| [[install]] || Install a rock.
|-
| [[list]]    || Lists currently installed rocks.
|-
| [[make]]    || Compile package in current directory using a rockspec and install it.
|-
| [[pack]]    || Create a rock, packing sources or binaries.
|-
| [[path]]    || Return the currently configured package path.
|-
| [[remove]]  || Uninstall a rock.
|-
| [[search]]  || Query the LuaRocks repositories.
|-
| [[show]]    || Shows information about an installed rock.
|-
| [[unpack]]  || Unpack the contents of a rock.
|}

== Overview of the difference between "make", "build", "install" and "pack" ==

{| cellspacing=0px cellpadding=10px border=1px bordercolor=black align=center
| luarocks install modulename || downloads a binary .rock file and installs it to the local tree (falls back to "luarocks build modulename" behavior if a binary rock is not found)
|-
| luarocks build modulename || downloads a .src.rock or a rockspec and builds+installs it to the local tree.
|-
| luarocks build modulename-1.0-1.linux-x86.rock || extracts the rockspec from the rock and builds it as if the rockspec was passed in the command-line (i.e., redownloading sources and recompiling C modules if any).
|-
| luarocks build modulename-1.0-1.rockspec || builds+installs the rock using the given rockspec downloading the sources
|-
| luarocks make modulename-1.0-1.rockspec || builds+installs the rock using the rockspec using the contents of your current directory (kind of like the way make uses a Makefile) instead of downloading sources
|-
| luarocks pack modulename || grabs the rock from your local tree and packs it into a binary .rock file
|-
| luarocks pack modulename-1.0-1.rockspec || downloads the sources from the url and packs it into a .src.rock file
|}

About this Edit

Minor Edit

Edit Summary

Don't put anything here