Skip to content

Commit 111e01a

Browse files
committed
🎨 style(README): Adding the app and api to the README file
1 parent 282554f commit 111e01a

File tree

10 files changed

+24
-23
lines changed

10 files changed

+24
-23
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88

99
<br>
1010

11-
[Web App][https://app.hackagent.dev/] -- [Docs][https://docs.hackagent.dev/] -- [API][https://api.hackagent.dev/schema/redoc]
11+
[App](https://app.hackagent.dev/) -- [Docs](https://docs.hackagent.dev/) -- [API](https://api.hackagent.dev/schema/redoc)
12+
1213

1314
<br>
1415

docs/docs/HowTo.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ sidebar_position: 2
44

55
# How To Use HackAgent
66

7-
Here's a step-by-step guide to get started with HackAgent. Before doing these steps, ensure you have an account and an API key from [hackagent.dev](https://hackagent.dev).
7+
Here's a step-by-step guide to get started with HackAgent. Before doing these steps, ensure you have an account and an API key from [app.hackagent.dev](https://app.hackagent.dev).
88

99
## 📋 Prerequisites
1010

11-
1. **HackAgent Account**: Sign up at [hackagent.dev](https://hackagent.dev)
11+
1. **HackAgent Account**: Sign up at [app.hackagent.dev](https://app.hackagent.dev)
1212
2. **API Key**: Generate an API key from your dashboard
1313
3. **Target Agent**: A running AI agent to test (Google ADK, LiteLLM, etc.)
1414
4. **Development Environment**: Choose your preferred approach:
@@ -145,7 +145,7 @@ print("Security test completed! Check your dashboard for detailed results.")
145145

146146
### Step 5: Explore the HackAgent Dashboard
147147

148-
1. Navigate to [hackagent.dev/stats](https://hackagent.dev/stats)
148+
1. Navigate to [app.hackagent.dev](https://app.hackagent.dev)
149149
2. Select your recent test run
150150
3. Check the **"Output"** tab to see which prompts were most effective
151151
4. Review the **"Results"** section for vulnerability analysis

docs/docs/cli/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ hackagent config show
6868
hackagent config set --api-key YOUR_API_KEY
6969

7070
# Set base URL
71-
hackagent config set --base-url https://hackagent.dev
71+
hackagent config set --base-url https://api.hackagent.dev
7272

7373
# Set default output format
7474
hackagent config set --output-format json
@@ -162,7 +162,7 @@ Default location: `~/.hackagent/config.json`
162162
```json
163163
{
164164
"api_key": "your-api-key-here",
165-
"base_url": "https://hackagent.dev",
165+
"base_url": "https://api.hackagent.dev",
166166
"output_format": "table",
167167
"verbose": 0
168168
}
@@ -173,7 +173,7 @@ Default location: `~/.hackagent/config.json`
173173
| Variable | Description | Example |
174174
|----------|-------------|---------|
175175
| `HACKAGENT_API_KEY` | Your API key | `export HACKAGENT_API_KEY=abc123` |
176-
| `HACKAGENT_BASE_URL` | API base URL | `export HACKAGENT_BASE_URL=https://hackagent.dev` |
176+
| `HACKAGENT_BASE_URL` | API base URL | `export HACKAGENT_BASE_URL=https://api.hackagent.dev` |
177177
| `HACKAGENT_OUTPUT_FORMAT` | Default output format | `export HACKAGENT_OUTPUT_FORMAT=json` |
178178
| `HACKAGENT_DEBUG` | Enable debug mode | `export HACKAGENT_DEBUG=1` |
179179

docs/docs/integrations/google-adk.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ agent = HackAgent(
3030
name="multi_tool_agent", # Your ADK app name
3131
endpoint="http://localhost:8000", # ADK server endpoint
3232
agent_type=AgentTypeEnum.GOOGLE_ADK,
33-
base_url="https://hackagent.dev" # HackAgent platform URL
33+
base_url="https://api.hackagent.dev" # HackAgent platform URL
3434
)
3535
```
3636

@@ -187,7 +187,7 @@ agent = HackAgent(
187187
```bash
188188
# Required for ADK testing
189189
export HACKAGENT_API_KEY="your_api_key"
190-
export HACKAGENT_API_BASE_URL="https://hackagent.dev"
190+
export HACKAGENT_API_BASE_URL="https://api.hackagent.dev"
191191
export AGENT_URL="http://localhost:8001"
192192

193193
# Optional: External model endpoints
@@ -281,7 +281,7 @@ agent = HackAgent(
281281

282282
Security test results are automatically uploaded to the HackAgent platform:
283283

284-
1. Visit [hackagent.dev/dashboard](https://hackagent.dev/dashboard)
284+
1. Visit [app.hackagent.dev](https://app.hackagent.dev)
285285
2. Navigate to your organization's results
286286
3. Review detailed attack outcomes and recommendations
287287

docs/docs/integrations/openai-sdk.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ OpenAI SDK is the official Python library for interacting with OpenAI's API, inc
99
1. **OpenAI API Key**: Get your API key from [platform.openai.com](https://platform.openai.com)
1010
2. **HackAgent SDK**: Install with `pip install hackagent`
1111
3. **OpenAI SDK**: Automatically installed with HackAgent
12-
4. **HackAgent API Key**: Get from [hackagent.dev](https://hackagent.dev)
12+
4. **HackAgent API Key**: Get from [app.hackagent.dev](https://app.hackagent.dev)
1313

1414
### Environment Variables
1515

@@ -209,7 +209,7 @@ except Exception as e:
209209

210210
## 🔄 Next Steps
211211

212-
1. Review results on your [HackAgent Dashboard](https://hackagent.dev/stats)
212+
1. Review results on your [HackAgent Dashboard](https://app.hackagent.dev)
213213
2. Try different models and configurations
214214
3. Test with custom attack goals specific to your use case
215215
4. Implement fixes and re-test

docs/docs/sdk/python-quickstart.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ from hackagent.models import AgentTypeEnum
9595

9696
### Get Your API Key
9797

98-
1. Visit [hackagent.dev](https://hackagent.dev)
98+
1. Visit [app.hackagent.dev](https://app.hackagent.dev)
9999
2. Sign up or log in to your account
100100
3. Navigate to **Settings****API Keys**
101101
4. Click **Generate New Key**
@@ -121,7 +121,7 @@ agent = HackAgent(
121121
name="my_test_agent",
122122
endpoint="http://localhost:8000", # Your agent's endpoint
123123
agent_type=AgentTypeEnum.GOOGLE_ADK,
124-
base_url="https://hackagent.dev", # HackAgent API base URL
124+
base_url="https://api.hackagent.dev", # HackAgent API base URL
125125
api_key="your_api_key_here" # Optional: pass directly
126126
)
127127
```
@@ -139,7 +139,7 @@ agent = HackAgent(
139139
name="multi_tool_agent",
140140
endpoint="http://localhost:8000", # Your agent's URL
141141
agent_type=AgentTypeEnum.GOOGLE_ADK,
142-
base_url="https://hackagent.dev" # HackAgent platform URL
142+
base_url="https://api.hackagent.dev" # HackAgent platform URL
143143
)
144144

145145
# Configure the attack
@@ -444,7 +444,7 @@ Set up your environment properly:
444444
```bash
445445
# Required environment variables
446446
export HACKAGENT_API_KEY="your_api_key"
447-
export HACKAGENT_API_BASE_URL="https://hackagent.dev"
447+
export HACKAGENT_API_BASE_URL="https://api.hackagent.dev"
448448

449449
# Optional: Agent endpoint
450450
export AGENT_URL="http://localhost:8001"
@@ -462,7 +462,7 @@ The attack returns structured results that are automatically sent to the HackAge
462462
results = agent.hack(attack_config=attack_config)
463463

464464
# Results are automatically uploaded to the platform
465-
# Access your results at https://hackagent.dev/dashboard
465+
# Access your results at https://app.hackagent.dev
466466
```
467467

468468
## 🧪 Development Setup

docs/static/img/banner.png

-3.09 MB
Binary file not shown.

examples/openai_sdk/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ python hack.py
110110

111111
## Viewing Results
112112

113-
After running the tests, view your results at: [https://hackagent.dev](https://hackagent.dev)
113+
After running the tests, view your results at: [https://app.hackagent.dev](https://app.hackagent.dev)
114114

115115
## Best Practices
116116

hackagent/cli/main.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ def cli(ctx, config_file, api_key, base_url, verbose, output_format):
9494
HACKAGENT_BASE_URL API base URL (default: https://api.hackagent.dev)
9595
HACKAGENT_DEBUG Enable debug mode
9696
97-
Get your API key at: https://hackagent.dev
97+
Get your API key at: https://app.hackagent.dev
9898
"""
9999
ctx.ensure_object(dict)
100100

@@ -157,7 +157,7 @@ def init(ctx):
157157
# API Key setup
158158
console.print("[cyan]📋 API Key Configuration[/cyan]")
159159
console.print(
160-
"Get your API key from: [link=https://hackagent.dev]https://hackagent.dev[/link]"
160+
"Get your API key from: [link=https://app.hackagent.dev]https://app.hackagent.dev[/link]"
161161
)
162162

163163
current_key = cli_config.api_key
@@ -258,7 +258,7 @@ def version(ctx):
258258

259259
console.print()
260260
console.print(
261-
"[dim]For more information: [link=https://hackagent.dev]https://hackagent.dev[/link]"
261+
"[dim]For more information: [link=https://docs.hackagent.dev]https://docs.hackagent.dev[/link]"
262262
)
263263

264264

@@ -476,7 +476,7 @@ def _display_welcome():
476476
5. View results: [cyan]hackagent results list[/cyan]
477477
478478
[bold blue]💡 Need help?[/bold blue] Use '[cyan]hackagent --help[/cyan]' or '[cyan]hackagent COMMAND --help[/cyan]'
479-
[bold blue]🌐 Get your API key at:[/bold blue] [link=https://hackagent.dev]https://hackagent.dev[/link]"""
479+
[bold blue]🌐 Get your API key at:[/bold blue] [link=https://app.hackagent.dev]https://app.hackagent.dev[/link]"""
480480

481481
panel = Panel(
482482
welcome_text, title="🔍 HackAgent CLI", border_style="red", padding=(1, 2)

hackagent/cli/tui/tabs/config.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ def _reset_config(self) -> None:
219219
self.cli_config.default_config_path.unlink()
220220

221221
# Reset to defaults
222-
self.cli_config.base_url = "https://hackagent.dev"
222+
self.cli_config.base_url = "https://api.hackagent.dev"
223223
self.cli_config.output_format = "table"
224224
self.cli_config.api_key = None
225225

0 commit comments

Comments
 (0)