tty-table
A TypeScript-first terminal table renderer with a compatibility-oriented factory API.
Examples
See here for complete example list
To view all example output:
$ git clone https://github.com/tecfu/tty-table && cd tty-table && npm i
$ npm run view-examples
Terminal (Static)
examples/styles-and-formatting.js
Terminal (Streaming)
$ node examples/data/fake-stream.js | tty-table --format json --header examples/config/header.js
- See the built-in help for the terminal version of tty-table with:
$ tty-table -h
MCP server
Expose tty-table to MCP clients (Claude, IDE agents, Cursor, etc.) over stdio.
Client configuration
{
"mcpServers": {
"tty-table": {
"command": "npx",
"args": ["-y", "--package=tty-table", "tty-table-mcp"]
}
}
}
Tools
Arguments for render_table:
Example tool call:
{
"header": [{ "value": "name" }, { "value": "score", "align": "right" }],
"rows": [["Ada", 100], ["Grace", 98]],
"options": { "width": 40 }
}
Rendered result:
┌───────┬───────┐
│ name │ score │
├───────┼───────┤
│ Ada │ 100 │
├───────┼───────┤
│ Grace │ 98 │
└───────┴───────┘
Additional tools may be added in future releases under the same MCP server.
Browser & Browser Console
The published package ships a standalone IIFE bundle that exposes a TtyTable global. Load it directly from a CDN — no install or build step required:
<script src="https://cdn.jsdelivr.net/npm/tty-table@7/dist/browser/tty-table.global.js"></script>
<script>
const Table = TtyTable.default
console.log(Table([{ value: "name" }, { value: "score" }], [["Ada", 100]], null).render())
</script>
- Try it online before installing: live example on JSFiddle
- View the full example locally in Chrome or Chromium by opening examples/browser-example.html (e.g. served with
npx serve .or any static file server). - source: examples/browser-example.html
Compatibility
Node.js
Current releases require Node.js 22 or newer. This is a breaking change from the Node 20 baseline used by early v6 releases (and from the v5 line, which supported older Node.js releases). The floor was raised to match smartwrap@4 / [email protected]. If your application must remain on Node 20, stay on a prior tty-table release until you can upgrade.
The published package provides both ESM and CommonJS entry points for Node.js. The CLI requires Node.js 22+ as well.
API
import Table from "tty-table"
const table = Table(
[{ value: "name" }, { value: "score", align: "right" }],
[
{ name: "Ada", score: 100 },
{ name: "Grace", score: 98 }
],
{ borderStyle: "solid" }
)
console.log(table.render())
Legacy Table(header, rows, footer, options) and Table(rows, options) construction remains supported.
Formatter context
New code can use the explicit context form:
const formatter = (value: unknown) => String(value).toUpperCase()
The compatibility callback signature is still accepted. New integrations should prefer a formatter that accepts the documented context object and avoid relying on dynamic this mutation.
Width semantics
Widths are measured in terminal display columns, not JavaScript string length. ANSI escape sequences are ignored for measurement; Unicode code points are counted using breakword.width() (Unicode 18.0.0 East Asian Width + UAX #51 Emoji_Presentation). Wrapping and truncation operate on the same display-width semantics.
Compared with older releases that used wcwidth, some symbols that were previously treated as 1 cell are now 2 cells (for example ⚡ U+26A1). Tables containing those characters may reflow slightly; measurement is now aligned with the same library used for wrapping.
Development
npm install
npm run typecheck
npm run build
npm test
npm run test:unit
npm run lint
