Skip to content

Commit 30e904c

Browse files
committed
docs: add docs
1 parent 8f421a6 commit 30e904c

File tree

1 file changed

+1
-17
lines changed

1 file changed

+1
-17
lines changed

packages/cli/README.md

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -336,20 +336,4 @@ The CLI supports caching to speed up subsequent runs and is compatible with Nx a
336336
Depending on your strategy, you can cache the generated reports files or plugin runner output.
337337
For fine-grained caching, we suggest caching plugin runner output.
338338

339-
### Caching Example Nx
340-
341-
To cache plugin runner output, you can use the `--cache.write` and `--cache.read` options.
342-
343-
Cache plugin level output files:
344-
345-
```bash
346-
# CACHE OUTPUTS
347-
# write cache to persist.outputDir/<pluginName>/runner-output.json
348-
# npx @code-pushup/cli collect --persist.outputDir {projectRoot}/.code-pushup --persist.skipReports --onlyPlugins coverage --cache
349-
nx run-many -t code-pushup:collect:coverage
350-
# npx @code-pushup/cli collect --persist.outputDir {projectRoot}/.code-pushup --persist.skipReports --onlyPlugins eslint --cache
351-
nx run-many -t code-pushup:collect:eslint
352-
# READ CACHED OUTPUTS
353-
# npx @code-pushup/cli collect --cache.read
354-
nx run-many -t code-pushup:collect
355-
```
339+
The detailed example for [Nx caching](./docs/nx-caching.md) and [Turborepo caching](./docs/turbo-caching.md) is available in the docs.

0 commit comments

Comments
 (0)