Command-line interface for working with kit packages in your repo
npm install @rnx-kit/cli
Command-line interface for working with packages in your repo.
> [!NOTE]
>
> All commands below are also a plugin to @react-native-community/cli, meaning
> they will work with both react-native and rnc-cli commands. Just make sure
> to prefix the command with rnx- e.g., rnx-cli start becomes
> react-native rnx-start. The prefix is to avoid name clashes.
rnx-cli bundleBundle a package using [Metro][]. The bundling process uses optional
[configuration][] parameters and command-line overrides.
> [!NOTE]
>
> This command is meant to be a drop-in replacement for react-native bundle.
> If rnx-bundle ever becomes widely accepted, we will work on upstreaming it
> to @react-native-community/cli, along with supporting libraries for package
> configuration and Metro plugins.
``sh`
yarn rnx-cli bundle
`sh`
yarn rnx-cli bundle \
--entry-file src/index.ts \
--bundle-output main.jsbundle \
--platform ios \
--dev false \
--minify true
`json`
{
"rnx-kit": {
"bundle": {
"entryFile": "entry.js",
"assetsDest": "dist",
"plugins": [
"@rnx-kit/metro-plugin-cyclic-dependencies-detector",
[
"@rnx-kit/metro-plugin-duplicates-checker",
{ "ignoredModules": ["react-is"] }
],
"@rnx-kit/metro-plugin-typescript"
],
"targets": ["android", "ios", "macos", "windows"],
"platforms": {
"android": {
"assetsDest": "dist/res"
},
"macos": {
"plugins": [
"@rnx-kit/metro-plugin-cyclic-dependencies-detector",
[
"@rnx-kit/metro-plugin-duplicates-checker",
{ "ignoredModules": ["react-is"] }
]
]
}
}
}
}
}
When certain parameters aren't specified in configuration or on the
command-line, they are explicitly set to default values.
| Parameter | Default Value |
| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
| entryFile | "index.js" |"index.
| bundleOutput | (Windows, Android) or "index. (iOS, macOS) |false
| hermes | |false
| treeShake | |["@rnx-kit/metro-plugin-cyclic-dependencies-detector", "@rnx-kit/metro-plugin-duplicates-checker", "@rnx-kit/metro-plugin-typescript"]
| plugins | |
Other parameters have implicit defaults, buried deep in Metro or its
dependencies.
| Option | Description |
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| --id <id> | Target bundle definition; only needed when the rnx-kit configuration has multiple bundle definitions |
| --entry-file <path> | Path to the root JavaScript or TypeScript file, either absolute or relative to the package |
| --platform <ios|android|windows|win32|macos> | Target platform; when unspecified, all platforms in the rnx-kit configuration are bundled |
| --dev [boolean] | If false, warnings are disabled and the bundle is minified |
| --minify [boolean] | Controls whether or not the bundle is minified (useful for test builds) |
| --bundle-output <string> | Path to the output bundle file, either absolute or relative to the package |
| --bundle-encoding <utf8|utf16le|ascii> | Character encoding to use when writing the bundle file |
| --max-workers <number> | Specifies the maximum number of parallel worker threads to use for transforming files; defaults to the number of cores available on your machine |
| --sourcemap-output <string> | Path where the bundle source map is written, either absolute or relative to the package |
| --sourcemap-sources-root <string> | Path to use when relativizing file entries in the bundle source map |
| --sourcemap-use-absolute-path | Report SourceMapURL using its full path |
| --assets-dest <path> | Path where bundle assets like images are written, either absolute or relative to the package; if unspecified, assets are ignored |
| --unstable-transform-profile <string> | [Experimental] Transform JS for a specific JS engine; currently supported: hermes, hermes-canary, default |
| --reset-cache | Reset the Metro cache |
| --config <string> | Path to the Metro configuration file |
| --tree-shake [boolean] | Enable tree shaking to remove unused code and reduce the bundle size |
Start a bundle server for a package using [Metro][]. The bundle server uses
optional [configuration][] parameters and command-line overrides.
> [!NOTE]
>
> This command is meant to be a drop-in replacement for react-native start. Ifrnx-start
> ever becomes widely accepted, we will work on upstreaming it to@react-native-community/cli
> , along with supporting libraries for package
> configuration and Metro plugins.
`sh`
yarn rnx-cli start
`sh`
yarn rnx-cli start --host 127.0.0.1 --port 8812
`json`
{
"rnx-kit": {
"server": {
"projectRoot": "src",
"plugins": [
"@rnx-kit/metro-plugin-cyclic-dependencies-detector",
[
"@rnx-kit/metro-plugin-duplicates-checker",
{
"ignoredModules": ["react-is"],
"throwOnError": false
}
],
"@rnx-kit/metro-plugin-typescript"
]
}
}
}
If the server configuration is not defined, it is implicitly created at runtime
from the bundle configuration (or its defaults).
| Option | Description |
| ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| --port <number> | Host port to use when listening for incoming server requests |
| --host <string> | Host name or address to bind when listening for incoming server requests; when not specified, requests from all addresses are accepted |
| --project-root <path> | Path to the root of your react-native project; the bundle server uses this path to resolve all web requests |
| --watch-folders <paths> | Additional folders which will be added to the watched files list, comma-separated; by default, Metro watches all project files |
| --asset-plugins <list> | Additional asset plugins to be used by Metro's Babel transformer; comma-separated list containing plugin module names or absolute paths to plugin packages |
| --source-exts <list> | Additional source file extensions to include when generating bundles; comma-separated list, excluding the leading dot |
| --max-workers <number> | Specifies the maximum number of parallel worker threads to use for transforming files; defaults to the number of cores available on your machine |
| --reset-cache | Reset the Metro cache |
| --custom-log-reporter-path <string> | Path to a JavaScript file which exports a Metro 'TerminalReporter' function; replaces the default reporter that writes all messages to the Metro console |
| --https | Use a secure (https) web server; when not specified, an insecure (http) web server is used |
| --key <path> | Path to a custom SSL private key file to use for secure (https) communication |
| --cert <path> | Path to a custom SSL certificate file to use for secure (https) communication |
| --config <string> | Path to the Metro configuration file |
| --no-interactive | Disables interactive mode |
| --id <string> | Specify which bundle configuration to use if server configuration is missing |
Builds the native bits in your project.
`sh`
yarn rnx-cli build [options]
| Option | Description |
| ------------------------------ | ------------------------------------------------------------------------------------- |
| -p, --platform <string> | Target platform |
| --solution <string> | Path, relative to project root, of the Visual Studio solution to build (Windows only) |
| --workspace <string> | Path, relative to project root, of the Xcode workspace to build (macOS only) |
| --scheme <string> | Name of scheme to build (Apple platforms only) |
| --configuration <string> | Build configuration for building the app; 'Debug' or 'Release' |
| --destination <string> | Destination of the built app; 'device', 'emulator', or 'simulator' |
| --ccache-dir <string> | Path to Ccache config |
| --ccache-home <string> | Path to Ccache installation |
`sh`
yarn rnx-cli build -p ios
Launches the native app (building it first if necessary).
`sh`
yarn rnx-cli run [options]
| Option | Description |
| ------------------------------ | ------------------------------------------------------------------------------------- |
| -p, --platform <string> | Target platform |
| --solution <string> | Path, relative to project root, of the Visual Studio solution to build (Windows only) |
| --workspace <string> | Path, relative to project root, of the Xcode workspace to build (macOS only) |
| --scheme <string> | Name of scheme to build (Apple platforms only) |
| --configuration <string> | Build configuration for building the app; 'Debug' or 'Release' |
| --destination <string> | Destination of the built app; 'device', 'emulator', or 'simulator' |
| --ccache-dir <string> | Path to Ccache config |
| --ccache-home <string> | Path to Ccache installation |
| -d, --device <string> | The name of the device to launch the app in |
`sh`
yarn rnx-cli run -p ios
Manage dependencies within a repository and across many repositories.
`sh`
yarn rnx-cli align-deps [options] [/path/to/package.json]
Refer to [@rnx-kit/align-deps][] for details.
Cleans your project by removing React Native related caches and modules.
`sh`
yarn rnx-cli clean [options]
| Option | Description |
| ----------------------------------------------------------------- | -------------------------------------------------------- |
| --include <android,cocoapods,metro,npm,watchman,xcode,yarn> | Comma-separated flag of caches to clear e.g., npm,yarn |
| --project-root <path> | Root path to your React Native project |
| --verify-cache | Whether to verify the integrity of the cache |
Generate a third-party notice, an aggregation of all the LICENSE files from your
package's dependencies.
> [!NOTE]
>
> A third-party notice is a legal document. You are solely responsble for
> its content, even if you use this command to assist you in generating it. You
> should consult with an attorney to ensure your notice meets all legal
> requirements.
`sh`
yarn rnx-cli write-third-party-notices [options]
| Option | Description |
| -------------------------------- | --------------------------------------------------------------------- |
| --root-path <path> | The root of the repo to start resolving modules from |
| --source-map-file <path> | The source map file to generate license contents for |
| --json | Output license information as a JSON |
| --output-file <path> | The output file to write the license file to |
| --ignore-scopes <string> | npm scopes to ignore and not emit license information for |
| --ignore-modules <string> | Modules (JS packages) to not emit license information for |
| --preamble-text <string> | A list of lines to prepend at the start of the generated license file |
| --additional-text <string> | A list of lines to append at the end of the generated license file |
| --full-license-text | Include full license text in the JSON output |
The following commands route to @react-native-community/cli:
- rnx-cli build-android →react-native build-android
- →react-native build-ios
- →react-native config
- →react-native doctor
- →react-native info
- →react-native log-android
- →react-native log-ios
- →react-native run-android
- →react-native run-ios`
[@rnx-kit/align-deps]:
https://github.com/microsoft/rnx-kit/tree/main/packages/align-deps#readme
[Metro]: https://facebook.github.io/metro
[configuration]:
https://github.com/microsoft/rnx-kit/tree/main/packages/config#readme