@adapttable/cli

v3.0.1

Published

16 hours ago

Scaffolding and migration CLI for AdaptTable — initialize a table or safely migrate v2 source.

0High
0Medium
0Low

orwa.mahmoud

adapttable cli scaffold data-table init migration codemod

@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.

Requires Node.js 22.12.0 or newer; packed releases are tested on Node 22.12 and Node 24.

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 optional behavior is one feature import 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.

Migrate from v2

npx @adapttable/cli migrate-v3 src
npx @adapttable/cli migrate-v3 src --check

The command moves the 72 adapter-contract imports to @adapttable/react/adapter. Changes that need a behavior choice are reported with their source locations and left untouched. A second run is a no-op.

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 import away.
Migrates v2 source safely — migrate-v3 moves adapter-contract imports to @adapttable/react/adapter and reports every behavior-dependent change for manual review.
Programmatic API — call it from your own scripts, not only the terminal.