Skip to content

Added .gitignore and improve README installation instructions #82

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.

Sign up for GitHub

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

Open
alfonsoalongi wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Added .gitignore and improve README installation instructions #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
321c26f
Added .gitignore to prevent generated files from being seen by git as…
alfonsoalongi Oct 1, 2025
7cea494
Improve README installation wording about tool permissions
alfonsoalongi Oct 1, 2025
12a9c9d
Update .gitignore
alfonsoalongi Oct 1, 2025
218cc64
Update README.md mcp server command
alfonsoalongi Oct 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
bin/
hexstrike-env/
__pycache__/
.vscode/
*.log
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ graph TD
## Installation

### Quick Setup to Run the hexstrike MCPs Server
Many tools, such as nmap, require elevated privileges for certain features. To avoid granting permissions to each tool individually, perform the setup steps below as the `root` user.

```bash
# 1. Clone the repository
Expand Down Expand Up @@ -221,7 +222,7 @@ Edit `~/.config/Claude/claude_desktop_config.json`:
{
"mcpServers": {
"hexstrike-ai": {
"command": "python3",
"command": "/path/to/hexstrike-ai/hexstrike-env/bin/python3",
"args": [
"/path/to/hexstrike-ai/hexstrike_mcp.py",
"--server",
Expand Down