README

See through the surface of your queues.

Agent-first CLI observability for Symfony Messenger and Symfony Scheduler.

Overview

PeriscopeBundle records every Messenger message and Scheduler run that flows through your Symfony application and exposes them through a suite of bin/console periscope:* commands. Output is designed to be:

• Machine-friendly by default (compact tabular text when piped), so coding agents and scripts can consume it cheaply;
• Human-friendly on demand (rich tables, colors) when run in an interactive terminal;
• Strictly structured via --format=ndjson|json|yaml for pipelines.

No web UI. No prompts. No surprises.

Requirements

• PHP 8.4+
• Symfony 7.4 LTS or 8.x
• Doctrine DBAL 3.8+ or 4.x
• A database supported by the Doctrine storage backend (PostgreSQL recommended, MySQL/MariaDB, SQLite)

Installation

composer require yoanbernabeu/periscope-bundle
php bin/console periscope:install

CLI commands

Every command supports --format=auto|compact|pretty|json|ndjson|yaml. auto picks pretty on a TTY and compact otherwise, which is what agents and pipes expect.

Status

Early development — the bundle is not yet functional. The product definition lives in PRD.md; releases are tracked in CHANGELOG.md.

Development

A local Symfony application with Postgres running in Docker is used to exercise the bundle end-to-end. The scaffold lives under playground/ and is intentionally not committed — each contributor generates it locally. See docs/DEVELOPMENT.md once it is in place.

Quality tooling:

composer ci          # full pipeline (cs, phpstan, phpunit)
composer phpstan     # PHPStan at max level
composer cs          # PHP-CS-Fixer (dry-run)
composer cs-fix      # apply style fixes
composer test        # PHPUnit

License

MIT — see LICENSE.