Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
owenrumney committed Feb 7, 2021
1 parent b8c3c74 commit faa0ee8
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 11 deletions.
25 changes: 16 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,22 @@ curl -s "https://raw.githubusercontent.com/owenrumney/squealer/main/scripts/inst

Squealer is intended to be run either locally or as part of a CI process.

### CLI Arguments

#### `--redacted`

The `--redacted` argument is used to redact the secrets in the report... no point exposing them further

#### `--config-file`

Squealer will use the built in config unless you override it using the `--config-file` option. This config file should be laid out in the following format
```shell
./squealer --help
Telling tales on your secret leaking

Usage:
squeal [flags]

Flags:
--concise Reduced output.
--config-file string Path to the config file with the rules.
--from-hash string The starting hash to scan from.
-h, --help this help screen
--no-git Scan as a directory rather than a git history.
--redacted Display the results redacted.
```
### Config File

```yaml
rules:
Expand Down
4 changes: 2 additions & 2 deletions cmd/squealer/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ import (
var rootcmd = &cobra.Command{
Use: "squeal",
Short: "Search for secrets and squeal about them",
Long: `Start commit searching`,
Long: `Telling tales on your secret leaking`,
Run: squeal,
}

var (
redacted = false
concise = true
concise = false
noGit = false
configFilePath string
fromHash string
Expand Down

0 comments on commit faa0ee8

Please sign in to comment.