This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

CLI-Referenz

Die folgenden Angaben wurden gegen das mit make build erzeugte Binary build/private-proxy-mcp geprüft.

Gemeinsame Syntax

private-proxy-mcp [--config PATH] [--log-level LEVEL] [--log-format FORMAT] COMMAND

Option	Default	Bedeutung
--config PATH	keine	explizite YAML-, JSON- oder TOML-Datei; muss existieren
--log-level	info	debug, info, warn oder error
--log-format	json	json oder text
--help	–	Hilfe für Root oder Unterbefehl

Ohne --config wird eine vorhandene private-proxy-mcp.yaml (alternativ .yml, .json oder .toml) im aktuellen Arbeitsverzeichnis gelesen. Eine fehlende Default-Datei ist kein Fehler. Die Utility-Befehle update, version und setup-help lesen keine Config und scheitern daher nicht an einer kaputten Datei im Arbeitsverzeichnis.

mcp-server

Startet MCP Streamable HTTP und den Reverse-Connector-Listener im selben Prozess:

build/private-proxy-mcp --config /etc/private-proxy-mcp/server.yaml mcp-server

Flag	Default
--mcp-listen-address	127.0.0.1:9334
--mcp-endpoint	/mcp
--mcp-allowed-origins	leer
--mcp-read-header-timeout	10s
--mcp-idle-timeout	2m
--mcp-shutdown-timeout	10s
--mcp-max-header-bytes	1048576
--private-proxy-listen-address	0.0.0.0:9335
--private-proxy-identity	default
--private-proxy-shared-key	leer, aber zum Start erforderlich

Mehrere Origins werden als wiederholtes Flag oder kommasepariert angegeben:

build/private-proxy-mcp mcp-server \
  --mcp-allowed-origins=https://client.example \
  --private-proxy-shared-key="$CONNECTOR_KEY"

Die Datei-/Environment-Optionen mcp.tls_terminated_by_proxy und mcp.trusted_proxy_cidrs haben bewusst kein CLI-Flag.

private-proxy

Startet den ausgehenden Connector und die lokale HTTP-Ausführung:

build/private-proxy-mcp --config /etc/private-proxy-mcp/proxy.yaml private-proxy

Flag	Default
--private-proxy-connector-url	https://localhost:9335/connector
--private-proxy-identity	default
--private-proxy-shared-key	leer, aber zum Start erforderlich
--private-proxy-tls-ca-file	leer/System-Truststore
--private-proxy-tls-server-name	leer/Hostname der URL
--private-proxy-insecure-skip-verify	false
--private-proxy-allow-insecure-http	false
--private-proxy-handshake-timeout	10s
--private-proxy-ping-interval	30s
--private-proxy-pong-timeout	10s
--private-proxy-drain-timeout	10s
--private-proxy-reconnect-delay	100ms
--private-proxy-backoff-initial	250ms
--private-proxy-backoff-max	30s
--private-proxy-backoff-jitter	0.2
--runtime-connect-timeout	10s

--private-proxy-allow-insecure-http erlaubt nur die URL-Prüfung; es macht Klartext nicht sicher. --private-proxy-insecure-skip-verify deaktiviert die Zertifikatsprüfung. Beide Optionen sind ausschließlich für isolierte Entwicklungsumgebungen vorgesehen und erzeugen Warnungen.

Rust-Alternative mit derselben Config-Datei:

cargo run -p private-proxy-rs --manifest-path proxy-rs/Cargo.toml -- --config ./config.yaml

Tauri-Debug-UI: make desktop-dev (siehe Desktop-Proxy).

update

Prüft das neueste Forgejo-Release unter https://repository.hildebrandt.io/ai-tools/private-proxy-mcp/releases und ersetzt das laufende Binary in place. Vor dem Ersetzen wird die SHA-256-Summe aus checksums.txt geprüft. Das passende Archiv wird anhand von OS und Architektur gewählt (Linux amd64/arm64, macOS arm64, Windows amd64).

build/private-proxy-mcp update
build/private-proxy-mcp update --check
build/private-proxy-mcp update --force

Flag	Bedeutung
--check	nur melden, ob ein Update verfügbar ist; nichts installieren
--force	auch bei gleicher Version erneut herunterladen und installieren

dev-, unknown- und *-dirty-Builds gelten immer als updatebedürftig. Der Befehl benötigt Schreibrechte am Installationspfad des Binarys.

setup-help

Gibt einen selbstständigen Agenten-Prompt auf stdout aus. Damit kann ein Agent auf dem Private-Proxy-Host Dependencies installieren und die Config prüfen (yt-dlp, optional ffmpeg, headless Chromium, optional Playwright-Sidecar mit playwright-core, Connector-Keys, http.network_policy). Es wird nichts automatisch installiert oder geschrieben.

build/private-proxy-mcp setup-help
build/private-proxy-mcp setup-help --platform all

Flag	Default	Bedeutung
--platform	auto	auto (aktuelles OS), darwin, linux, windows oder all

Weitere Befehle

build/private-proxy-mcp version
build/private-proxy-mcp completion bash
build/private-proxy-mcp completion zsh

version gibt version=… commit=… build_time=… aus. Release-Builds setzen diese Werte über Linker-Flags. Auch make build ermittelt sie aus Git; nur ein direkter go build ohne die Buildskripte zeigt die eingebauten Fallbackwerte.

Beenden und Exit-Verhalten

SIGINT und SIGTERM lösen einen geordneten Shutdown aus. Konfigurations-, Listen-, TLS- und Startfehler führen zu einem Fehler auf stderr und einem Exit-Code ungleich null. Secrets werden nicht in Help, Fehlern oder Logs ausgegeben.