# @vtex/cli-plugin-incremental-renderer

> vtex plugin template

Latest version **0.0.4** (published 2021-11-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install @vtex/cli-plugin-incremental-renderer
pnpm add @vtex/cli-plugin-incremental-renderer
yarn add @vtex/cli-plugin-incremental-renderer
bun add @vtex/cli-plugin-incremental-renderer
```

Provides the command `webops`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2021-11-30 |
| First published | 2021-11-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 9 |
| Unpacked size | 286.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | vlagedo_vtex, samuelfgs, mayzabel, tiagonapoli, rafabac, augusto.lazaro, tergol, rafarubim, analuizamtg, gustavorosolem, arthurepc, jeymisson, marcosvcp, victorhmp, lurian, ericreis, andreldsa, diegoximenes, salesfelipe, athoscouto, lbebber, tlgimenes, arturpimentel, felippenardi, anitavincent, brunojdo, vtexlab, augustob, guilhermebruzzi, brunohq, kevinchevallier, iago, lucasecdb, estacioneto, matheusps, emersonlaurentino, rerissondaniel, vwraposo, igorbrasileiro, thayannevls, angoncal, pedromtec, viniagostini, hugo.cabral, thiagoveras, lucasaarcoverde, lariciamota, wdsrocha, lucis, icazevedo, malvadeza, edunmc, fabits, marlonguimaraes, mateuspontes, gmantiqueira, jmgris, vitorlgomes, rodolfoams, rodorgas, policarpo, laurobmb, marcelovicentegc, maianabt, saviomuniz, jeffersontuc, hiagolcm, william.silva, bentoper |
| Keywords | oclif-plugin |

## Links

- npm: https://www.npmjs.com/package/@vtex/cli-plugin-incremental-renderer
- Repository: https://github.com/vtex/cli-plugin-template
- Issues: https://github.com/vtex/cli-plugin-incremental-renderer/issues
- npm.io page: https://npm.io/package/@vtex/cli-plugin-incremental-renderer

## Dependencies (9)

- [p-map](https://npm.io/package/p-map.md) 1.x
- [tslib](https://npm.io/package/tslib.md) ^1
- [graphql](https://npm.io/package/graphql.md) ^16.0.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^10.0.0
- [perf_hooks](https://npm.io/package/perf_hooks.md) ^0.0.1
- [@oclif/config](https://npm.io/package/@oclif/config.md) ^1
- [@faststore/api](https://npm.io/package/@faststore/api.md) ^1.3.6
- [@oclif/command](https://npm.io/package/@oclif/command.md) ^1
- [isomorphic-unfetch](https://npm.io/package/isomorphic-unfetch.md) ^3.1.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.0.4 (latest) — 2021-11-30
- 0.0.3 — 2021-11-30
- 0.0.2 — 2021-11-30
- 0.0.1 — 2021-11-30

## README

# OCLIF Plugin Incremental Renderer
oclif plugin for renderig pages using Gatsby v4.

## How it works
This plugin has two commads. Use `webops paths` for generating a staticPaths.json file containing the list of paths based on your faststore config. Feed this `staticPaths.json` or your own file into `webops render` to generate html's and json's for each path.

## Usage
<!-- usage -->
```sh-session
$ npm install -g @vtex/cli-plugin-incremental-renderer
$ vtex COMMAND
running command...
$ vtex (-v|--version|version)
@vtex/cli-plugin-incremental-renderer/0.0.4 linux-x64 node-v12.22.7
$ vtex --help [COMMAND]
USAGE
  $ vtex COMMAND
...
```
<!-- usagestop -->
```sh-session
$ cd /path/to/your/base.store/store
$ yarn clean && yarn build
$ yarn global add @vtex/cli-plugin-incremental-renderer
$ webops paths -o ./staticPaths.json
$ webops render -s ./staticPaths.json -o ./public
```

## Commands
<!-- commands -->
* [`vtex paths [FILE]`](#vtex-paths-file)
* [`vtex render [FILE]`](#vtex-render-file)

## `vtex paths [FILE]`

generates a list of paths for a Faststore store

```
USAGE
  $ vtex paths [FILE]

OPTIONS
  -a, --account=account    VTEX Account
  -c, --channel=channel    VTEX Channel
  -c, --platform=platform  ecommerce platform
  -h, --help               show CLI help
  -o, --output=output      staticPaths file
  -v, --verbose=verbose

EXAMPLE
  $ webops paths -o ./staticPaths.json -a fashioneurope
```

_See code: [build/commands/paths.ts](https://github.com/vtex/cli-plugin-template/blob/v0.0.4/build/commands/paths.ts)_

## `vtex render [FILE]`

Renders html and json for a list of paths

```
USAGE
  $ vtex render [FILE]

OPTIONS
  -c, --concurrency=concurrency  rendering concurrency
  -h, --help                     show CLI help
  -o, --output=output            build artifacts output folder
  -s, --static=static            static paths config file
  -v, --verbose=verbose

EXAMPLE
  $ webops render -s ./staticPaths.json -o ./public
```

_See code: [build/commands/render.ts](https://github.com/vtex/cli-plugin-template/blob/v0.0.4/build/commands/render.ts)_
<!-- commandsstop -->

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