shellquote

README

shellquote

Shell argument quoting and prompt-file helpers for command templates.

Install

go get github.com/brandonkramer/shellquote

Usage

cmd := shellquote.SubstitutePrompt("cat {prompt}", "/tmp/run/prompt.md")
path, err := shellquote.WritePrompt(runDir, promptContent)

Documentation

Overview

Package shellquote provides shell argument quoting and prompt-file helpers.

Index

• Constants
• func PromptPath(runDir string) string
• func Quote(s string) string
• func SubstitutePrompt(template, promptPath string) string
• func WritePrompt(runDir, content string) (string, error)

Constants

const (
	// DefaultPromptFile is the default prompt filename under a run directory.
	DefaultPromptFile = "prompt.md"
	// PromptPlaceholder is substituted with a quoted prompt path in templates.
	PromptPlaceholder = "{prompt}"
)

Functions

func PromptPath

func PromptPath(runDir string) string

PromptPath returns the default prompt file path under runDir.

func Quote

func Quote(s string) string

Quote wraps s in single quotes for POSIX shells.

func SubstitutePrompt

func SubstitutePrompt(template, promptPath string) string

SubstitutePrompt replaces PromptPlaceholder with a quoted promptPath in template.

func WritePrompt

func WritePrompt(runDir, content string) (string, error)

WritePrompt writes content to the default prompt file under runDir.