StackHawk Documentation StackHawk Logo HawkDocs

No results found

Try different keywords or check your spelling

Search documentation

Find guides, API references, and more

↑ ↓ ↵ esc

Codex

codex plugin marketplace add stackhawk/agent-skills-marketplace
codex plugin add wingman@stackhawk

wingman is the StackHawk umbrella plugin — one install pulls the full skill set (hawkscan, stackhawk-api, data-seed, optimize).

The hawk CLI is a single self-contained binary — hawkop is now bundled in as hawk op, and no separate Java install is required.

brew tap stackhawk/cli && brew trust stackhawk/cli && brew install hawk

Or use the pkg installer or the install script.

Install hawk with the hawk CLI install script, then open a new terminal so it picks up your PATH:

curl -fsSL https://download.stackhawk.com/hawk/install.sh | sh

Download and run the hawk.exe MSI installer from the downloads page — self-contained, no Java required. Or, without administrator access, use the hawk CLI install script, then open a new terminal:

irm https://download.stackhawk.com/hawk/install.ps1 | iex

CMD users: run the cmd.exe version of the install script instead, then open a new terminal:

curl -fsSL -o "%TEMP%\hawk-install.bat" https://download.stackhawk.com/hawk/install.bat && call "%TEMP%\hawk-install.bat"

Then authenticate:

hawk init --browser

hawk init --browser opens your browser to approve access, then provisions and saves your API key automatically — no copy/paste. (On Windows, run hawk.exe init --browser.) Prefer to manage keys yourself? Create one at app.stackhawk.com → Settings → API Keys.

After installation, ask Codex: “What StackHawk skills do you have?”

Ask Codex to scan your application:

Scan my app running on localhost:8080 for security vulnerabilities. Explain each step you take and each decision you make along the way.

Codex will configure HawkScan, run the scan, parse findings, and help you fix them.

  • The agent checks if your app is running and will prompt you to start it if needed
  • For authenticated endpoints, describe your auth pattern and Codex will configure the scan
  • Use hawk validate config stackhawk.yml to debug config issues

Your privacy settings

We use first and third party cookies to ensure that we give you the best experience on our website and in our products.