aboutsummaryrefslogtreecommitdiff
path: root/docs/luarocks_admin_remove.md
blob: 7a861a231bfce77c4dcdf65548d7da0e50d65570 (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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# luarocks-admin remove

Remove a rock or rockspec from a rocks server.

## Usage

`luarocks-admin remove [--server=<server>] [--no-refresh] {<rockspec>|<rock>}...`

Arguments are local files, which may be rockspecs or rocks.

The flag `--server` indicates which server to use. If not given, the default server set in the `upload_server` variable from the [configuration files](config_file_format.md) is used instead.

The flag `--no-refresh` indicates the local cache should not be refreshed prior to generation of the updated manifest.

You need to have [rsync](https://rsync.samba.org/) installed in order to use this command.

## Examples

### Basic example

Remove a rockspec from your default configured upload server:

```
luarocks-admin remove lpeg-0.9-1.rockspec
```

### Handling multiple repositories

Assuming your `~/.luarocks/config.lua` file looks like this:

```lua
upload_server = "main"
upload_servers = {
   main = {
      rsync = "www.example.com/repos/main",
   },
    dev = {
      rsync = "www.example.com/repos/devel-rocks",
   },
}
```

you can specify which repository to use with the `--server` flag:

```
luarocks-admin remove --server=dev my_rock-scm-1.rockspec
```