CLI

The BetterTUI CLI helps you create and manage projects.

Commands

create

npm install bettertui@latest

Install BetterTUI in your project.

dev

pnpm dev

Start the development server with hot reload.

build

pnpm build

Build the project for production.

preview

pnpm preview

Preview the production build.

Configuration

bettertui.config.ts

import { defineConfig } from '@bettertui/core';

export default defineConfig({
  // Theme configuration
  theme: 'default',

  // Renderer options
  renderer: {
    fps: 60,
    dirtyRectDiffing: true,
    debug: false,
  },

  // Build options
  build: {
    target: 'node',
    minify: true,
  },
});

Environment Variables

Variable	Description	Default
BETTERTUI_FPS	Target frame rate	60
BETTERTUI_DEBUG	Enable debug mode	false
BETTERTUI_THEME	Override theme	—

Troubleshooting

Build fails with napi-rs errors

Ensure Rust toolchain is installed:

rustup update stable

Terminal not rendering correctly

Check terminal capabilities:

echo $TERM
echo $COLORTERM

BetterTUI requires a terminal with 256 color support or higher.