Skip to content

Commit

Permalink
docs: update instalation (#120)
Browse files Browse the repository at this point in the history
Signed-off-by: chenk <[email protected]>
  • Loading branch information
chen-keinan authored May 9, 2024
1 parent 31c32e6 commit 8be2957
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 3 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,29 @@ GOOS=linux GOARCH=arm64 go build -o node-collector main.go

## Executing node-collector binary

```sh
Usage:
node-collector [flags]
node-collector [command]

Examples:
node-collector k8s [flags]

Available Commands:
completion Generate the autocompletion script for the specified shell
help Help about any command
k8s k8s-node-collector extract file system info from cluster Node

Flags:
-c, --cluster-version string cluser version. example 1.23.0
-h, --help help for node-collector
--kubelet-config string kubelet config via api /api/v1/nodes/<>/proxy/configz encoded in base64
-n, --node string node name
-o, --output string Output format. One of table|json (default "json")
-s, --spec-name string spec name. example: k8s-cis
-v, --spec-version string spec version. example 1.23.0
```

```sh
./node-collector k8s
```
Expand Down
7 changes: 4 additions & 3 deletions pkg/command/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@ func init() {
}

var rootCmd = &cobra.Command{
Use: "node-collector",
Short: "trivy-collector extract file system info",
Long: `A tool which provide a way to extract file info which is not accessible via pre-define commands`,
Use: "node-collector",
Example: "node-collector k8s [flags]",
Short: "trivy-collector extract file system info",
Long: `A tool which provide a way to extract file info which is not accessible via pre-define commands`,
RunE: func() func(cmd *cobra.Command, args []string) error {
return func(cmd *cobra.Command, args []string) error {
return cmd.Help()
Expand Down

0 comments on commit 8be2957

Please sign in to comment.