Documentation ¶
Index ¶
- Constants
- func CreateBuildInfoSummaryReportString(success, failed int, sha256 string, err error) (string, error)
- func CreateServerDetailsFromFlags(c *cli.Context) (details *config.ServerDetails)
- func CreateSummaryReportString(success, failed int, err error) (string, error)
- func ExtractCommand(c *cli.Context) (command []string)
- func GetBasicBuildToolsFlags() (flags []cli.Flag)
- func GetBuildName(buildName string) string
- func GetBuildUrl(buildUrl string) string
- func GetCliError(err error, success, failed int, failNoOp bool) error
- func GetCommandFlags(cmd string) []cli.Flag
- func GetDocumentationMessage() string
- func GetEnvExclude(envExclude string) string
- func GetIntFlagValue(c *cli.Context, flagName string, defValue int) (int, error)
- func GetInteractiveValue(c *cli.Context) bool
- func GetLegacyGoFlags() (flags []cli.Flag)
- func GetLegacyNpmFlags() (flags []cli.Flag)
- func GetLegacyNugetFlags() (flags []cli.Flag)
- func GetQuietValue(c *cli.Context) bool
- func GetSortedCommands(commands cli.CommandsByName) cli.CommandsByName
- func GetStringsArrFlagValue(c *cli.Context, flagName string) (resultArray []string)
- func GetVersion() string
- func IsLegacyGoPublish(c *cli.Context) bool
- func PrintBuildInfoSummaryReport(succeeded bool, sha256 string, originalErr error) error
- func PrintDetailedSummaryReport(success, failed int, reader *content.ContentReader, printExtendedDetails bool, ...) error
- func PrintHelpAndReturnError(msg string, context *cli.Context) error
- func PrintSummaryReport(success, failed int, originalErr error) error
- func ShouldOfferConfig() (bool, error)
- type DetailedSummaryRecord
- type ExtendedDetailedSummaryRecord
- type OnError
Constants ¶
const ( // General CLI constants CliVersion = "1.51.1" ClientAgent = "jfrog-cli-go" // CLI base commands constants: CmdArtifactory = "rt" CmdBintray = "bt" CmdMissionControl = "mc" CmdXray = "xr" CmdCompletion = "completion" CmdPlugin = "plugin" CmdConfig = "config" // Download DownloadMinSplitKb = 5120 DownloadSplitCount = 3 DownloadMaxSplitCount = 15 // Common Retries = 3 Threads = 3 TokenExpiry = 3600 DefaultLicenseCount = 1 // Env OfferConfig = "JFROG_CLI_OFFER_CONFIG" BuildUrl = "JFROG_CLI_BUILD_URL" EnvExclude = "JFROG_CLI_ENV_EXCLUDE" UserAgent = "JFROG_CLI_USER_AGENT" )
const ( // Artifactory's Commands Keys RtConfig = "rt-config" DeleteConfig = "delete-config" Upload = "upload" Download = "download" Move = "move" Copy = "copy" Delete = "delete" Properties = "properties" Search = "search" BuildPublish = "build-publish" BuildAppend = "build-append" BuildScan = "build-scan" BuildPromote = "build-promote" BuildDistribute = "build-distribute" BuildDiscard = "build-discard" BuildAddDependencies = "build-add-dependencies" BuildAddGit = "build-add-git" BuildCollectEnv = "build-collect-env" GitLfsClean = "git-lfs-clean" Mvn = "mvn" MvnConfig = "mvn-config" Gradle = "gradle" GradleConfig = "gradle-config" DockerPromote = "docker-promote" ContainerPull = "container-pull" ContainerPush = "container-push" BuildDockerCreate = "build-docker-create" NpmConfig = "npm-config" Npm = "npm" NpmPublish = "npmPublish" YarnConfig = "yarn-config" Yarn = "yarn" NugetConfig = "nuget-config" Nuget = "nuget" Dotnet = "dotnet" DotnetConfig = "dotnet-config" Go = "go" GoConfig = "go-config" GoPublish = "go-publish" GoRecursivePublish = "go-recursive-publish" PipInstall = "pip-install" PipConfig = "pip-config" Ping = "ping" RtCurl = "rt-curl" ReleaseBundleCreate = "release-bundle-create" ReleaseBundleUpdate = "release-bundle-update" ReleaseBundleSign = "release-bundle-sign" ReleaseBundleDistribute = "release-bundle-distribute" ReleaseBundleDelete = "release-bundle-delete" TemplateConsumer = "template-consumer" RepoDelete = "repo-delete" ReplicationDelete = "replication-delete" PermissionTargetDelete = "permission-target-delete" AccessTokenCreate = "access-token-create" UserCreate = "user-create" UsersCreate = "users-create" UsersDelete = "users-delete" GroupCreate = "group-create" GroupAddUsers = "group-add-users" GroupDelete = "group-delete" // MC's Commands Keys McConfig = "mc-config" LicenseAcquire = "license-acquire" LicenseDeploy = "license-deploy" LicenseRelease = "license-release" JpdAdd = "jpd-add" JpdDelete = "jpd-delete" // XRay's Commands Keys XrCurl = "xr-curl" OfflineUpdate = "offline-update" // Config commands keys AddConfig = "config-add" EditConfig = "config-edit" // Unique nuget flags NugetArgs = "nuget-args" SolutionRoot = "solution-root" // This flag is different than the nugetV2 since it is hidden and used in the 'nuget' cmd, and not the 'nugetc' cmd. LegacyNugetV2 = "nuget-v2-protocol" UsersGroups = "users-groups" Replace = "replace" Admin = "admin" )
Variables ¶
This section is empty.
Functions ¶
func CreateBuildInfoSummaryReportString ¶ added in v1.47.0
func CreateServerDetailsFromFlags ¶ added in v1.45.0
func CreateServerDetailsFromFlags(c *cli.Context) (details *config.ServerDetails)
func ExtractCommand ¶ added in v1.41.2
func GetBasicBuildToolsFlags ¶ added in v1.39.0
This function is used for mvn and gradle command validation
func GetBuildName ¶ added in v1.39.5
func GetBuildUrl ¶ added in v1.39.5
func GetCommandFlags ¶ added in v1.39.0
func GetDocumentationMessage ¶
func GetDocumentationMessage() string
func GetEnvExclude ¶ added in v1.39.5
func GetIntFlagValue ¶
func GetInteractiveValue ¶
This function indicates whether the command should be executed in an interactive mode. If the --interactive option was sent, it is used to determine the mode. If not, the mode will be interactive, unless the CI environment variable was set to true.
func GetLegacyGoFlags ¶ added in v1.39.0
This function is used for legacy (deprecated) go command validation
func GetLegacyNpmFlags ¶ added in v1.39.0
This function is used for legacy (deprecated) npm command validation
func GetLegacyNugetFlags ¶ added in v1.39.0
This function is used for legacy (deprecated) nuget command validation
func GetQuietValue ¶
This function indicates whether the command should be executed without confirmation warning or not. If the --quiet option was sent, it is used to determine whether to prompt the confirmation or not. If not, the command will prompt the confirmation, unless the CI environment variable was set to true.
func GetSortedCommands ¶ added in v1.46.0
func GetSortedCommands(commands cli.CommandsByName) cli.CommandsByName
func GetStringsArrFlagValue ¶
func GetVersion ¶
func GetVersion() string
func IsLegacyGoPublish ¶ added in v1.46.4
func PrintBuildInfoSummaryReport ¶ added in v1.47.0
func PrintDetailedSummaryReport ¶ added in v1.47.0
func PrintDetailedSummaryReport(success, failed int, reader *content.ContentReader, printExtendedDetails bool, originalErr error) error
Prints a summary report. If a resultReader is provided, we will iterate over the result and print a detailed summary including the affected files.
func PrintSummaryReport ¶
func ShouldOfferConfig ¶ added in v1.45.0
Types ¶
type DetailedSummaryRecord ¶ added in v1.47.0
type ExtendedDetailedSummaryRecord ¶ added in v1.48.0
type ExtendedDetailedSummaryRecord struct { DetailedSummaryRecord Sha256 string `json:"sha256"` }