CalvinBackup/shannon
1
0
Fork 0
mirror of https://github.com/KeygraphHQ/shannon.git synced 2026-08-10 21:40:22 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: sync provider options in bug report and README (#403)

Browse Source
This commit is contained in:
ezl-keygraph
2026-07-30 19:58:27 +05:30
committed by GitHub
parent 1ce250d6a5
commit 5ca456e4e2
3 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.env.example
+2 -2
View File
@@ -9,7 +9,7 @@ SHANNON_AI_MODEL=anthropic:claude-sonnet-4-6
# --- OpenAI ------------------------------------------------------------------
# OPENAI_API_KEY=your-api-key-here
# SHANNON_AI_MODEL=openai:gpt-5.6-sol
# SHANNON_AI_MODEL=openai:gpt-5.5
# --- xAI ---------------------------------------------------------------------
# XAI_API_KEY=your-api-key-here
@@ -35,7 +35,7 @@ SHANNON_AI_MODEL=anthropic:claude-sonnet-4-6
# OpenAI compatible - Chat Completions (default) or Responses:
# OPENAI_API_KEY=your-gateway-key-here
# SHANNON_AI_BASE_URL=https://llm-gateway.example.com/v1
# SHANNON_AI_MODEL=openai:gpt-5.6-sol
# SHANNON_AI_MODEL=openai:gpt-5.5
# SHANNON_AI_OPENAI_FORMAT=responses
# --- Other -------------------------------------------------------------------
.github/ISSUE_TEMPLATE/bug_report.yml
+5 -1
View File
@@ -117,8 +117,12 @@ body:
options:
- "Anthropic (API key)"
- "Anthropic (OAuth token)"
- "Custom base URL (proxy/gateway)"
- "OpenAI"
- "xAI"
- "AWS Bedrock"
- "Custom base URL - Anthropic Messages"
- "Custom base URL - OpenAI Chat Completions"
- "Custom base URL - OpenAI Responses"
validations:
required: true
README.md
+1 -1
View File
@@ -70,7 +70,7 @@ Sample penetration test reports from intentionally vulnerable applications, prod
- **Docker**: required for the worker container.
- **Node.js 18+**: required for the recommended `npx` workflow.
- **AI provider credentials**: Anthropic, OpenAI, xAI, or AWS Bedrock. Claude models are recommended. Gateway and proxy setups are documented separately.
- **AI provider credentials**: Anthropic, OpenAI, xAI, or AWS Bedrock. Claude models are recommended. For suggested model IDs per provider, plus gateways and custom base URLs, see [AI providers](docs/ai-providers.md#suggested-models).
- **Cyber safeguards cleared with your provider**: Anthropic and OpenAI apply real-time safeguards to cyber-security workloads, which can interrupt a scan mid-run. Complete their guidance for legitimate security testers before your first run - see [AI providers](docs/ai-providers.md#cyber-safeguards-do-this-before-your-first-scan).
### Run Shannon