Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: user feedbacks about documentation #121

Merged
merged 5 commits into from
Jun 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@ During the software development lifecycle (SDLC), developers ofen communicate an

## Getting 2ms

```
go install github.com/checkmarx/2ms@latest
```bash
curl -LO https://github.com/Checkmarx/2ms/releases/latest/download/2ms && chmod +x 2ms
./2ms
```

### Docker
Expand Down
6 changes: 3 additions & 3 deletions plugins/git.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ func (p *GitPlugin) DefineCommand(channels Channels) (*cobra.Command, error) {
p.Channels = channels

command := &cobra.Command{
Use: fmt.Sprintf("%s <PATH>", p.GetName()),
Short: "Scan Git repository",
Long: "Scan Git repository for sensitive information.",
Use: fmt.Sprintf("%s <CLONED_REPO>", p.GetName()),
Short: "Scan local Git repository",
Long: "Scan local Git repository for sensitive information.",
Args: cobra.MatchAll(cobra.ExactArgs(1), validGitRepoArgs),
Run: func(cmd *cobra.Command, args []string) {
log.Info().Msg("Git plugin started")
Expand Down
7 changes: 5 additions & 2 deletions plugins/paligo.go
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ func (p *PaligoPlugin) DefineCommand(channels Channels) (*cobra.Command, error)
command.MarkFlagsMutuallyExclusive(paligoUsernameFlag, paligoAuthFlag)
command.MarkFlagsMutuallyExclusive(paligoTokenFlag, paligoAuthFlag)

command.Flags().IntVar(&paligoFolderArg, paligoFolderFlag, 0, "Paligo folder ID")
command.Flags().IntVar(&paligoFolderArg, paligoFolderFlag, 0, "Paligo folder ID. If not specified, the whole instance will be scanned")

return command, nil
}
Expand Down Expand Up @@ -302,8 +302,11 @@ func (p *PaligoClient) listFolders() (*[]EmptyFolder, error) {

var folders *ListFoldersResponse
err = json.Unmarshal(body, &folders)
if err != nil {
return nil, fmt.Errorf("error parsing folders response: %w", err)
}

return &folders.Folders, err
return &folders.Folders, nil
}

func (p *PaligoClient) showFolder(folderId int) (*Folder, error) {
Expand Down