Skip to content

Latest commit

 

History

History
 
 

cli

README.md

@codebuff/cli

A Terminal User Interface (TUI) package built with OpenTUI and React.

Installation

bun install

Development

Run the TUI in development mode:

bun run dev

Testing

Run the test suite:

bun test

Interactive E2E Testing

For testing interactive CLI features, install tmux:

# macOS
brew install tmux

# Ubuntu/Debian
sudo apt-get install tmux

# Windows (via WSL)
wsl --install
sudo apt-get install tmux

Then run the proof-of-concept:

bun run test:tmux-poc

Note: When sending input to the CLI via tmux, you must use bracketed paste mode. Standard send-keys drops characters.

# ❌ Broken: tmux send-keys -t session "hello"
# ✅ Works:  tmux send-keys -t session $'\e[200~hello\e[201~'

See tmux.knowledge.md for comprehensive tmux documentation and src/tests/README.md for testing documentation.

Build

Build the package:

bun run build

Run

Run the built TUI:

bun run start

Or use the binary directly:

codebuff-tui

Features

  • Built with OpenTUI for modern terminal interfaces
  • Uses React for declarative component-based UI
  • TypeScript support out of the box