shell

Documentation

Index

• func BranchCompletion(flag, text string, maxCompletions int64) []prompt.Suggest
• func FileCompletion(flag, text string, maxCompletions int64) []prompt.Suggest
• func FilesystemCompletion(_, text string, maxCompletions int64) []prompt.Suggest
• func JobCompletion(_, text string, maxCompletions int64) []prompt.Suggest
• func PipelineCompletion(_, text string, maxCompletions int64) []prompt.Suggest
• func RegisterCompletionFunc(cmd *cobra.Command, completionFunc CompletionFunc)
• func RepoCompletion(_, text string, maxCompletions int64) []prompt.Suggest
• func Run(rootCmd *cobra.Command, maxCompletions int64)
• type CompletionFunc

Functions

func BranchCompletion

func BranchCompletion(flag, text string, maxCompletions int64) []prompt.Suggest

BranchCompletion completes branch parameters of the form <repo>@<branch>

func FileCompletion

func FileCompletion(flag, text string, maxCompletions int64) []prompt.Suggest

FileCompletion completes file parameters of the form <repo>@<branch>:/file

func FilesystemCompletion

func FilesystemCompletion(_, text string, maxCompletions int64) []prompt.Suggest

FilesystemCompletion completes file parameters from the local filesystem (not from pfs).

func JobCompletion

func JobCompletion(_, text string, maxCompletions int64) []prompt.Suggest

JobCompletion completes job parameters of the form <job>

func PipelineCompletion

func PipelineCompletion(_, text string, maxCompletions int64) []prompt.Suggest

PipelineCompletion completes pipeline parameters of the form <pipeline>

func RegisterCompletionFunc

func RegisterCompletionFunc(cmd *cobra.Command, completionFunc CompletionFunc)

RegisterCompletionFunc registers a completion function for a command. NOTE: RegisterCompletionFunc must be called before cmd is passed to functions that make copies of it (such as cmdutil.CreateAlias. This is because RegisterCompletionFunc modifies cmd in a superficial way by adding an annotation (to the Annotations field) that associates it with the completion function. This means that

func RepoCompletion

func RepoCompletion(_, text string, maxCompletions int64) []prompt.Suggest

RepoCompletion completes repo parameters of the form <repo>

func Run

func Run(rootCmd *cobra.Command, maxCompletions int64)

Run runs a prompt, it does not return.

Types

type CompletionFunc

type CompletionFunc func(flag, arg string, maxCompletions int64) []prompt.Suggest

CompletionFunc is the type of functions which implement completions for pachctl commands.