Skip to content

CLAUDE.md

Latest commit

 

History

History
128 lines (96 loc) · 4.49 KB

CLAUDE.md

File metadata and controls

128 lines (96 loc) · 4.49 KB

CLI Module

Provides console commands for managing the ADP debug system.

Package

  • Composer: app-dev-panel/cli
  • Namespace: AppDevPanel\Cli\
  • PHP: 8.4+
  • Dependencies: app-dev-panel/kernel, app-dev-panel/api, app-dev-panel/mcp-server, Symfony Console, Symfony Process

Directory Structure

src/
├── Command/
│   ├── DebugServerCommand.php          # Start debug socket server (dev)
│   ├── DebugResetCommand.php           # Clear debug data (debug:reset)
│   ├── DebugServerBroadcastCommand.php # Broadcast test messages (dev:broadcast)
│   ├── DebugQueryCommand.php           # Query stored debug data (debug:query)
│   ├── DebugSummaryCommand.php         # Show brief summary of debug entry (debug:summary)
│   ├── DebugDumpCommand.php            # View dumped objects (debug:dump)
│   ├── DebugTailCommand.php            # Watch entries in real-time (debug:tail)
│   ├── ServeCommand.php                # Start HTTP debug server (serve)
│   ├── McpServeCommand.php             # Start MCP server for AI integration (mcp:serve)
│   ├── FrontendUpdateCommand.php       # Download latest frontend build (frontend:update)
│   ├── InspectConfigCommand.php        # Inspect application config (inspect:config)
│   ├── InspectDatabaseCommand.php      # Inspect database schema/data (inspect:db)
│   └── InspectRoutesCommand.php        # Inspect application routes (inspect:routes)
└── Server/
    └── server-router.php               # Router for built-in PHP server (bootstraps API)
tests/
└── Unit/
    └── Command/
        ├── DebugDumpCommandTest.php
        ├── DebugQueryCommandTest.php
        ├── DebugServerBroadcastCommandTest.php
        ├── DebugServerCommandTest.php
        ├── DebugSummaryCommandTest.php
        ├── DebugTailCommandTest.php
        ├── FrontendUpdateCommandTest.php
        ├── InspectConfigCommandTest.php
        ├── InspectDatabaseCommandTest.php
        ├── InspectRoutesCommandTest.php
        ├── McpServeCommandTest.php
        ├── ResetCommandTest.php
        └── ServeCommandTest.php

Commands

dev — Debug Server

Starts a UDP socket server that listens for real-time debug messages from the application.

php yii dev                         # Default: 0.0.0.0:8890
php yii dev -a 127.0.0.1 -p 9000   # Custom address and port

The server receives and categorizes messages:

  • MESSAGE_TYPE_VAR_DUMPER — Variable dumps
  • MESSAGE_TYPE_LOGGER — Log messages
  • Plain text messages

Handles SIGINT (Ctrl+C) for graceful shutdown.

debug:reset — Clear Debug Data

Stops the debugger and clears all stored debug data.

php yii debug:reset

Calls Debugger::stop() and StorageInterface::clear().

dev:broadcast — Broadcast Test Messages

Sends test messages to all connected debug server clients. Useful for verifying connectivity.

php yii dev:broadcast                    # Default: "Test message"
php yii dev:broadcast -m "Hello world"   # Custom message

Broadcasts in both MESSAGE_TYPE_LOGGER and MESSAGE_TYPE_VAR_DUMPER formats.

debug:query — Query Debug Data

Query stored debug data from the CLI. Subcommands: list, view.

debug:query list                          # List recent entries (default 20)
debug:query list --limit=5                # Limit entries
debug:query list --json                   # Raw JSON output
debug:query view <id>                     # Full entry data
debug:query view <id> -c <CollectorFQCN>  # Specific collector data

Uses CollectorRepositoryInterface to read from storage.

serve — Standalone ADP API Server

Starts a standalone HTTP server using PHP built-in server, serving the ADP API directly.

serve                                              # Default: 127.0.0.1:8888
serve --host=0.0.0.0 --port=9000                   # Custom host/port
serve --storage-path=/path/to/debug/data           # Custom storage
serve --frontend-path=/path/to/built/assets        # Serve frontend

mcp:serve — MCP Server

Starts an MCP (Model Context Protocol) server over stdio, exposing ADP debug data to AI assistants.

mcp:serve --storage-path=/path/to/debug/data    # Required: path to debug storage

Creates FileStorage and McpToolRegistry, then runs McpServer over StdioTransport.

Testing

composer test    # Runs PHPUnit