diff options
Diffstat (limited to '')
-rw-r--r-- | docs/luarocks_upload.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/luarocks_upload.md b/docs/luarocks_upload.md new file mode 100644 index 00000000..167ec803 --- /dev/null +++ b/docs/luarocks_upload.md | |||
@@ -0,0 +1,26 @@ | |||
1 | # luarocks upload | ||
2 | |||
3 | Upload a rockspec to the public rocks repository. | ||
4 | |||
5 | ## Usage | ||
6 | |||
7 | `luarocks upload [--skip-pack] [--api-key=<key>] [--force] <rockspec>` | ||
8 | |||
9 | Packs a source rock file (`.src.rock`) using a rockspec and uploads it | ||
10 | and the rockspec to the public rocks repository. | ||
11 | |||
12 | To access the server, an API key is required. It is passed using `--api-key` | ||
13 | option and can be issued at the [LuaRocks site](https://luarocks.org/) on | ||
14 | the "Setting" page after logging in. | ||
15 | |||
16 | If `--skip-pack` is passed, the source rock is not packed and only the rockspec | ||
17 | is uploaded. | ||
18 | |||
19 | If `--force` is passed, existing files will be overwritten if the same version | ||
20 | of the package already exists. | ||
21 | |||
22 | ## Example | ||
23 | |||
24 | ``` | ||
25 | luarocks upload my-rock-0.1.0-1.rockspec --api-key=<REDACTED> | ||
26 | ``` | ||