Skip to content

Commit

Permalink
add more verbose callgraph docs, include temp links to portal
Browse files Browse the repository at this point in the history
  • Loading branch information
jonna-debricked committed Sep 13, 2023
1 parent 99605e1 commit 3a82e23
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions internal/cmd/callgraph/callgraph.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@ func NewCallgraphCmd(generator callgraph.IGenerator) *cobra.Command {
Use: "callgraph [path]",
Short: "Generate a static call graph for the given directory and subdirectories",
Long: `Generate a static call graph for a project. If a directory is inputted all manifest files without a lock file are resolved.
The command consists of two main parts, Build and Callgraph.
Build: build the project and resolve dependencies. In this step, all necessary .class files are created.
Callgraph: generate the static call graph using debricked Vulnerable Functionality.
The full documentation is available here https://debricked.com/docs/integrations/cli.html#debricked-cli
Example:
$ debricked callgraph
Expand All @@ -36,7 +41,6 @@ $ debricked callgraph
},
RunE: RunE(generator),
}
// TODO: add to docs: Complete documentation with advanced user guide is available at https://portal.debricked.com/docs/...
fileExclusionExample := filepath.Join("*", "**.lock")
dirExclusionExample := filepath.Join("**", "node_modules", "**")
exampleFlags := fmt.Sprintf("-e \"%s\" -e \"%s\"", fileExclusionExample, dirExclusionExample)
Expand All @@ -53,7 +57,9 @@ Special Terms | Meaning
Example:
$ debricked files resolve . `+exampleFlags)
cmd.Flags().BoolVar(&buildDisabled, NoBuildFlag, false, "Do not automatically build all source code in the project to enable call graph generation. This option requires a pre-built project.")
cmd.Flags().BoolVar(&buildDisabled, NoBuildFlag, false, `Do not automatically build all source code in the project to enable call graph generation.
This option requires a pre-built project, for more detailed documentation on Vulnerable Functionality visit our portal:
https://portal.debricked.com/vulnerability-management-43/how-do-i-enable-the-vulnerable-functionality-246`)
cmd.Flags().IntVar(&generateTimeout, GenerateTimeoutFlag, 60*60, "Timeout (in seconds) on call graph generation.")

viper.MustBindEnv(ExclusionFlag)
Expand Down

0 comments on commit 3a82e23

Please sign in to comment.