https://github.com/alessio/shellescape
Escape arbitrary strings for use as command line arguments
https://github.com/alessio/shellescape
command-line golang shell shell-escape shell-script shell-scripting shellescape string-escape
Last synced: 17 days ago
JSON representation
Escape arbitrary strings for use as command line arguments
- Host: GitHub
- URL: https://github.com/alessio/shellescape
- Owner: alessio
- License: mit
- Created: 2016-02-08T01:18:20.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2025-04-11T06:41:00.000Z (19 days ago)
- Last Synced: 2025-04-13T01:55:25.587Z (17 days ago)
- Topics: command-line, golang, shell, shell-escape, shell-script, shell-scripting, shellescape, string-escape
- Language: Go
- Homepage:
- Size: 99.6 KB
- Stars: 180
- Watchers: 4
- Forks: 16
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Authors: AUTHORS
Awesome Lists containing this project
- awesome-ccamel - alessio/shellescape - Escape arbitrary strings for use as command line arguments (Go)
README
# shellescape
[](https://pkg.go.dev/github.com/alessio/shellescape?tab=overview)
[](https://sourcegraph.com/github.com/alessio/shellescape)
[](https://codecov.io/gh/alessio/shellescape)
[](https://goreportcard.com/report/github.com/alessio/shellescape)
Escape arbitrary strings for safe use as command line arguments.
## Contents of the package
This package provides the `shellescape.Quote()` function that returns a
shell-escaped copy of a string. This functionality could be helpful
in those cases where it is known that the output of a Go program will
be appended to/used in the context of shell programs' command line arguments.
This work was inspired by the Python original package
[shellescape](https://pypi.python.org/pypi/shellescape).
## Usage
The following snippet shows a typical unsafe idiom:
```go
package main
import (
"fmt"
"os"
)
func main() {
fmt.Printf("ls -l %s\n", os.Args[1])
}
```
_[See in Go Playground](https://play.golang.org/p/Wj2WoUfH_d)_
Especially when creating pipeline of commands which might end up being
executed by a shell interpreter, it is particularly unsafe to not
escape arguments.
`shellescape.Quote()` comes in handy and to safely escape strings:
```go
package main
import (
"fmt"
"os"
"al.essio.dev/pkg/shellescape"
)
func main() {
fmt.Printf("ls -l %s\n", shellescape.Quote(os.Args[1]))
}
```
_[See in Go Playground](https://go.dev/play/p/GeguukpSUTk)_
## The escargs utility
__escargs__ reads lines from the standard input and prints shell-escaped versions. Unlike __xargs__, blank lines on the standard input are not discarded.