Skip to content

Commit

Permalink
add command docs content
Browse files Browse the repository at this point in the history
  • Loading branch information
attiasas committed Jan 1, 2024
1 parent 2e44e04 commit 10259d1
Show file tree
Hide file tree
Showing 6 changed files with 77 additions and 0 deletions.
31 changes: 31 additions & 0 deletions cli/docs/auditspecific/help.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
package auditspecific

import "fmt"

// TODO: Deprecated commands (remove at next CLI major version)

const descFormat = "Execute an audit %s command, using the configured Xray details."

func GetGoDescription() string {
return fmt.Sprintf(descFormat, "Go")
}

func GetGradleDescription() string {
return fmt.Sprintf(descFormat, "Gradle")
}

func GetMvnDescription() string {
return fmt.Sprintf(descFormat, "Maven")
}

func GetNpmDescription() string {
return fmt.Sprintf(descFormat, "Npm")
}

func GetPipDescription() string {
return fmt.Sprintf(descFormat, "Pip")
}

func GetPipenvDescription() string {
return fmt.Sprintf(descFormat, "Pipenv")
}
5 changes: 5 additions & 0 deletions cli/docs/scan/audit/help.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
package audit

func GetDescription() string {
return "Audit your local project's dependencies by generating a dependency tree and scanning it with Xray."
}
20 changes: 20 additions & 0 deletions cli/docs/scan/buildscan/help.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
package buildscan

import "github.com/jfrog/jfrog-cli-core/v2/plugins/components"

func GetDescription() string {
return "Scan a published build-info with Xray."
}

func GetArguments() []components.Argument {
return []components.Argument{
{
Name: "build name",
Description: "Build name.",
},
{
Name: "build number",
Description: "Build number.",
},
}
}
5 changes: 5 additions & 0 deletions cli/docs/scan/curation/help.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
package curation

func GetDescription() string {
return "Audit your project dependencies for their curation status."
}
11 changes: 11 additions & 0 deletions cli/docs/xray/curl/help.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
package curl

import "github.com/jfrog/jfrog-cli-core/v2/plugins/components"

func GetDescription() string {
return "Execute a cURL command, using the configured Xray details."
}

func GetArguments() []components.Argument {
return []components.Argument{{Name: "curl command", Description: "cURL command to run."}}
}
5 changes: 5 additions & 0 deletions cli/docs/xray/offlineupdate/help.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
package offlineupdate

func GetDescription() string {
return "Download Xray offline updates."
}

0 comments on commit 10259d1

Please sign in to comment.