Skip to content

TimBroddin/raybun

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Raybun

A lightweight terminal-based viewer for Ray debug output. An alternative to the Ray desktop app that runs entirely in your terminal.

Experimental - This is an early release. Please report issues!

Raybun Screenshot

Features

  • Full TUI with split-panel layout (payload list + detail view)
  • Syntax highlighting for SQL, JSON, HTML, XML, PHP, JavaScript, CSS
  • Follow mode - automatically scroll to new payloads
  • Search/filter payloads by type, label, content, file, or function
  • Support for all Ray payload types (logs, dumps, queries, exceptions, tables, etc.)
  • Keyboard-driven navigation
  • Works with Laravel Ray, PHP Ray, and any Ray-compatible client

Installation

# Run directly with bunx (no install needed)
bunx raybun-cli

# Or install globally
bun install -g raybun-cli
raybun-cli

# Or clone and run locally
git clone https://github.com/timbroddin/raybun.git
cd raybun
bun install
bun start

Usage

Start Raybun, then send debug output from your Laravel/PHP app:

# Start the viewer (default port 23517)
bunx raybun-cli

# Or specify a custom port
bunx raybun-cli --port 23518

In your Laravel/PHP code:

ray('Hello from Laravel!');
ray($user)->label('Current User');
ray()->table(['name' => 'John', 'email' => 'john@example.com']);
ray()->sql('SELECT * FROM users WHERE active = ?', [true]);
ray()->exception(new Exception('Something went wrong'));

Keyboard Shortcuts

Key Action
/ k Move up
/ j Move down
g Go to top
G Go to bottom (enable follow)
PgUp / PgDn Page up/down
/ / s Search/filter payloads
Esc Clear search
f Toggle follow mode
c Clear all payloads
? / h Show help
q Quit

Configuration

Raybun listens on the same port as the Ray desktop app (23517). To use Raybun instead of Ray:

  1. Close the Ray desktop app
  2. Start Raybun
  3. Your Laravel app will automatically send debug output to Raybun

To use a different port, start Raybun with --port and configure your Laravel app:

// config/ray.php
return [
    'port' => 23518,
];

Requirements

License

MIT

Acknowledgments

  • Spatie for creating Ray and the open Ray protocol
  • Built with Ink for the terminal UI

About

An experimental TUI renderer for Spatie's Ray.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published