nlproxy/cli/help.py

#!/usr/bin/env python3
"""
NLProxy SDK CLI help module.

This module centralizes the command reference and usage examples for the
NLProxy command-line interface. It is intended for SDK users who want a
single, versioned source of CLI documentation inside the package.

Author: IntelliDeep Labs Team
License: BSL 1.1
"""

from __future__ import annotations

HELP_TEXT = """
NLProxy SDK CLI Reference

Commands:
  download_models    Download or verify required ONNX model files.
  compress           Compress prompts using the NLProxy semantic pipeline.
  runserver          Start the NLProxy FastAPI server.
  tests              Run the NLProxy SDK test suite using pytest.
  help               Show this CLI reference.

Usage:
  python -m nlproxy <command> [options]

Examples:
  python -m nlproxy download_models
  python -m nlproxy compress --input-text "Hola mundo" --format json
  python -m nlproxy runserver --host 0.0.0.0 --port 8000
  python -m nlproxy tests --class TestPromptShield
  python -m nlproxy tests --flow unit

Test filtering:
  --class       Run a specific test class or pytest expression.
  --flow        Run tests by pytest marker/flow (unit, integration, performance, asyncio).
  --pytest-args Pass extra pytest CLI arguments, e.g. "-v --maxfail=1".

Documentation:
  The NLProxy SDK is designed to be used as a library and CLI, with
  versioned commands and clear defaults for model paths and runtime
  configuration.

Environment:
  Use standard environment variables like NLPROXY_HOST, NLPROXY_PORT,
  NLPROXY_MODELS_DIR, NLPROXY_REDIS_URL, OPENAI_API_KEY, GEMINI_API_KEY,
  etc., depending on your deployment.
"""


def print_help() -> None:
    print(HELP_TEXT)