帮助与常见问题

查找关于 Seaworthy、许可证和故障排除的常见问题解答。

1

运行交互式设置向导 — 它将在一个流程中引导您完成许可证密钥和 LLM 提供商的配置。

npx seaworthycode setup
2
当提示时,粘贴您的许可证密钥(格式:SW-XXXXXX)。您可以在购买确认邮件中找到它。
3

如需稍后更新密钥而无需重新运行向导,请使用:

npx seaworthycode config set licenseKey SW-XXXXXX

Pro 检测使用您自己的 API 密钥 — Seaworthy 不会向您收取 AI 使用费。

1

运行设置向导。如果您已运行过,请再次运行以更新 LLM 设置。

npx seaworthycode setup
2
选择您的提供商并在提示时粘贴您的 API 密钥。支持:Anthropic(Claude)、OpenAI、Gemini、DeepSeek、Kimi、MiniMax、Ollama 和 OpenRouter。
3

偏好环境变量?在扫描前导出您的密钥:

ANTHROPIC_API_KEY=sk-... npx seaworthycode .
OPENAI_API_KEY=sk-... npx seaworthycode .
1
在收件箱中搜索来自 [email protected] 的邮件。检查垃圾邮件和推广邮件文件夹。
2

重新发送密钥

输入您购买 Seaworthy 时使用的电子邮箱地址。

3
提交支持工单,我们将直接为您提供帮助。

您可以按严重程度或 Seaworthy 的置信度来过滤结果。使用 --min-severity 隐藏低于某个风险级别的所有内容,或使用 --min-confidence 隐藏扫描器不确定的结果。一个好的起点是中等严重程度和高置信度。

npx seaworthycode . --min-severity medium --min-confidence high

默认情况下,Seaworthy 会折叠低严重程度的结果以保持输出可读。在命令中添加 --all,所有结果将完整显示。

npx seaworthycode . --all

首先,使用 --baseline save 保存当前结果的快照。在未来的扫描中,添加 --baseline 不带值 — Seaworthy 将只报告自该快照以来的新内容。

npx seaworthycode . --baseline save

npx seaworthycode . --baseline

在扫描命令中添加 --fail-on-findings。如果报告了任何结果,Seaworthy 将以代码 5 退出,大多数 CI 系统将其视为构建失败。没有此标志时,Seaworthy 始终成功退出。

npx seaworthycode . --fail-on-findings

使用 --output 保存可与团队分享的独立 HTML 报告。使用 --json 获取可管道传输到其他工具或保存到文件的机器可读输出。

npx seaworthycode . --output report.html

npx seaworthycode . --json > results.json

使用 --sarif 生成 GitHub Advanced Security、VS Code 和大多数 SAST 平台可以导入的 SARIF 文件。如果您希望直接管道传输输出,请使用 --sarif-stdout。

npx seaworthycode . --sarif results.sarif

npx seaworthycode . --sarif-stdout

Seaworthy 会读取它能找到的每个文件,对于包含大型生成或编译文件的大型存储库,这可能很慢。使用 --max-file-size 设置字节大小限制 — 超过该大小的文件将被跳过。

npx seaworthycode . --max-file-size 500000

可以。Seaworthy 支持 Anthropic、OpenAI、Gemini、DeepSeek、Kimi、MiniMax、Ollama 和 OpenRouter。添加 --provider 以及提供商名称,并确保通过设置向导或环境变量配置了相应的 API 密钥。

npx seaworthycode . --provider openai

Kimi 实际上是三个独立的产品,各自拥有独立的账户和 API 密钥,彼此不能通用:国际版 Moonshot 开放平台(platform.kimi.ai)— 使用 --provider kimi;中国大陆版 Moonshot(platform.kimi.com)— 使用 --provider kimi-cn;以及 Kimi Code(kimi.com/code)— 使用 --provider kimi-code。请在对应网站创建密钥,然后通过设置向导或环境变量进行配置。

npx seaworthycode . --provider kimi-code

在扫描命令中添加 --debug。这将启用详细日志记录,以便您可以看到哪些检查运行了、发现了什么以及错误发生在哪里。它还会在输出中显示检查 ID。

npx seaworthycode . --debug

在扫描命令中添加 --show-ids。每个结果都将在检查名称旁边包含其检查 ID,以便您可以在工单、抑制注释或团队 Wiki 中精确引用它。

npx seaworthycode . --show-ids

仍然需要帮助?

我们的支持团队通常在一个工作日内回复。

提交工单