CLI Reference
Complete reference for all UiPool CLI commands and options.
uipool scan #
Scan a directory for pattern and component annotations.
uipool scan [options]| Option | Description | Default |
|---|---|---|
| -r, --root <path> | Directory to scan | Current directory |
| -o, --out <path> | Output JSON file path | ./uipool-report.json |
| -p, --project <name> | Override project name | From package.json |
| -e, --ext <list> | Comma-separated file extensions | See below |
| -i, --ignore <list> | Additional ignore globs | None |
| --strict | Only accept namespaced annotations | false |
| --warn-legacy | Warn about legacy pattern: annotations | true |
| --no-warn-legacy | Suppress legacy warnings | — |
Examples #
Scan specific directory
uipool scan --root ./srcCustom output path
uipool scan --out ./reports/patterns.jsonOverride project name
uipool scan --project "My App"Scan only TypeScript and Vue files
uipool scan --ext .ts,.vueAdd custom ignore patterns
uipool scan --ignore "**/legacy/**,**/deprecated/**"Strict mode (namespaced only)
uipool scan --strictDefault File Extensions #
By default, UiPool scans these file types:
.js.ts.vue.jsx.tsx.md.html.css.scss.sass.less.mdxIgnored Directories #
These directories are ignored by default:
node_modulesdistbuild.output.nuxt.next.gitcoverage.turbo.cache