Skip to content

Commit 249281a

Browse files
docs: high-conversion README (hero, quickstart, comparison, CTA)
1 parent 3cf759f commit 249281a

1 file changed

Lines changed: 29 additions & 1 deletion

File tree

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ keyhunt scan . # → prioritized findings in seconds
2222

2323
## Contents
2424

25-
- [Why keyhunt?](#why) · [Features](#features) · [Quick start](#quick-start) · [Example](#example) · [How it compares](#how-it-compares) · [Integrations](#integrations) · [Install anywhere](#install-anywhere) · [Related](#related) · [Contributing](#contributing)
25+
- [Why keyhunt?](#why) · [Features](#features) · [Quick start](#quick-start) · [Example](#example) · [Architecture](#architecture) · [AI stack](#ai-stack) · [How it compares](#how-it-compares) · [Integrations](#integrations) · [Install anywhere](#install-anywhere) · [Related](#related) · [Contributing](#contributing)
2626

2727
<a name="why"></a>
2828
## Why keyhunt?
@@ -71,6 +71,34 @@ $ keyhunt scan .
7171

7272
<div align="right"><a href="#top">↑ back to top</a></div>
7373

74+
<a name="architecture"></a>
75+
## Architecture
76+
77+
```mermaid
78+
flowchart LR
79+
A[Input: file / dir / API] --> B[Collectors]
80+
B --> C[Rules / Analyzers]
81+
C --> D[Scorer]
82+
D --> E{Reporters}
83+
E --> F[Table]
84+
E --> G[JSON / SARIF]
85+
E --> H[MCP tool -. drives .-> AI agents]
86+
```
87+
88+
<div align="right"><a href="#top">↑ back to top</a></div>
89+
90+
<a name="ai-stack"></a>
91+
## Use it from any AI stack
92+
93+
`keyhunt` is interoperable with every popular way of using AI:
94+
95+
- **MCP server**`keyhunt mcp` (Claude Desktop, Cursor, Cognis.Studio, [uncensored-fleet](https://github.com/cognis-digital/uncensored-fleet))
96+
- **OpenAI-compatible / JSON** — pipe `keyhunt scan . --format json` into any agent or LLM
97+
- **LangChain · CrewAI · AutoGen · LlamaIndex** — wrap the CLI/JSON as a tool in one line
98+
- **CI / scripts** — exit codes + SARIF for non-AI pipelines
99+
100+
<div align="right"><a href="#top">↑ back to top</a></div>
101+
74102
<a name="how-it-compares"></a>
75103
## How it compares
76104

0 commit comments

Comments
 (0)