Skip to content

Commit bc9fd7e

Browse files
authored
Merge pull request #150 from AISecurityLab/149-results-on-the-tui-are-stuck
🐛 fix(TUI): fixed the results visulization within the TUI
2 parents e7d7b7a + 29e7a64 commit bc9fd7e

25 files changed

Lines changed: 5106 additions & 2417 deletions

File tree

.github/workflows/docs.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@ name: Build Documentation
22

33
on:
44
push:
5-
branches:
6-
- main
75
paths:
86
- 'docs/**'
97
- 'hackagent/**'

docs/docs/HowTo.md

Lines changed: 10 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -16,40 +16,23 @@ Here's a step-by-step guide to get started with HackAgent. Before doing these st
1616
3. **Target Agent**: A running AI agent to test
1717
4. **Python 3.10+**: For SDK usage
1818

19-
## Choose Your Interface
20-
21-
### SDK (Recommended)
22-
Python SDK with object-oriented interface, automatic authentication, and full feature support.
23-
24-
### CLI
25-
Command-line interface for quick testing without coding.
26-
2719
## 🚀 Quick Start
2820

29-
### Step 1: Set up Environment
21+
### Step 1: Initialize Configuration
3022

31-
Create a `.env` file in your project directory:
23+
Run the interactive setup wizard to configure your API key and preferences:
3224

3325
```bash
34-
HACKAGENT_API_KEY="your-api-key-here"
26+
hackagent init
3527
```
3628

37-
### Install HackAgent
38-
39-
<Tabs>
40-
<TabItem value="uv" label="uv" default>
41-
```bash
42-
uv pip install hackagent
43-
```
44-
</TabItem>
45-
<TabItem value="pip" label="pip">
46-
```bash
47-
pip install hackagent
48-
```
49-
</TabItem>
50-
</Tabs>
51-
52-
### Step 3: Ensure Your Agent is Running
29+
This will guide you through:
30+
1. 🔑 **Enter your API key** — Get yours at [app.hackagent.dev](https://app.hackagent.dev)
31+
2. 🌐 **Configure the base URL** — Default: `https://api.hackagent.dev`
32+
3. 📊 **Set output format** — Choose between `table`, `json`, or `csv`
33+
4. 💾 **Save configuration** — Stored securely for future use
34+
35+
### Step 2: Ensure Your Agent is Running
5336

5437
HackAgent supports multiple agent frameworks:
5538

docs/docs/attacks/advprefix-attacks.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
15
# AdvPrefix Attacks
26

37
AdvPrefix is HackAgent's most sophisticated attack technique, implementing a multi-step pipeline for generating optimized adversarial prefixes that can bypass AI safety mechanisms. This attack type is based on cutting-edge research and provides highly effective jailbreaking capabilities.
@@ -371,7 +375,7 @@ AdvPrefix attacks may exhibit these patterns:
371375

372376
- **[Python SDK Guide](../sdk/python-quickstart.md)** - Complete SDK documentation
373377
- **[Google ADK Integration](../integrations/google-adk.md)** - Framework-specific testing
374-
- **[Getting Started Tutorial](../tutorial-basics/AdvPrefix.md)** - Basic AdvPrefix tutorial
378+
- **[Attack Tutorial](../tutorial-basics/attack-tutorial.md)** - Getting started with attacks
375379
- **[Security Guidelines](../security/responsible-disclosure.md)** - Responsible testing practices
376380

377381
---

0 commit comments

Comments
 (0)