shellquote

README

shellquote

import "github.com/frioux/shellquote"

• Overview
• Index
• Examples

Overview

shellquote quotes strings for shell scripts.

Sometimes you get strings from the internet and need to quote them for security, other times you'll need to quote your own strings because doing it by hand is just too much work.

Another option is http://github.com/kballard/go-shellquote. The quoting algorithms are completely different and the results vary as well, but both produce working results in my brief testing. See https://github.com/frioux/go-scraps/tree/master/cmd/quotetest for a tool that shows the results of quoting with each package.

Example

Code:

fmt.Println("#!/bin/sh")
fmt.Println("")
quoted, err := shellquote.Quote(os.Args[1:])
if err != nil {
    fmt.Fprintf(os.Stderr, "Couldn't quote input: %s\n", err)
    os.Exit(1)
}
// error won't happen if the first input didn't error
doublequoted, _ := shellquote.Quote([]string{quoted})
fmt.Println("ssh superserver", doublequoted)

Index

• Variables
• func Quote(in []string) (string, error)

Examples

• Package

Package files

shellquote.go

Variables

var ErrNull = errors.New("No way to quote string containing null bytes")

ErrNull will be returned from Quote if any of the strings contains a null byte.

func Quote

func Quote(in []string) (string, error)

Quote will return a shell quoted string for the passed tokens.

Copyright 2018 Arthur Axel fREW Schmidt

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Documentation

Overview

shellquote quotes strings for shell scripts.

Sometimes you get strings from the internet and need to quote them for security, other times you'll need to quote your own strings because doing it by hand is just too much work.

Another option is http://github.com/kballard/go-shellquote. The quoting algorithms are completely different and the results vary as well, but both produce working results in my brief testing. See https://github.com/frioux/go-scraps/tree/master/cmd/quotetest for a tool that shows the results of quoting with each package.

Example

package main

import (
	"fmt"
	"os"

	"github.com/frioux/shellquote"
)

func main() {
	fmt.Println("#!/bin/sh")
	fmt.Println("")
	quoted, err := shellquote.Quote(os.Args[1:])
	if err != nil {
		fmt.Fprintf(os.Stderr, "Couldn't quote input: %s\n", err)
		os.Exit(1)
	}
	// error won't happen if the first input didn't error
	doublequoted, _ := shellquote.Quote([]string{quoted})
	fmt.Println("ssh superserver", doublequoted)
}

Index

• Variables
• func Quote(in []string) (string, error)

Examples

• Package

Variables

var ErrNull = errors.New("No way to quote string containing null bytes")

ErrNull will be returned from Quote if any of the strings contains a null byte.

Functions

func Quote

func Quote(in []string) (string, error)

Quote will return a shell quoted string for the passed tokens.