From 5ca456e4e2fa61dc5d546c94672f76b62db2daec Mon Sep 17 00:00:00 2001 From: ezl-keygraph Date: Thu, 30 Jul 2026 19:58:27 +0530 Subject: [PATCH] docs: sync provider options in bug report and README (#403) --- .env.example | 4 ++-- .github/ISSUE_TEMPLATE/bug_report.yml | 6 +++++- README.md | 2 +- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/.env.example b/.env.example index 953b33b..e972a1e 100644 --- a/.env.example +++ b/.env.example @@ -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 ------------------------------------------------------------------- diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 68a6043..5032abd 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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 diff --git a/README.md b/README.md index 968ef87..f40b5c5 100644 --- a/README.md +++ b/README.md @@ -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