docs: add local setup notes and runtime requirements - #205
Open
sssudhagar495 wants to merge 2 commits into
Open
Conversation
Document verified macOS configuration: Python 3.12 venv, runtime dependency set (excludes unicorn-dependent angr/pwntools/bcrypt), installed external tools, server run steps, and the verified 100% smart-scan workflow. Add .gitignore for the local venv. Co-Authored-By: Oz <oz-agent@warp.dev>
Natural-language prompt -> local Ollama model (tool-calling) -> HexStrike tool execution (nuclei JSON, tech probe, optional nikto/sqlmap) -> LLM triage pass to reduce false positives. Active scanning gated behind --authorized; defaults to authorized test target. Co-Authored-By: Oz <oz-agent@warp.dev>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Adds local setup documentation and a runtime dependency manifest for running HexStrike on macOS. No application code changes.
Files
SETUP_NOTES.md— verified macOS setup (Python 3.12 venv), install steps, installed external tools, server run/health check, and a verified smart-scan workflow.requirements.runtime.txt— runtime-installable dependency set (excludes the unicorn-dependentangr/pwntools/bcryptthat fail to build in some toolchains)..gitignore— ignore the localhexstrike-env/virtualenv.Notes
Core server + MCP + web/recon functionality is unaffected by the excluded binary-analysis extras.
Conversation: https://app.warp.dev/conversation/d172d1b7-3c09-47f7-a5f5-c463c5eb0013
Co-Authored-By: Oz oz-agent@warp.dev