Quickstart
GitHound helps you search open-source code, keep useful evidence, and watch incoming GitHub activity for new matches. Use Search for an investigation now and Watchdogs for continued monitoring.
Before you start
Section titled “Before you start”Create an account or sign in. Complete email verification if prompted, then open your workspace. For programmatic access, follow the separate API overview.
Choose a workflow
Section titled “Choose a workflow”| You want to | Start with |
|---|---|
| Find a phrase or code pattern in indexed files | Search |
| Reuse a query later | Saved searches |
| Keep a particular match for review | Saved results |
| Watch incoming changes for a pattern | Watchdogs |
| Read reports and their indicators | Threat intelligence |
Run your first search
Section titled “Run your first search”- Sign in and open Search.
- Enter a distinctive phrase, such as
api.example.com. - Leave Use regex unchecked for a literal search, then select Search.
- Review matches as they arrive. Select a file path to inspect its preview.
- Select Save beside a useful match to keep it in your workspace.
- Open Saved results in the sidebar, then the Saved view to revisit it.
Search is case-sensitive. It searches indexed snapshots, so a match can describe an earlier version of a file.
Keep a query or keep a result
Section titled “Keep a query or keep a result”Save search keeps the query and its regex setting. Reopening it runs the query again.
Save on a match keeps that match’s reference and preview in workspace Results. It does not preserve the entire repository.
Create your first Watchdog
Section titled “Create your first Watchdog”- Open Watchdogs and select New watchdog.
- Add a Match rule with File Content, contains, and a distinctive value.
- Give the monitor a name.
- Choose a daily result cap and whether to receive a first-result email.
- Select Create Watchdog.
Matches from monitored activity appear in the workspace’s Results. Monitoring is asynchronous; creating a Watchdog does not run a historical search.
Understand workspaces
Section titled “Understand workspaces”A workspace groups saved queries, saved code matches, monitoring results, and monitors. Check the current workspace before saving a query or creating a monitor. Search and active-monitor allowances apply across your account, including all workspaces.
Interpret a match
Section titled “Interpret a match”A match shows that text met a query or rule. Review the surrounding context, repository, path, and available commit reference before deciding what it means. A match alone does not establish that a credential works or that a repository is malicious.