Skip to content

docs(DEVELOPER.md): added standalone Lua script execution guide #14848

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rhighs wants to merge 1 commit into
base: master
Choose a base branch
from
+30 −0
Open

docs(DEVELOPER.md): added standalone Lua script execution guide #14848

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions DEVELOPER.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,36 @@ kong stop
deactivate
```

### Running Standalone Lua Scripts

Activate the venv before using any of the commands below.

#### `resty` - for scripts using OpenResty APIs (`ngx.*`, cosocket, `cjson`, `resty.*`)

```bash
source bazel-bin/build/kong-dev-venv.sh
resty my_script.lua
```

Scripts can use a shebang (`#!/usr/bin/env resty`). See `scripts/changelog-helper.lua` for an example.

#### `kong runner` - for scripts that need `kong.db`, `kong.configuration`, or the PDK

CLI arguments are available as a global `args` table (`args[1]` is the script filename).

```bash
kong runner my_script.lua arg1 arg2
```

#### `luajit` - for pure Lua scripts with no nginx/OpenResty APIs

```bash
source bazel-bin/build/kong-dev-venv.sh
luajit my_script.lua
```

---

### Install Development Dependencies

#### Running for development
Expand Down
Loading