-
Notifications
You must be signed in to change notification settings - Fork 51
Daily branch 2025 08 17 #9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
05eb264
feat: implement ratelimit
rossmanko 8058107
feat: add header for signin/signup
rossmanko 6ad5eee
Fix WorkOS client-side import issue
rossmanko d4aaed0
feat: add posthog logging
rossmanko 0bb37f9
refactor: improve README
rossmanko e2019fb
refactor: implement coderabbit suggestions
rossmanko File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,56 +1,61 @@ | ||
| # HackerAI - The AI Pentest Assistant | ||
| # HackerAI | ||
|
|
||
| ## Prerequisites | ||
| _Your AI-Powered Penetration Testing Assistant_ | ||
|
|
||
| Before running the application, you need to obtain API keys for the following services: | ||
| --- | ||
|
|
||
| ### Required API Keys | ||
| ## 🚀 Quick Start | ||
|
|
||
| 1. **OpenRouter API Key** - For LLM (Large Language Model) usage | ||
| - Sign up at [https://openrouter.ai/](https://openrouter.ai/) | ||
| - Get your API key from the dashboard | ||
| - This enables the AI to access various models including Claude, GPT, etc. | ||
| ### 1. Install Dependencies | ||
|
|
||
| 2. **E2B API Key** - For secure sandbox environments | ||
| - Sign up at [https://e2b.dev/](https://e2b.dev/) | ||
| - Get your API key from the dashboard | ||
| - This allows the AI to execute terminal commands and Python code safely in isolated containers | ||
| ```bash | ||
| pnpm install | ||
| ``` | ||
|
|
||
| ## Getting Started | ||
| ### 2. Configure Environment | ||
|
|
||
| 1. **Install dependencies:** | ||
| Create `.env.local` from the example file: | ||
|
|
||
| ```bash | ||
| pnpm i | ||
| ``` | ||
| ```bash | ||
| cp .env.local.example .env.local | ||
| ``` | ||
|
|
||
| 2. **Set up environment variables:** | ||
| - Copy `.env.local.example` to `.env.local` | ||
| - Add the following required configuration: | ||
| ``` | ||
| # OpenRouter API key (Required) | ||
| # Get your API key at: https://openrouter.ai/ | ||
| OPENROUTER_API_KEY=your_openrouter_api_key_here | ||
| ``` | ||
| Add your OpenRouter API key: | ||
|
|
||
| HackerAI can execute terminal commands locally (default) or in sandbox. For sandbox mode, you'll need an E2B API key: | ||
| ```env | ||
| OPENROUTER_API_KEY=your_openrouter_api_key_here | ||
| ``` | ||
|
|
||
| ``` | ||
| # Switch to sandbox mode (optional) | ||
| TERMINAL_EXECUTION_MODE=sandbox | ||
| ### 3. Launch Application | ||
|
|
||
| # E2B API key for sandbox execution | ||
| # Get your API key at: https://e2b.dev/ | ||
| E2B_API_KEY=your_e2b_api_key_here | ||
| ``` | ||
| ```bash | ||
| pnpm dev | ||
| ``` | ||
|
|
||
| 3. **Run the development server:** | ||
| Visit **[http://localhost:3000](http://localhost:3000)** and start your penetration testing journey! 🎯 | ||
|
|
||
| ```bash | ||
| pnpm dev | ||
| ``` | ||
| --- | ||
|
|
||
| 4. **Open the application:** | ||
| - Navigate to [http://localhost:3000](http://localhost:3000) in your browser | ||
| ## 🔑 API Configuration | ||
|
|
||
| The AI assistant is now ready to help with your penetration testing tasks! | ||
| ### Required | ||
|
|
||
| | Service | Purpose | Get API Key | | ||
| | -------------- | ------------------------------ | --------------------------------------- | | ||
| | **OpenRouter** | LLM access (Claude, GPT, etc.) | [openrouter.ai](https://openrouter.ai/) | | ||
|
|
||
| ### Optional - Sandbox Mode | ||
|
|
||
| | Service | Purpose | Get API Key | | ||
| | ------- | ------------------------- | --------------------------- | | ||
| | **E2B** | Secure isolated execution | [e2b.dev](https://e2b.dev/) | | ||
|
|
||
| > 💡 **Default Behavior**: Terminal commands execute locally on your machine | ||
| > 🔒 **Sandbox Mode**: Add E2B key for isolated container execution | ||
|
|
||
| #### Enable Sandbox Mode | ||
|
|
||
| ```env | ||
| TERMINAL_EXECUTION_MODE=sandbox | ||
| E2B_API_KEY=your_e2b_api_key_here | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.