Skip to content

AGENTS.md

Latest commit

 

History

History
49 lines (38 loc) · 3.13 KB

AGENTS.md

File metadata and controls

49 lines (38 loc) · 3.13 KB
Raw

Strix — Agent Guide

Strix is an open-source autonomous AI pentesting tool. This file is for AI coding agents that want to use Strix (run security scans) or contribute to it.

Using Strix from an agent

Install the agent skills for step-by-step workflows:

npx skills add usestrix/strix
  • penetration-testing-with-strix — run a headless pentest against code, URLs, domains, or IPs and read results (covers both run modes below)
  • managed-pentesting-with-strix — drive the managed app.strix.ai platform via REST (no local Docker/LLM needed)
  • fix-security-vulnerabilities-with-strix — remediate findings and re-run Strix to verify
  • ci-security-scanning-with-strix — add PR scanning to CI/CD (self-hosted CLI or managed app)

Two ways to run, same engine — pick per situation:

  • Open-source CLI (self-hosted): free, fully local, BYO LLM key, needs Docker. Best for local dev loops, air-gapped/offline, and full control.

    curl -sSL https://strix.ai/install | bash        # install
export STRIX_LLM="openai/gpt-5.4"                 # any LiteLLM model id
export LLM_API_KEY="<key>"
strix -n -t ./ --scan-mode quick --max-budget 10  # headless scan; always use -n
    • Requires Docker running. Scans take minutes (quick) to hours (deep) — run in the background.
    • Exit codes (headless): 0 clean, 1 fatal error, 2 vulnerabilities found. A 0 only covers what was analyzed — check run.json (status, llm_usage.cost vs the budget) before calling a run clean.
    • Artifacts in strix_runs/<run-name>/: penetration_test_report.md, vulnerabilities/*.md, vulnerabilities.json, findings.sarif (SARIF 2.1.0), run.json.

  • Managed cloud (app.strix.ai): no Docker, no LLM key, no local install; adds team dashboards, scheduling, PR reviews, and downloadable PDF/DOCX reports (Enterprise plan). Best in sandboxed/CI environments and for teams. Use it when local infra isn't available.

    # token from Settings → API Access; register the target as an asset, then:
curl -sS https://app.strix.ai/api/v1/scans -H "Authorization: Bearer $STRIX_API_TOKEN" \
  -H "Content-Type: application/json" -d '{"engagement_type":"live_test","domain_ids":["<uuid>"]}'

  • CLI docs index for LLMs: https://docs.strix.ai/llms.txt (full: https://docs.strix.ai/llms-full.txt).

  • Only scan targets the user is authorized to test.

Contributing to this repo

  • Python 3.12+, managed with uv. Install dev deps: make dev-install.
  • Lint/format/type-check/security, all in one: make check-all (ruff, mypy, bandit).
  • Tests: uv run pytest.
  • Run from source: uv run strix --target <target>.
  • Layout: strix/agents (agent graph + prompts), strix/tools (proxy, browser, terminal, scanners), strix/runtime (Docker sandbox), strix/report (findings, SARIF), strix/skills (internal knowledge packs the pentest agents load — different from the consumer skills in skills/), strix/interface (CLI/TUI), containers/ (sandbox image).
  • Pre-commit hooks: make pre-commit (or uv run pre-commit install).