aboutsummaryrefslogtreecommitdiff
path: root/docs/luarocks_search.md
blob: 70cea427c931e67653c61cb183a70dbe367c325f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# luarocks search

Query the LuaRocks servers.

## Usage

`luarocks search [--porcelain] [--source] [--binary] { <query> [<version>] | --all }`

Lists files available on LuaRocks servers. `<query>` is a substring of a rock
name to filter by. The search can be narrowed further narrowed down using a
version. To list files for all rocks pass `--all`.

If `--porcelain` is passed, machine-friendly output is produced.

If `--source` is passed, only rockspecs and source rocks are shown.

If `--binary` is passed, only binary and pure-Lua rocks are shown.

Rocks not supporting version of Lua used by LuaRocks are not listed.

The `luarocks search` command queries remote repositories.
To query your local repository (the rocks you have installed), use [luarocks list](luarocks_list.md).

## Example

```
luarocks search socket
```