About this project

tmux.ts is a programmatic interface for the tmux CLI designed for JavaScript runtimes. It provides a TypeScript API to execute common tmux workflows, wrapping 46 tmux commands with typed options and results, including session management, window and pane manipulation, and buffer operations. The library offers three distinct entry points to accommodate different development preferences: - A standalone Promise-based API for Node-compatible runtimes. - A Promise-based API specifically optimized for Bun platform services. - An Effect-native API for users of the Effect ecosystem, providing a TmuxClient service with tagged errors and layer support. Requirements include a tmux binary version 3.4 or newer. The package is ESM-only and allows for custom executable paths and socket configurations.