cli

Documentation

Index

• Variables
• func ApplyOverlay(overlayPath, inPath, outPath string) error
• func CheckFreeUsageAccess() (bool, error)
• func Download(pinnedVersion string, g Git) (string, error)
• func GetChangelog(lang, genVersion, previousGenVersion string, targetVersions map[string]string, ...) (string, error)
• func GetGenerationVersion() (*version.Version, error)
• func GetSpeakeasyVersion() (*version.Version, error)
• func GetSupportedLanguages() ([]string, error)
• func GetVersion(pinnedVersion string) string
• func IsAtLeastVersion(version *version.Version) bool
• func MergeDocuments(files []string, output string) error
• func Run(sourcesOnly bool, installationURLs map[string]string, repoURL string, ...) error
• func Suggest(docPath, maxSuggestions, docOutputPath string) (string, error)
• func TriggerGoGenerate() error
• type Git

Variables

var MinimumSupportedCLIVersion = version.Must(version.NewVersion("1.130.0"))

Functions

func ApplyOverlay

func ApplyOverlay(overlayPath, inPath, outPath string) error

func CheckFreeUsageAccess

func CheckFreeUsageAccess() (bool, error)

func Download

func Download(pinnedVersion string, g Git) (string, error)

func GetChangelog

func GetChangelog(lang, genVersion, previousGenVersion string, targetVersions map[string]string, previousVersions map[string]string) (string, error)

func GetGenerationVersion

func GetGenerationVersion() (*version.Version, error)

func GetSpeakeasyVersion

func GetSpeakeasyVersion() (*version.Version, error)

func GetSupportedLanguages

func GetSupportedLanguages() ([]string, error)

func GetVersion

func GetVersion(pinnedVersion string) string

func IsAtLeastVersion

func IsAtLeastVersion(version *version.Version) bool

func MergeDocuments

func MergeDocuments(files []string, output string) error

func Run

func Run(sourcesOnly bool, installationURLs map[string]string, repoURL string, repoSubdirectories map[string]string) error

func Suggest

func Suggest(docPath, maxSuggestions, docOutputPath string) (string, error)

func TriggerGoGenerate

func TriggerGoGenerate() error

Types

type Git

type Git interface {
	GetLatestTag() (string, error)
	GetDownloadLink(version string) (string, string, error)
}