JezzaHehn
54f32af4a7
`hermes debug share` printed a privacy notice and then uploaded the report to a public paste service in the same breath — the user never got to say yes or no. Add a consent gate: an interactive [y/N] prompt, a --yes/-y flag to skip it, and a hard refusal (exit 1) in non-interactive contexts (no TTY on stdin) so debug data can't be exposed silently in scripts/CI. - New _confirm_upload() helper gates the actual upload after the notice. - Applied to BOTH upload paths: the public paste.rs path and the --nous Nous-S3 path (the latter is a sibling site the original PR missed). - The /debug slash command passes yes=True (typing /debug is itself the consent action, and input() would hang inside prompt_toolkit). - Rewrote the privacy notice for accuracy: secrets (API keys/tokens/ passwords) ARE force-redacted before upload; PII (display name, platform user ID, verbatim message content, filesystem paths) is NOT, and that URL is public. Fixes #22016. Co-authored-by: liuhao1024 <liuhao1024@users.noreply.github.com>
100 lines
3.7 KiB
Python
100 lines
3.7 KiB
Python
"""``hermes debug`` subcommand parser.
|
|
|
|
Extracted verbatim from ``hermes_cli/main.py:main()`` (god-file Phase 2).
|
|
Handler injected to avoid importing ``main``.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import argparse
|
|
from typing import Callable
|
|
|
|
|
|
def build_debug_parser(subparsers, *, cmd_debug: Callable) -> None:
|
|
"""Attach the ``debug`` subcommand to ``subparsers``."""
|
|
# =========================================================================
|
|
# debug command
|
|
# =========================================================================
|
|
debug_parser = subparsers.add_parser(
|
|
"debug",
|
|
help="Debug tools — upload logs and system info for support",
|
|
description="Debug utilities for Hermes Agent. Use 'hermes debug share' to "
|
|
"upload a debug report (system info + recent logs) to a paste "
|
|
"service and get a shareable URL.",
|
|
formatter_class=argparse.RawDescriptionHelpFormatter,
|
|
epilog="""\
|
|
Examples:
|
|
hermes debug share Upload debug report (asks for confirmation)
|
|
hermes debug share --yes Skip confirmation (for scripts/CI)
|
|
hermes debug share --lines 500 Include more log lines
|
|
hermes debug share --expire 30 Keep paste for 30 days
|
|
hermes debug share --local Print report locally (no upload)
|
|
hermes debug share --no-redact Disable upload-time secret redaction
|
|
hermes debug share --nous Upload to Nous-internal storage (private)
|
|
hermes debug delete <url> Delete a previously uploaded paste
|
|
""",
|
|
)
|
|
debug_sub = debug_parser.add_subparsers(dest="debug_command")
|
|
share_parser = debug_sub.add_parser(
|
|
"share",
|
|
help="Upload debug report to a paste service and print a shareable URL",
|
|
)
|
|
share_parser.add_argument(
|
|
"--lines",
|
|
type=int,
|
|
default=200,
|
|
help="Number of log lines to include per log file (default: 200)",
|
|
)
|
|
share_parser.add_argument(
|
|
"--expire",
|
|
type=int,
|
|
default=7,
|
|
help="Paste expiry in days (default: 7)",
|
|
)
|
|
share_parser.add_argument(
|
|
"--local",
|
|
action="store_true",
|
|
help="Print the report locally instead of uploading",
|
|
)
|
|
share_parser.add_argument(
|
|
"-y",
|
|
"--yes",
|
|
action="store_true",
|
|
help=(
|
|
"Skip the confirmation prompt and upload immediately. Required "
|
|
"in non-interactive contexts (scripts/CI); without it, and with "
|
|
"no TTY on stdin, the command refuses rather than upload silently."
|
|
),
|
|
)
|
|
share_parser.add_argument(
|
|
"--no-redact",
|
|
action="store_true",
|
|
help=(
|
|
"Disable upload-time secret redaction (default: redact). Logs "
|
|
"are normally run through agent.redact.redact_sensitive_text "
|
|
"with force=True before upload so credentials are not leaked "
|
|
"into the public paste service."
|
|
),
|
|
)
|
|
share_parser.add_argument(
|
|
"--nous",
|
|
action="store_true",
|
|
help=(
|
|
"Upload the debug bundle to Nous-internal storage (AWS S3) instead "
|
|
"of a public paste service. The bundle is private — viewable only "
|
|
"by Nous staff (and allowlisted Discord mods) via a Google-login-"
|
|
"gated viewer — and auto-deletes after 14 days. Still force-redacts "
|
|
"secrets unless --no-redact is also passed."
|
|
),
|
|
)
|
|
delete_parser = debug_sub.add_parser(
|
|
"delete",
|
|
help="Delete a paste uploaded by 'hermes debug share'",
|
|
)
|
|
delete_parser.add_argument(
|
|
"urls",
|
|
nargs="*",
|
|
default=[],
|
|
help="One or more paste URLs to delete (e.g. https://paste.rs/abc123)",
|
|
)
|
|
debug_parser.set_defaults(func=cmd_debug)
|