Help us shape the future of Go! Take the 2026 Go Developer Survey

docs

package
v1.41.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 20, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// Security Commands Keys
	XrCurl               = "xr-curl"
	OfflineUpdate        = "offline-update"
	XrScan               = "xr-scan"
	BuildScan            = "build-scan"
	DockerScan           = "docker scan"
	Audit                = "audit"
	CurationAudit        = "curation-audit"
	CurationActions      = "curate-gh-actions"
	GitAudit             = "git-audit"
	GitCountContributors = "count-contributors"
	Enrich               = "sbom-enrich"
	UploadCdx            = "upload-cdx"
	MaliciousScan        = "malicious-scan"
	SastServer           = "sast-server"
	Status               = "xr-status"

	// TODO: Deprecated commands (remove at next CLI major version)
	AuditMvn    = "audit-maven"
	AuditGradle = "audit-gradle"
	AuditNpm    = "audit-npm"
	AuditGo     = "audit-go"
	AuditPip    = "audit-pip"
	AuditPipenv = "audit-pipenv"
)
View Source
const (
	Mvn       = "mvn"
	Gradle    = "gradle"
	Npm       = "npm"
	Pnpm      = "pnpm"
	Yarn      = "yarn"
	Nuget     = "nuget"
	Go        = "go"
	Pip       = "pip"
	Pipenv    = "pipenv"
	Poetry    = "poetry"
	Swift     = "swift"
	Cocoapods = "cocoapods"
)
View Source
const (
	Sca       = "sca"
	Iac       = "iac"
	Sast      = "sast"
	Secrets   = "secrets"
	Services  = "services"
	WithoutCA = "without-contextual-analysis"

	// Sast related flags
	AddSastRules = "add-sast-rules"
	Port         = "port"
)
View Source
const (
	// Base flags keys
	ServerId = "server-id"
	Url      = "url"
	XrayUrl  = "xray-url"

	// Client certification flags
	InsecureTls = "insecure-tls"

	// Generic command flags
	SpecFlag          = "spec"
	Threads           = "threads"
	Recursive         = "recursive"
	RegexpFlag        = "regexp"
	AntFlag           = "ant"
	Project           = "project"
	Exclusions        = "exclusions"
	IncludeDirs       = "include-dirs"
	UseWrapper        = "use-wrapper"
	UseIncludedBuilds = "use-included-builds"
)
View Source
const (
	// Unique offline-update flags keys
	LicenseId = "license-id"
	From      = "from"
	To        = "to"
	Version   = "version"
	Target    = "target"
	Stream    = "stream"
	Periodic  = "periodic"

	OutputFormat        = "format"
	BypassArchiveLimits = "bypass-archive-limits"
	Watches             = "watches"
	RepoPath            = "repo-path"
	UploadRepoPath      = "rt-" + RepoPath
	Licenses            = "licenses"
	Sbom                = "sbom"
	Snippet             = "snippet"
	Fail                = "fail"
	ExtendedTable       = "extended-table"
	MinSeverity         = "min-severity"
	FixableOnly         = "fixable-only"
	Rescan              = "rescan"
	TriggerScanRetries  = "trigger-scan-retries"
	Vuln                = "vuln"
	Violations          = "violations"

	BuildVuln        = buildPrefix + Vuln
	BuildViolations  = buildPrefix + Violations
	ScanVuln         = scanPrefix + Vuln
	SecretValidation = "validate-secrets"
	StaticSca        = "static-sca"

	ExclusionsAudit = auditPrefix + Exclusions

	ExcludeTestDeps               = "exclude-test-deps"
	DepType                       = "dep-type"
	MaxTreeDepth                  = "max-tree-depth"
	ThirdPartyContextualAnalysis  = "third-party-contextual-analysis"
	RequirementsFile              = "requirements-file"
	WorkingDirs                   = "working-dirs"
	OutputDir                     = "output-dir"
	SkipAutoInstall               = "skip-auto-install"
	AllowPartialResults           = "allow-partial-results"
	XrayLibPluginBinaryCustomPath = "xray-lib-plugin-path"
	AnalyzerManagerCustomPath     = "analyzer-manager-path"

	// Unique status flags
	StatusOutput = "xr-status-format"

	// Unique curation flags
	CurationOutput        = "curation-format"
	DockerImageName       = "image"
	HuggingFaceModel      = "hugging-face-model"
	SolutionPath          = "solution-path"
	IncludeCachedPackages = "include-cached-packages"
	LegacyPeerDeps        = "legacy-peer-deps"
	RunNative             = "run-native"
	MvnIncludePluginDeps  = "mvn-include-plugin-deps"
	Script                = "script"

	InputFile       = "input-file"
	ScmType         = "scm-type"
	ScmApiUrl       = "scm-api-url"
	Token           = "token"
	Owner           = "owner"
	RepoName        = "repo-name"
	Months          = "months"
	DetailedSummary = "detailed-summary"
	CacheValidity   = "cache-validity"
	GitThreads      = gitPrefix + Threads

	UseConfigProfile = "use-config-profile"
	Workspace        = "workspace"
)

Variables

This section is empty.

Functions

func GetCommandFlags

func GetCommandFlags(cmdKey string) []components.Flag

Types

This section is empty.

Jump to

Keyboard shortcuts

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