Skip to content

docs: added docs for clean #1589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 7, 2022
Merged

docs: added docs for clean #1589

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f6e5042
docs: added docs for `clean`
tido64 Apr 7, 2022
49a6224
Update docs/commands.md
tido64 Apr 7, 2022
65f26f5
Update docs/commands.md
thymikee Apr 7, 2022
a50a304
list all valid values
tido64 Apr 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion docs/commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
React Native CLI comes with following commands:

- [`bundle`](#bundle)
- [`clean`](#clean)
- [`config`](#config)
- [`doctor`](#doctor)
- [`init`](#init)
Expand Down Expand Up @@ -124,6 +125,34 @@ Try to fetch transformed JS code from the global cache, if configured.

Path to the CLI configuration file.

### `clean`

Usage:

```sh
react-native clean
```

Cleans caches. Commonly used to ensure build failures are not due to stale cache. By default, it will prompt which caches to purge, with Watchman and Metro already checked. To omit interactive prompt (e.g. in scripts), please use `--include` flag.

#### Options

#### `--include <string>`

Comma-separated flag of caches to clear e.g. `npm,yarn`. If omitted, an interactive prompt will appear. Valid values include `android`, `cocoapods`, `metro`, `npm`, `watchman`, and `yarn`.

#### `--project-root <string>`

> default: current working directory

Root path to your React Native project. When not specified, defaults to current working directory.

#### `--verify-cache`

> default: false

Whether to verify the cache. Currently only applies to npm cache.

### `config`

Usage:
Expand Down Expand Up @@ -349,7 +378,7 @@ Example: `yarn react-native run-android --tasks clean,installDebug`.
> default: false

Do not run [jetifier](https://www.npmjs.com/package/jetifier) – the AndroidX transition tool. By default it runs before Gradle to ease working with libraries that don't support AndroidX yet.

#### `--active-arch-only`

> default: false
Expand Down