shellescape

package

v0.7.0 Latest Latest Go to latest Published: Jun 26, 2025 License: BSD-3-Clause Imports: 2 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/vadv/gopher-lua-libs

Links

Open Source Insights

README ¶

shellescape

Usage

local shellescape = require("shellescape")

escaped = shellescape.quote("foo bar baz")
-- 'foo bar baz'

escaped_command = shellescape.quote_command({ "echo", "foo bar baz" })
-- echo 'foo bar baz'

Documentation ¶

Examples ¶

Quote
QuoteCommand
StripUnsafe

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Loader ¶

func Loader(L *lua.LState) int

Loader is the module loader function.

func Preload ¶

func Preload(L *lua.LState)

Preload adds json to the given Lua state's package.preload table. After it has been preloaded, it can be loaded using require:

local json = require("json")

func Quote ¶

func Quote(L *lua.LState) int

Example ¶

L := lua.NewState()
Preload(L)
source := `
local shellescape = require("shellescape")
print(shellescape.quote("foo"))
`
if err := L.DoString(source); err != nil {
	log.Fatal(err)
}

Output:
foo

func QuoteCommand ¶

func QuoteCommand(L *lua.LState) int

Example ¶

L := lua.NewState()
Preload(L)
source := `
local shellescape = require("shellescape")
print(shellescape.quote_command({"echo", "foo bar baz"}))
`
if err := L.DoString(source); err != nil {
	log.Fatal(err)
}

Output:
echo 'foo bar baz'

func StripUnsafe ¶

func StripUnsafe(L *lua.LState) int

Example ¶

L := lua.NewState()
Preload(L)
source := `
local shellescape = require("shellescape")
print(shellescape.strip_unsafe("foo\nbar"))
`
if err := L.DoString(source); err != nil {
	log.Fatal(err)
}

Output:
foobar

Types ¶

This section is empty.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL