terminalsetup

package

v0.1.0 Latest Latest Go to latest Published: Jul 14, 2026 License: MIT Imports: 7 Imported by: 0

Details

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

Repository

github.com/Rememorio/codog

Links

Open Source Insights

Documentation ¶

Overview ¶

Package terminalsetup detects shell integration and terminal capabilities.

Index ¶

func DefaultPath(shell string) (string, error)
func DefaultTargetPath(target string) (string, error)
func DetectShell(envShell string) string
func NormalizeShell(shell string) string
func NormalizeTarget(target string) (string, error)
func Snippet(shell string) (string, error)
func TargetSnippet(target string) (string, error)
type Options
type Report
- func Run(opts Options) (Report, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DefaultPath ¶

func DefaultPath(shell string) (string, error)

func DefaultTargetPath ¶

func DefaultTargetPath(target string) (string, error)

func DetectShell ¶

func DetectShell(envShell string) string

func NormalizeShell ¶

func NormalizeShell(shell string) string

func NormalizeTarget ¶

func NormalizeTarget(target string) (string, error)

func Snippet ¶

func Snippet(shell string) (string, error)

func TargetSnippet ¶

func TargetSnippet(target string) (string, error)

Types ¶

type Options ¶

type Options struct {
	Action string
	Shell  string
	Target string
	Path   string
	Force  bool
}

type Report ¶

type Report struct {
	Kind      string `json:"kind"`
	Action    string `json:"action"`
	Status    string `json:"status"`
	Target    string `json:"target,omitempty"`
	Shell     string `json:"shell"`
	Path      string `json:"path,omitempty"`
	Installed bool   `json:"installed"`
	Changed   bool   `json:"changed,omitempty"`
	Snippet   string `json:"snippet,omitempty"`
	Message   string `json:"message,omitempty"`
}

func Run ¶

func Run(opts Options) (Report, error)

Source Files ¶

View all Source files

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