enola

README

Enola Holmes

This is Sherlock's sister Enola, Modern shiny CLI tool written with Golang to help you: 🔎 Hunt down social media accounts by username across social networks

Install

Minimum go1.23 required.

go install github.com/theyahya/enola/cmd/enola@latest

Usage

enola {username}

Using Docker

Build the image

docker build -t enola .

Run

docker run --rm -it enola {username}

Contributing

You can fork the repository, improve or fix some part of it and then send a pull requests. Or simply open and issue if there's a bug or you have a feature in mind.

License

This software is released under the MIT License.

Documentation

Index

• Constants
• type Enola
  • func New(ctx context.Context) (Enola, error)
  • func (s *Enola) Check(username string) (<-chan Result, error)
  • func (s *Enola) List() map[string]Website
  • func (s *Enola) ListCount() int
  • func (s *Enola) SetSite(site string) *Enola
• type Result
• type Website

Constants

const (
	ErrDataFileIsNotAValidJson = "the data file cannot be read due to invalid JSON format"
	ErrSiteNotFound            = "the requested site is not supported"
)

const RequestTimeout time.Duration = time.Second * 20

Types

type Enola

type Enola struct {
	Data map[string]Website
	Site string
	Ctx  context.Context
}

func New

func New(ctx context.Context) (Enola, error)

func (*Enola) Check

func (s *Enola) Check(username string) (<-chan Result, error)

func (*Enola) List

func (s *Enola) List() map[string]Website

func (*Enola) ListCount

func (s *Enola) ListCount() int

func (*Enola) SetSite

func (s *Enola) SetSite(site string) *Enola

type Result

type Result struct {
	Name  string `json:"name"`
	URL   string `json:"url"`
	Found bool   `json:"found"`
}

type Website

type Website struct {
	ErrorType         string      `json:"errorType"`
	ErrorMessage      interface{} `json:"errorMsg"`
	URL               string      `json:"url"`
	UrlMain           string      `json:"urlMain"`
	UsernameClaimed   string      `json:"username_claimed"`
	UsernameUnclaimed string      `json:"username_unclaimed"`
}