🔍 Code Extractor

Displays help information for Vice AI Development Tools, listing available commands and usage examples.

Purpose

This function serves as a command-line help interface for a development tools script. It prints formatted documentation showing available commands (clear, check, touch, info) with their descriptions and example usage patterns. It's designed to guide developers on how to use the dev_tools.py script for managing browser cache, checking static files, and server cache operations.

Source Code

def print_help():
    """Print help information"""
    print("🛠️  Vice AI Development Tools")
    print()
    print("Commands:")
    print("  clear  - Show browser cache clearing instructions")
    print("  check  - Check static file status and server cache info") 
    print("  touch  - Touch static files to force cache refresh")
    print("  info   - Check server debug cache information")
    print()
    print("Examples:")
    print("  python dev_tools.py check")
    print("  python dev_tools.py touch")
    print("  python dev_tools.py clear")

Return Value

This function returns None (implicit). It performs a side effect of printing help text to stdout.

Usage Example

# Direct function call
print_help()

# Output:
# 🛠️  Vice AI Development Tools
#
# Commands:
#   clear  - Show browser cache clearing instructions
#   check  - Check static file status and server cache info
#   touch  - Touch static files to force cache refresh
#   info   - Check server debug cache information
#
# Examples:
#   python dev_tools.py check
#   python dev_tools.py touch
#   python dev_tools.py clear

Best Practices

• This function has no parameters and is meant to be called directly when help is needed
• The function uses print statements for output, so it writes directly to stdout
• This is a pure side-effect function with no return value
• Typically called when no arguments are provided to the script or when a help flag is used
• The emoji (🛠️) may not display correctly in all terminal environments

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• function main_v52 60.5% similar

  A command-line interface (CLI) entry point that parses command-line arguments and dispatches to various development tool functions for managing browser cache, static files, and debug endpoints.

  From: /tf/active/vicechatdev/vice_ai/dev_tools.py

• function clear_browser_cache_instructions 55.1% similar

  A utility function that prints formatted instructions to the console for clearing browser cache across different web browsers and operating systems.

  From: /tf/active/vicechatdev/vice_ai/dev_tools.py

• function main_v68 45.0% similar

  A debugging utility function that analyzes and displays execution tracking information for a specific session in a statistical analysis service.

  From: /tf/active/vicechatdev/full_smartstat/debug_execution_tracking.py

• function check_debug_endpoint 44.8% similar

  Queries a debug endpoint to retrieve and display cache information from a web server, including debug mode status, cache buster values, and static file versions.

  From: /tf/active/vicechatdev/vice_ai/dev_tools.py

• function main_v24 44.2% similar

  Interactive CLI function that allows users to select and run document processing test scenarios with varying document counts, providing feedback on test success and next steps.

  From: /tf/active/vicechatdev/contract_validity_analyzer/test_real_documents.py