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