# @expcat/tigercat-cli

> CLI tooling for Tigercat UI library — project scaffolding, component generation, and more

Latest version **2.9.3** (published 2026-09-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install @expcat/tigercat-cli
pnpm add @expcat/tigercat-cli
yarn add @expcat/tigercat-cli
bun add @expcat/tigercat-cli
```

## Health

**Score 55/100 (C)** — status: active.

Positive: no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 2.9.3 |
| Published | 2026-09-14 |
| First published | 2026-03-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Yizhe Wang |
| Maintainers | expcat |
| Keywords | tigercat, ui, cli, scaffolding, code-generator |

## Links

- npm: https://www.npmjs.com/package/@expcat/tigercat-cli
- Repository: https://github.com/expcat/Tigercat
- Homepage: https://github.com/expcat/Tigercat#readme
- Issues: https://github.com/expcat/Tigercat/issues
- npm.io page: https://npm.io/package/@expcat/tigercat-cli

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 2.9.3 (latest) — 2026-09-14
- 2.9.0 — 2026-09-13
- 2.8.5 — 2026-09-12
- 2.8.4 — 2026-09-12
- 2.8.3 — 2026-09-12
- 2.8.2 — 2026-09-12
- 2.8.1 — 2026-09-12
- 2.8.0 — 2026-09-12
- 2.7.2 — 2026-09-12
- 2.7.1 — 2026-09-12
- 2.7.0 — 2026-09-12
- 2.6.1 — 2026-09-11
- 2.6.0 — 2026-09-11
- 2.5.4 — 2026-09-11
- 2.5.3 — 2026-09-11
- … 52 more at https://npm.io/package/@expcat/tigercat-cli/versions

## README

# @expcat/tigercat-cli

CLI tooling for the [Tigercat](https://github.com/expcat/Tigercat) UI component library.

## Installation

```bash
pnpm add -g @expcat/tigercat-cli
# or
npx @expcat/tigercat-cli
```

## Usage Examples

### Start a Vue 3 project

```bash
tigercat create admin-console --template vue3
cd admin-console
pnpm install
pnpm dev
```

Preview the generated file list without writing files:

```bash
tigercat create admin-console --template vue3 --dry-run
```

### Start a React project

```bash
tigercat create design-lab --template react
cd design-lab
pnpm install
pnpm dev
```

### Add component boilerplate to an existing project

Run from a project that already depends on `@expcat/tigercat-vue` or `@expcat/tigercat-react`:

```bash
tigercat add Button Form Input Select
tigercat add --framework vue3 --install --snippet src/tigercat-components.ts
```

When no component names are provided, `add` opens an interactive multi-select prompt.
The command prints the correct package import, detects missing peer dependencies,
can install them with `--install`, and creates `src/components/*Demo.vue` or
`src/components/*Demo.tsx` files when a `src/components` directory exists.

```bash
tigercat add Button Form Input Select --dry-run
```

### Open a temporary playground

```bash
tigercat playground --template vue3 --port 3456
tigercat playground --template react --port 3457
tigercat playground --template react --no-open
```

Playground files are created under `.tigercat-playground/` in the current working directory.

```bash
tigercat playground --template react --port 3457 --dry-run
```

### Generate API docs from type definitions

```bash
tigercat generate docs --input packages/core/src/types --output docs/api
tigercat generate docs --input packages/core/src/types --output docs/api --dry-run
tigercat generate test Button --framework both
tigercat generate doc-template Button --output docs/components
```

### Check project compatibility

```bash
tigercat doctor
tigercat doctor --json
```

`doctor` verifies `package.json`, Node.js, pnpm, Tailwind CSS, Tigercat peer dependencies,
template dependency compatibility, and the supported version compatibility matrix. JSON output is
designed for CI and automated diagnostics.

The full command matrix for agents is
[cli.md](https://github.com/expcat/Tigercat/blob/main/skills/tigercat/references/cli.md).

## Windows Support

The CLI is fully cross-platform. All template file paths use forward slashes and are
resolved via Node.js `path.resolve()` at write time, so they work correctly on Windows
with backslash paths, paths containing spaces, and UNC paths.

### Package Manager `.cmd` Shims

When installed globally or locally, each package manager creates platform-specific shims
so that `tigercat` can be invoked directly from PowerShell, CMD, or Git Bash:

| Package manager | Global install                     | Shim files created                              |
| --------------- | ---------------------------------- | ----------------------------------------------- |
| **pnpm**        | `pnpm add -g @expcat/tigercat-cli` | `tigercat.cmd`, `tigercat` (sh)                 |
| **npm**         | `npm i -g @expcat/tigercat-cli`    | `tigercat.cmd`, `tigercat` (sh), `tigercat.ps1` |
| **bun**         | `bun add -g @expcat/tigercat-cli`  | `tigercat.cmd`, `tigercat` (sh)                 |

For local (non-global) installs, run via `npx tigercat`, `pnpm exec tigercat`, or
`bunx tigercat`. The `#!/usr/bin/env node` shebang in the built output is used by all
three package managers to locate the Node.js runtime.

On Windows, spawn pnpm with `shell: true` when using Corepack; repo scripts
already do this via `scripts/utils/pnpm.mjs`.

## License

MIT

---
_Source: https://npm.io/package/@expcat/tigercat-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._