aboutsummaryrefslogtreecommitdiff
path: root/docs/luarocks_list.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/luarocks_list.md')
-rw-r--r--docs/luarocks_list.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/luarocks_list.md b/docs/luarocks_list.md
new file mode 100644
index 00000000..b9627d5f
--- /dev/null
+++ b/docs/luarocks_list.md
@@ -0,0 +1,27 @@
1# luarocks list
2
3Lists currently installed rocks.
4
5## Usage
6
7`luarocks list [--outdated] [--porcelain] [<query>] [<version>]`
8
9`<query>` is a substring of a rock name to filter by. When no arguments are
10supplied, a list of all rocks you have installed is returned.
11
12If `--outdated` is passed, only rocks for which there is a higher version
13available in the rocks server are listed.
14
15If `--porcelain` is passed, machine-friendly output is produced.
16
17The `list` command queries the local repository (the rocks you have
18installed). To query remote repositories (the rocks available for download at
19the LuaRocks server), use [luarocks search](luarocks_search.md).
20
21## Example
22
23List all installed rocks:
24
25```
26luarocks list
27```