Skip to main content

Kit Library

@xec-sh/kit provides the terminal UI for Xec's own CLI and works as a standalone library: prompts, spinners, progress bars, tables and a color builder. One runtime dependency (sisteransi). Node.js 18+ and Bun.

npm install @xec-sh/kit

The prompt core is adapted from Clack (MIT).

A Complete Prompt Flow​

import { intro, outro, text, select, confirm, isCancel, spinner } from '@xec-sh/kit';

intro('create-app');

const name = await text({ message: 'Project name?' });
if (isCancel(name)) process.exit(0);   // every prompt returns a cancel symbol on Ctrl-C

const template = await select({
  message: 'Pick a template',
  options: [
    { value: 'ts', label: 'TypeScript' },
    { value: 'js', label: 'JavaScript', hint: 'no build step' },
  ],
});

const ok = await confirm({ message: 'Continue?' });

const s = spinner();
s.start('Installing');
// ... work ...
s.stop('Installed');

outro('Done');

What Is Where​

AreaExportsPage
Input promptstext, multiline, confirm, password, select, multiselect, groupMultiselect, autocomplete, autocompleteMultiselect, selectKey, date, group, isCancelPrompts
Output componentslog, note, box, spinner, progress, tasks, taskLog, intro, outro, cancel, streamComponents
Tablestable, interactiveTable, exportToCSV and other exportersTables
Colors and themeprism, settings, updateSettings, DEFAULT_THEMEColors & Theming

Design Rules​

  • Every prompt is cancellable. Ctrl-C (or Escape) resolves the promise with a cancel symbol instead of throwing; check it with isCancel.
  • One theme, seven roles. Components never hardcode colors — they draw from a theme (accent, activity, success, warning, error, info, muted) that one updateSettings call restyles. See Colors & Theming.
  • Unicode with ASCII fallback. Symbols, spinner frames and borders degrade automatically on terminals without Unicode support.
  • Validation is pluggable. Prompts accept a plain function or any Standard Schema validator (zod, valibot, arktype). See Prompts.

Use in Xec Scripts​

Xec scripts get the kit without installing it — it is available as the kit global and via prism for colors:

// deploy.ts — run with: xec deploy.ts
const env = await kit.select({
  message: 'Deploy where?',
  options: [{ value: 'staging' }, { value: 'production' }],
});

See Also​