@pi-orca/debug
Debug log viewer and diagnostics overlay
Package details
Install @pi-orca/debug from npm and Pi will load the resources declared by the package manifest.
$ pi install npm:@pi-orca/debug- Package
@pi-orca/debug- Version
0.0.3-dev.20260517154318- Published
- May 17, 2026
- Downloads
- not available
- Author
- binduwavell
- License
- MIT
- Types
- extension
- Size
- 37.2 KB
- Dependencies
- 1 dependency · 0 peers
Pi manifest JSON
{
"extensions": [
"./dist/index.js"
]
}Security note
Pi packages can execute code and influence agent behavior. Review the source before installing third-party packages.
README
pi-orca-debug
Debug log viewer overlay and logging control
Version: 0.0.3-dev
License: MIT
Overview
A diagnostic extension for Pi Orca that controls the shared structured JSONL logger from @pi-orca/core and provides an interactive full-screen overlay for browsing live log entries. Use the /debug slash command to open the log viewer, enable or disable logging, set the minimum log level, and toggle logging on and off. All other Pi Orca extensions use the shared logger instead of console.log, funneling all diagnostic data into a single append-only log file.
Features
Debug Log Viewer Overlay
Run /orca-debug (no arguments) or /orca-debug view to open a full-screen interactive overlay:
- Scrollable log entry list —
SelectListwith fuzzy search - Live polling — Refreshes every 2 seconds to show new entries in real time
- Sort toggle — Press
Rto toggle between newest-first (default) and oldest-first - Metadata expand/collapse — Press
Enteron any entry to expand its metadata block - Selection persistence — Cursor position is preserved across overlay rebuilds (sort toggles, live polls)
- Keybindings:
Key Action ↑/↓Navigate entries EnterExpand/collapse metadata RToggle sort order EscClose overlay
Logging Control
- Enable/disable logging — Toggle logging on and off via
/debug onand/debug off - Configurable log levels — Set minimum log level (
debug,info,warn,error) via/debug set <level> - Autocomplete — Full autocomplete for subcommands and log levels
- Structured JSONL log — All entries include timestamp, level, source, message, and optional metadata
- Log rotation — 10 MB default, keeps 3 rotated files (configurable via
config.yaml)
Defaults
| Setting | Default |
|---|---|
enabled |
false (logging disabled) |
logLevel |
info |
When logging is disabled, all log*() calls are no-ops — nothing is written to disk.
When logging is enabled, only entries at or above the configured log level are written:
| Level | Writes when logLevel is... |
|---|---|
debug |
debug, info, warn, error |
info |
info, warn, error |
warn |
warn, error |
error |
error only |
Log File
Location: ~/.pi/agent/orca/log.jsonl
Entry format:
{"ts":"2026-04-24T10:00:00.000Z","level":"info","source":"pi-orca-tasks","message":"Ready"}
{"ts":"2026-04-24T10:00:01.000Z","level":"debug","source":"pi-orca-models","message":"Resolved alias","meta":{"alias":"fast","resolved":"anthropic/claude-haiku-4-5"}}
Rotation: When the log exceeds 10 MB (configurable), it is rotated to log.jsonl.<ISO-timestamp>. Up to 3 rotated files are kept (configurable).
Configuration
Add to ~/.pi/agent/orca/config.yaml or <project>/.pi/orca/config.yaml:
logging:
enabled: false # disable all logging (default)
logLevel: info # minimum level: debug, info, warn, error
maxFileSizeBytes: 10485760 # 10 MB (default)
maxRotatedFiles: 3 # keep 3 rotated files (default)
Slash Commands
| Command | Description |
|---|---|
/orca-debug |
Open the debug log viewer overlay |
/orca-debug view |
Open the debug log viewer overlay (alias) |
/orca-debug on |
Enable debug logging |
/orca-debug off |
Disable debug logging |
/orca-debug set <level> |
Set minimum log level (debug, info, warn, error) |
Autocomplete
All subcommands and log levels are autocompleted via tab completion:
/orca-debug→ suggestson,off,set,view/orca-debug set→ suggestsdebug,info,warn,error
Architecture
src/
├── index.ts # Extension entry: command registration, autocomplete, handlers
└── overlay.ts # Full-screen debug log viewer overlay with live polling
Logger API
Extensions use the logger from @pi-orca/core instead of console.log:
import { logInfo, logWarn, logError, logDebug, getLogFile } from "@pi-orca/core";
logInfo("pi-orca-tasks", "Ready");
logWarn("pi-orca-models", "Alias not found", { alias: "fast" });
logError("pi-orca-cleanup", "Failed to sweep", { error: "permission denied" });
logDebug("pi-orca-debug", "Loaded 150 entries");
Dependencies
@pi-orca/core— Logger utility, debug config, autocomplete helpers, path resolution, selection persistence@mariozechner/pi-coding-agent— DynamicBorder for overlay framing@mariozechner/pi-tui— SelectList, Container, Text, Spacer for overlay UI
License
MIT License — see LICENSE for details.