)
```go
-func (h Hunter) Hunt() error
+func (h *Hunter) Hunt() (scan.Report, error)
```
-Hunt walks over the filesystem at the configured path\, looking for sensitive information
+Hunt walks over the filesystem at the configured path\, looking for sensitive information\.
-Example
-
-
-This method also accepts custom output formats using go template/html\. So if you don't like yaml or json\, you can format to your heart's content\.
+### func \(\*Hunter\) [Report]()
```go
-{
- fs := afero.NewMemMapFs()
- f, err := fs.Create("example.yaml")
- if err != nil {
- panic(err)
- }
- defer f.Close()
-
- _, err = f.Write([]byte(`https://github.com/brittonhayes/pillager`))
- if err != nil {
- panic(err)
- }
-
- config := NewConfig(fs, "./", true, rules.Load(""), CustomFormat, DefaultTemplate, 5)
- h := NewHunter(config)
- _ = h.Hunt()
-}
+func (h *Hunter) Report(w io.Writer, results scan.Report) error
```
-
-Example
-
-
-This is an example of how to run a scan on a single file to look for email addresses\. We're using an in\-memory file system for simplicity\, but this supports using an actual file system as well\.
-
-```go
-{
- fs := afero.NewMemMapFs()
- f, err := fs.Create("example.toml")
- if err != nil {
- panic(err)
- }
- defer f.Close()
-
- _, err = f.Write([]byte(`example@email.com`))
- if err != nil {
- panic(err)
- }
-
- config := NewConfig(fs, "./", true, rules.Load(""), StringToFormat("yaml"), DefaultTemplate, 5)
- h := NewHunter(config)
- _ = h.Hunt()
-}
-```
-
-
-Example
-
-
-This method accepts json output format as well
-
-```go
-{
- fs := afero.NewMemMapFs()
- f, err := fs.Create("fake.json")
- if err != nil {
- panic(err)
- }
- defer f.Close()
- _, err = f.Write([]byte(`git@github.com:brittonhayes/pillager.git`))
- if err != nil {
- panic(err)
- }
-
- config := NewConfig(fs, ".", true, rules.Load(""), JSONFormat, DefaultTemplate, 5)
- h := NewHunter(config)
- _ = h.Hunt()
-}
-```
-
-
-Example
-
-
-Hunter will also look personally identifiable info in TOML
-
-```go
-{
- fs := afero.NewMemMapFs()
- f, err := fs.Create("fake.toml")
- if err != nil {
- panic(err)
- }
- defer f.Close()
- _, err = f.Write([]byte(`fakeperson@example.com`))
- if err != nil {
- panic(err)
- }
-
- config := NewConfig(fs, ".", true, rules.Load(""), JSONFormat, DefaultTemplate, 5)
-
- h := NewHunter(config)
- _ = h.Hunt()
-}
-```
-
-
-