You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: website/src/docs/cli.md
+52-12Lines changed: 52 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,12 +24,13 @@ The following options are available for all commands:
24
24
25
25
RNEF CLI uses a modular design where available commands depend on your configuration. The following commands are available by default for all configurations (these are internal commands that you typically won't need to run):
|`config`| Outputs autolinking config (from Community CLI) |
30
+
|`fingerprint`| Calculates fingerprint for project or platform |
31
+
|`clean`| Cleans various caches to free up disk space |
32
+
|`help`| Displays help menu for a command |
33
+
|`remote-cache`| Manage remote cache |
33
34
34
35
Additional commands for development, building, and running apps are provided by specialized plugins.
35
36
@@ -211,7 +212,7 @@ Same as for `build:android` and:
211
212
212
213
### `rnef sign:android` Options
213
214
214
-
The `sign:android` command signs your Android app with a keystore, producing a signed APK file ready for distribution. It allows for replacing the JS bundle with a new version.
215
+
The `sign:android <binaryPath>` command signs your Android app with a keystore, producing a signed APK file ready for distribution. It allows for replacing the JS bundle with a new version.
215
216
216
217
| Argument | Description |
217
218
| :----------- | :------------------- |
@@ -230,8 +231,47 @@ The `sign:android` command signs your Android app with a keystore, producing a s
230
231
231
232
The `clean` command helps you free up disk space by removing various caches and temporary files from your React Native project. It can clean Android (Gradle), iOS (CocoaPods), Metro, Watchman, RNEF's own project caches, and package manager caches.
|`--include <string>`| Comma-separated list of caches to clean. Available options: `android`, `gradle`, `cocoapods`, `metro`, `watchman`, `npm`, `yarn`, `bun`, `pnpm`, `rnef`|
236
-
|`--verify-cache`| Whether to verify the cache (currently only applies to npm cache) |
237
-
|`--all`| Clean all available caches without interactive prompt |
|`--include <string>`| Comma-separated list of caches to clean. Available options: `android`, `gradle`, `cocoapods`, `metro`, `watchman`, `npm`, `yarn`, `bun`, `pnpm`, `rnef`|
237
+
|`--verify-cache`| Whether to verify the cache (currently only applies to npm cache) |
238
+
|`--all`| Clean all available caches without interactive prompt |
239
+
240
+
### `rnef remote-cache` Actions and Options
241
+
242
+
The `remote-cache <action>` command provides utilities to interact with the remote build cache configured via your `remoteCacheProvider`. This is useful for inspecting, downloading, uploading, or deleting build artifacts stored remotely.
|`--json`| Output results in JSON format instead of human-readable format |
260
+
|`--name <string>`| Full artifact name to operate on. Cannot be used with `--platform` or `--traits`|
261
+
|`--all`| List or delete all matching artifacts (affects `list` and `delete` actions only) |
262
+
|`--all-but-latest`| Delete all but the latest matching artifact (affects `delete` action only) |
263
+
|`-p, --platform <string>`| Platform to target (`ios` or `android`). Must be used with `--traits`|
264
+
|`-t, --traits <list>`| Comma-separated traits that construct the final artifact name. For Android: variant (e.g., `debug`, `release`). For iOS: destination and configuration (e.g., `simulator,Release`) |
265
+
|`--binary-path <string>`| Path to the binary to upload (used with `upload` action) |
266
+
267
+
For example, to download remote cache for iOS simulator with Release configuration, you can use `remote-cache download` with `--name` option
0 commit comments