@adapttable/cli

📖 Documentation · 🚀 Live demo · Get started

The scaffolding CLI for AdaptTable. One command detects your UI kit, picks your package manager, writes a starter table, and tells you exactly what to install.

npx @adapttable/cli init

AdaptTable — detected Mantine.

1. Install the packages:
   pnpm add @adapttable/core @adapttable/mantine @mantine/hooks

2. Scaffolded: src/PeopleTable.tsx

3. Render <PeopleTable /> and you're done.

What it does

• Detects your UI kit from package.json — Mantine, MUI, Chakra, Ant Design, Radix Themes, Base UI, shadcn/ui (via components.json), or Tailwind — falling back to the unstyled adapter.
• Detects your package manager from the lockfile (pnpm / yarn / bun / npm) and prints the right install command — it never installs anything itself; you run the command it shows.
• Scaffolds src/PeopleTable.tsx, a sortable starter table wired to the matching adapter (every AdaptTable feature is one prop away — see the docs). Pass --force to overwrite an existing file.
• One step it can't do for you: wrap your app in the kit's provider (MantineProvider, MUI's ThemeProvider, ChakraProvider, antd's ConfigProvider, Radix's Theme) if it isn't already — that's the most common first-run failure.

Programmatic use

The building blocks are exported and pure (easy to test/automate):

import { detectKit, runInit } from "@adapttable/cli";

detectKit({ "@mui/material": "^6" }).kit; // "mui"

Features

• Detects your UI kit from package.json — Mantine, MUI, Chakra, Ant Design, Radix, Base UI, shadcn/ui (via components.json) or Tailwind.
• Prints the exact install command for the matching adapter plus the peer packages it needs (run it yourself with your package manager).
• Scaffolds a working table wired to your kit, not a blank file: sortable out of the box, with the full AdaptTable feature set (filtering, selection, editing, grouping, saved views, CSV export, virtualization, …) each one prop away.
• Programmatic API — call it from your own scripts, not only the terminal.

See it work

What npx @adapttable/cli init scaffolds, running.

Row grouping — group rows by a column with per-group subtotals

Inline cell editing — double-click a cell; text, number and select editors

Filtering — type a bound and the table answers as you type

Column management — show, hide, reorder, pin and resize

RTL — the whole table mirrors, not just the text

Documentation

Getting started · Live demo · Comparison vs ag-Grid · MUI X · TanStack

• Data — client vs server tiers · pagination & infinite scroll · URL-synced state
• Interaction — filtering · sorting · selection & bulk actions · row expansion · inline cell editing
• Columns — show/hide · reorder · pin · resize · row grouping & aggregates · CSV export
• More — i18n & RTL · virtualization · customization · API · FAQ

License

MIT © Orwa Mahmoud