cli

package

v0.28.1 Latest Latest Go to latest Published: Apr 17, 2026 License: Apache-2.0 Imports: 27 Imported by: 0

Details

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

Repository

github.com/unkn0wn-root/resterm

Links

Documentation ¶

Index ¶

Variables
func CleanExecPath(path string) string
func CommandFileConflict(app, name, hint string) error
func ExitCode(err error) int
func HasFileConflict(name string) bool
func LoadEnvironment(explicit, filePath, workspace string) (vars.EnvironmentSet, string)
func NewExecClient(version string, f ExecFlags) (*httpclient.Client, func() error, error)
func NewFlagSet(name string) *flag.FlagSet
func NewSubcommandFlagSet(app, name string, w io.Writer) *flag.FlagSet
func ParseCompareTargets(raw string) ([]string, error)
func ParseRunDoc(src RunSource) (*restfile.Document, error)
func PrintFlagSetUsage(w io.Writer, app string, fs *flag.FlagSet)
func SelectDefaultEnvironment(envs vars.EnvironmentSet) (string, bool)
func StdinRunPath(workspace string) string
func StringVar(fs *flag.FlagSet, dst *string, name, value, usage string)
func ValidateReservedEnvironment(value, flagName string) error
func WriteRunRequestChoices(w io.Writer, path string, choices []RunRequestChoice) error
type ExecConfig
type ExecFlags
- func NewExecFlags() ExecFlags
- func (f *ExecFlags) Bind(fs *flag.FlagSet)
- func (f *ExecFlags) BindTelemetryFlags(fs *flag.FlagSet)
- func (f ExecFlags) Resolve(filePath string) (ExecConfig, error)
- func (f ExecFlags) TelemetryConfig(version string) telemetry.Config
- func (f ExecFlags) ValidateEnvFlag() error
type ExitErr
- func (e ExitErr) Error() string
- func (e ExitErr) ExitCode() int
- func (e ExitErr) Unwrap() error
type RunRequestChoice
- func BuildRunRequestChoices(doc *restfile.Document) []RunRequestChoice
- func PromptRunRequestChoice(r io.Reader, w io.Writer, path string, choices []RunRequestChoice, ...) (RunRequestChoice, error)
type RunRequestPromptOptions
type RunSource

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrRunRequestChoiceCanceled = errors.New("request selection canceled")

Functions ¶

func CleanExecPath ¶ added in v0.28.1

func CleanExecPath(path string) string

func CommandFileConflict ¶

func CommandFileConflict(app, name, hint string) error

func ExitCode ¶

func ExitCode(err error) int

func HasFileConflict ¶

func HasFileConflict(name string) bool

func LoadEnvironment ¶

func LoadEnvironment(explicit, filePath, workspace string) (vars.EnvironmentSet, string)

func NewExecClient ¶ added in v0.28.1

func NewExecClient(version string, f ExecFlags) (*httpclient.Client, func() error, error)

func NewFlagSet ¶

func NewFlagSet(name string) *flag.FlagSet

func NewSubcommandFlagSet ¶

func NewSubcommandFlagSet(app, name string, w io.Writer) *flag.FlagSet

func ParseCompareTargets ¶

func ParseCompareTargets(raw string) ([]string, error)

func ParseRunDoc ¶ added in v0.28.1

func ParseRunDoc(src RunSource) (*restfile.Document, error)

func PrintFlagSetUsage ¶

func PrintFlagSetUsage(w io.Writer, app string, fs *flag.FlagSet)

func SelectDefaultEnvironment ¶

func SelectDefaultEnvironment(envs vars.EnvironmentSet) (string, bool)

func StdinRunPath ¶ added in v0.28.1

func StdinRunPath(workspace string) string

StdinRunPath gives stdin-backed runs a stable request-file path so relative resolution still has a workspace anchor.

func StringVar ¶ added in v0.28.1

func StringVar(fs *flag.FlagSet, dst *string, name, value, usage string)

func ValidateReservedEnvironment ¶

func ValidateReservedEnvironment(value, flagName string) error

func WriteRunRequestChoices ¶ added in v0.28.1

func WriteRunRequestChoices(
	w io.Writer,
	path string,
	choices []RunRequestChoice,
) error

Types ¶

type ExecConfig ¶ added in v0.28.1

type ExecConfig struct {
	FilePath       string
	Workspace      string
	Recursive      bool
	EnvSet         vars.EnvironmentSet
	EnvName        string
	EnvFile        string
	EnvFallback    string
	HTTPOpts       httpclient.Options
	GRPCOpts       grpcclient.Options
	CompareTargets []string
	CompareBase    string
}

type ExecFlags ¶ added in v0.28.1

type ExecFlags struct {
	EnvName           string
	EnvFile           string
	Workspace         string
	Timeout           time.Duration
	Insecure          bool
	Follow            bool
	ProxyURL          string
	Recursive         bool
	CompareTargetsRaw string
	CompareBaseline   string
	// contains filtered or unexported fields
}

func NewExecFlags ¶ added in v0.28.1

func NewExecFlags() ExecFlags

func (*ExecFlags) Bind ¶ added in v0.28.1

func (f *ExecFlags) Bind(fs *flag.FlagSet)

func (*ExecFlags) BindTelemetryFlags ¶ added in v0.28.1

func (f *ExecFlags) BindTelemetryFlags(fs *flag.FlagSet)

func (ExecFlags) Resolve ¶ added in v0.28.1

func (f ExecFlags) Resolve(filePath string) (ExecConfig, error)

func (ExecFlags) TelemetryConfig ¶ added in v0.28.1

func (f ExecFlags) TelemetryConfig(version string) telemetry.Config

func (ExecFlags) ValidateEnvFlag ¶ added in v0.28.1

func (f ExecFlags) ValidateEnvFlag() error

type ExitErr ¶

type ExitErr struct {
	Err  error
	Code int
}

func (ExitErr) Error ¶

func (e ExitErr) Error() string

func (ExitErr) ExitCode ¶

func (e ExitErr) ExitCode() int

func (ExitErr) Unwrap ¶

func (e ExitErr) Unwrap() error

type RunRequestChoice ¶ added in v0.28.1

type RunRequestChoice struct {
	Line   int
	Method string
	Name   string
	Target string
	Label  string
}

func BuildRunRequestChoices ¶ added in v0.28.1

func BuildRunRequestChoices(doc *restfile.Document) []RunRequestChoice

func PromptRunRequestChoice ¶ added in v0.28.1

func PromptRunRequestChoice(
	r io.Reader,
	w io.Writer,
	path string,
	choices []RunRequestChoice,
	opt RunRequestPromptOptions,
) (RunRequestChoice, error)

type RunRequestPromptOptions ¶ added in v0.28.1

type RunRequestPromptOptions struct {
	TTY   bool
	Color termcolor.Config
}

type RunSource ¶ added in v0.28.1

type RunSource struct {
	Path  string
	Data  []byte
	Stdin bool
}

Source Files ¶

View all Source files

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