# @shopify/loom-cli > The CLI for loom Latest version **1.1.0** (published 2023-05-09) · MIT license · 0 weekly downloads ## Install ```sh npm install @shopify/loom-cli pnpm add @shopify/loom-cli yarn add @shopify/loom-cli bun add @shopify/loom-cli ``` Provides the command `loom`. ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; esm support; no vulnerabilities. Warnings: low downloads. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.1.0 | | Published | 2023-05-09 | | First published | 2021-09-13 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Node | ^12.22.0 \|\| ^14.17.0 \|\| >=16.0.0 | | Dependencies | 8 | | Unpacked size | 86.4 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Shopify Inc. | | Maintainers | shopify-admin, maryharte, crisfmb, pmoloney89, netlohan, st999999, justin-irl, megswim, michaelarsenault, wcandillon, jplhomer, marytal, nathanpjf, shopify-dep, goodforonefare, lemonmade, vsumner, wizardlyhel, antoine.grant, tsov, andyw8-shopify, henrytao, hannachen, andrewapperley, iainmcampbell, vividviolet, bpscott | ## Links - npm: https://www.npmjs.com/package/@shopify/loom-cli - Repository: https://github.com/Shopify/loom - Homepage: https://github.com/Shopify/loom/blob/main/packages/loom-cli/README.md - Issues: https://github.com/Shopify/loom/issues - npm.io page: https://npm.io/package/@shopify/loom-cli ## Dependencies (8) - [chalk](https://npm.io/package/chalk.md) ^4.0.0 - [execa](https://npm.io/package/execa.md) ^4.0.0 - [yargs](https://npm.io/package/yargs.md) ^17.2.1 - [signal-exit](https://npm.io/package/signal-exit.md) ^3.0.3 - [ansi-escapes](https://npm.io/package/ansi-escapes.md) ^4.3.1 - [@shopify/loom](https://npm.io/package/@shopify/loom.md) ^1.0.2 - [@types/signal-exit](https://npm.io/package/@types/signal-exit.md) ^3.0.0 - [supports-hyperlinks](https://npm.io/package/supports-hyperlinks.md) ^2.1.0 ## Recent versions - 1.1.0 (latest) — 2023-05-09 - 0.8.0-alpha.0 (beta) — 2021-10-12 - 1.0.2 — 2022-08-23 - 1.0.1 — 2021-11-23 - 1.0.0 — 2021-10-22 - 0.8.0-alpha.4 — 2021-10-15 - 0.8.0-alpha.3 — 2021-10-15 - 0.8.0-alpha.2 — 2021-10-15 - 0.8.0-alpha.1 — 2021-10-13 - 0.7.0 — 2021-09-13 ## README # `@shopify/loom-cli` The CLI for working with `loom`. These commands trigger the functionality imparted to your project by the plugins consumed in your `loom.config`s. The options will be passed to the plugins. ## Installation ```sh yarn add @shopify/loom-cli --dev ``` ## Usage ```sh yarn loom ``` Inline help can be found with `yarn loom --help`. For instance to see help for the build command you can run `yarn loom build--help`. ## Commands | Command | Function | | ----------------------------- | --------------------------------------------------------- | | [`build`](#build) | Builds the apps, services, and packages in your workspace | | [`dev`](#dev) | Starts a hot-reloading development server | | [`test`](#test) | Runs tests | | [`lint`](#lint) | Lints your code | | [`type-check`](###type-check) | Type-checks your code | ## Options ### `build` | Option | Description | Type and Default | | --------------- | -------------------------------------------------------------- | ---------------------------------- | | `--source-maps` | Generate sourcemaps for the build | `boolean`, defaults to `false` | | `--env` | Whether to build for `production` (or `prod`) or `development` | `string`, defaults to `production` | | `--cache` | Runs a build with cache | `boolean`, defaults to `true` | ### `dev` | Option | Description | Type and Default | | --------------- | --------------------------------- | ------------------------------ | | `--source-maps` | Generate sourcemaps for the build | `boolean`, defaults to `false` | | `--reload` | Use fast reloading (`fast`) | `string`, defaults to `none` | ### `test` | Option | Description | Type and Default | | --------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------- | | `--watch` | Runs tests in watch mode | `boolean`, defaults to `true` | | `--ci` | Runs tests in CI mode (can also be enabled by setting the environment variable CI=1) | `boolean`, defaults to `false` | | `--coverage` | Generate coverage data | `boolean` defaults to `false` | | `--debug` | Run tests in debug mode (for instance, with `plugin-jest` this enables the `runInBand` option) | `boolean`, defaults to `false` | | `--update-snapshots` | Enable [snapshots](https://jestjs.io/docs/en/cli#--updatesnapshot) for failed tests | `boolean`, defaults to `false` | | `--test-name-pattern` | Matching string or globbing pattern to run specific tests | `string`, defaults to running nothing | ### `lint` | Option | Description | Type and Default | | --------------- | ----------------------------------------------------------------------------------------------------------------- | ------------------------------ | | `--fix` | Fix lint errors | `boolean`, defaults to `false` | | `--cache` | Cache linting results for performance | `boolean`, defaults to `true` | | `--allow-empty` | [Allow matchless globs](https://eslint.org/docs/user-guide/command-line-interface#-no-error-on-unmatched-pattern) | `boolean`, defaults to `false` | ### `type-check` | Option | Description | Type and Default | | --------- | ------------------------ | ------------------------------ | | `--watch` | Type-check in watch mode | `boolean`, defaults to `false` | | `--cache` | Cache type-check results | `boolean`, defaults to `true` | --- _Source: https://npm.io/package/@shopify/loom-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._