Skip to content

raine/tmux-inspect

Repository files navigation

tmux-inspect

A Node.js library for inspecting objects during development using tmux popups and jless.

demo

install

$ npm install --save-dev tmux-inspect

requirements

usage

basic example

import { tmuxJsonPopup } from "tmux-inspect"

const data = await fetchData()
tmuxJsonPopup(data)

When the code executes, a tmux popup opens displaying data in a scrollable, formatted UI powered by jless.

API

tmuxJsonPopup(obj: unknown)

Opens a tmux popup window displaying the given object using jless. The object is serialized to JSON with JSON.serialize. Note that this call blocks program execution until the popup is closed.

tmuxJsonWindow(obj: unknown)

Opens a new tmux window displaying the given object using jless. The object is serialized to JSON with JSON.serialize.

tmuxJsonPopupAll(obj: unknown)

Similar to tmuxJsonPopup, but opening of the popup is deferred to process exit. Multiple calls to this function will collect all objects and display them together in a single popup when the process terminates.

tmuxJsonWindowAll(obj: unknown)

Similar to tmuxJsonWindow, but opening of the window is deferred to process exit. Multiple calls to this function will collect all objects and display them together in a single popup when the process terminates.

tmuxInspectPopup(obj: unknown)

Opens a tmux popup window displaying the object using Node.js's util.inspect().

Useful for inspecting objects that contain values that cannot be serialized to JSON.

tmuxInspectWindow(obj: unknown)

Opens a new tmux window displaying the object using Node.js's util.inspect().

tmuxInspectWindowAll(obj: unknown)

Adds the object to a collection that will be displayed in a new window using util.inspect() when the process exits.

tmuxInspectPopupAll(obj: unknown)

Adds the object to a collection that will be displayed in a popup using util.inspect() when the process exits.

Related projects

  • workmux — Git worktrees + tmux windows for parallel AI agent workflows
  • tmux-bro — Smart tmux session manager that sets up project-specific sessions automatically
  • tmux-file-picker — Pop up fzf in tmux to quickly insert file paths, perfect for AI coding assistants
  • tmux-agent-usage — Display AI agent rate limit usage in your tmux status bar

About

A Node.js library for inspecting objects during development using tmux popups and jless

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors