{
"name": "react-native",
"description": "Command line tools that ship with react-native in form of the @react-native-community/cli package",
"subcommands": [
{
"name": "doctor",
"description": "[EXPERIMENTAL] Diagnose and fix common Node.js, iOS, Android & React Native issues",
"options": [
{
"names": [
"--fix"
],
"description": "Attempt to fix all diagnosed issues"
},
{
"names": [
"--contributor"
],
"description": "Add healthchecks required to installations required for contributing to React Native"
},
{
"names": [
"-h",
"--help"
],
"description": "Output usage information"
}
]
},
{
"name": "bundle",
"description": "Builds the javascript bundle for offline use",
"options": [
{
"names": [
"--entry-file"
],
"description": "Path to the root JS file, either absolute or relative to JS root",
"takes_arg": true,
"arg": {
"name": "file"
}
},
{
"names": [
"--platform"
],
"description": "Either \"ios\" or \"android\" (default: \"ios\")",
"takes_arg": true,
"arg": {
"name": "platform",
"suggestions": [
"android",
"ios"
]
}
},
{
"names": [
"--transformer"
],
"description": "Specify a custom transformer to be used",
"takes_arg": true,
"arg": {
"name": "transformer"
}
},
{
"names": [
"--dev"
],
"description": "If false, warnings are disabled and the bundle is minified (default: true)",
"takes_arg": true,
"arg": {
"name": "boolean",
"suggestions": [
"true",
"false"
]
}
},
{
"names": [
"--minify"
],
"description": "Allows overriding whether bundle is minified. This defaults to false if dev is true, and true if dev is false. Disabling minification can be useful for speeding up production builds for testing purpos",
"takes_arg": true,
"arg": {
"name": "boolean",
"suggestions": [
"true",
"false"
]
}
},
{
"names": [
"--bundle-output"
],
"description": "File name where to store the resulting bundle, ex. /tmp/groups.bundle",
"takes_arg": true,
"arg": {
"name": "bundle file"
}
},
{
"names": [
"--bundle-encoding"
],
"description": "Encoding the bundle should be written in (https://nodejs.org/api/buffer.html#buffer_buffer). (default: \"utf8\")",
"takes_arg": true,
"arg": {
"name": "encoding",
"suggestions": [
"utf8",
"utf16le",
"latin1"
]
}
},
{
"names": [
"--max-workers"
],
"description": "Specifies the maximum number of workers the worker-pool will spawn for transforming files. This defaults to the number of the cores available on your machine",
"takes_arg": true,
"arg": {
"name": "Number of workers"
}
},
{
"names": [
"--sourcemap-output"
],
"description": "File name where to store the sourcemap file for resulting bundle, ex. /tmp/groups.map",
"takes_arg": true,
"arg": {
"name": "sourcemap-output"
}
},
{
"names": [
"--sourcemap-sources-root"
],
"description": "Path to make sourcemap's sources entries relative to, ex. /root/dir",
"takes_arg": true,
"arg": {
"name": "root",
"template": "folders"
}
},
{
"names": [
"--sourcemap-use-absolute-path"
],
"description": "Report SourceMapURL using its full path"
},
{
"names": [
"--assets-dest"
],
"description": "Directory name where to store assets referenced in the bundle",
"takes_arg": true,
"arg": {
"name": "directory",
"template": "folders"
}
},
{
"names": [
"--unstable-transform-profile"
],
"description": "Experimental, transform JS for a specific JS engine. Currently supported: hermes, hermes-canary, default",
"takes_arg": true,
"arg": {
"name": "transform-profile",
"suggestions": [
"hermes",
"hermes-canary",
"default"
]
}
},
{
"names": [
"--reset-cache"
],
"description": "Removes cached files"
},
{
"names": [
"--read-global-cache"
],
"description": "Try to fetch transformed JS code from the global cache, if configured"
},
{
"names": [
"--config"
],
"description": "Path to the CLI configuration file",
"takes_arg": true,
"arg": {
"name": "string",
"template": "filepaths"
}
},
{
"names": [
"-h",
"--help"
],
"description": "Output usage information"
}
]
},
{
"name": "init",
"description": "Initialize a new React Native project named <projectName> in a directory of the same name",
"options": [
{
"names": [
"--version"
],
"description": "Shortcut for `--template react-native@version`",
"takes_arg": true,
"arg": {
"name": "version"
}
},
{
"names": [
"--template"
],
"description": "Uses a custom template. Valid arguments are the ones supported by `yarn add [package]` or `npm install [package]`, if you are using `--npm` option",
"takes_arg": true,
"arg": {
"name": "template"
}
},
{
"names": [
"--npm"
],
"description": "Forces using npm for initialization"
},
{
"names": [
"--directory"
],
"description": "Uses a custom directory instead of `<projectName>`",
"takes_arg": true,
"arg": {
"name": "string",
"template": "folders"
}
},
{
"names": [
"--title"
],
"description": "Uses a custom app title name for application",
"takes_arg": true,
"arg": {
"name": "title"
}
},
{
"names": [
"--skip-install"
],
"description": "Skips dependencies installation step"
},
{
"names": [
"-h",
"--help"
],
"description": "Output usage information"
}
],
"args": [
{
"name": "projectName"
}
]
},
{
"name": "uninstall",
"description": "Uninstall and unlink native dependencies",
"options": [
{
"names": [
"-h",
"--help"
],
"description": "Output usage information"
}
],
"args": [
{
"name": "packageName"
}
]
},
{
"name": "start",
"description": "Starts the webserver",
"options": [
{
"names": [
"--port"
],
"description": "Port on which to listen to",
"takes_arg": true,
"arg": {
"name": "free port"
}
},
{
"names": [
"--host"
],
"description": "Change the default host",
"takes_arg": true,
"arg": {
"name": "new host"
}
},
{
"names": [
"--projectRoot"
],
"description": "Path to a custom project root",
"takes_arg": true,
"arg": {
"name": "path",
"template": "folders"
}
},
{
"names": [
"--watchFolders"
],
"description": "Specify any additional folders to be added to the watch list",
"takes_arg": true,
"arg": {
"name": "folders",
"template": "folders"
}
},
{
"names": [
"--assetPlugins"
],
"description": "Specify any additional asset plugins to be used by the packager by full filepath",
"takes_arg": true,
"arg": {
"name": "plugins",
"template": "folders"
}
},
{
"names": [
"--sourceExts"
],
"description": "Specify any additional source extensions to be used by the packager",
"takes_arg": true,
"arg": {
"name": "sourceExts",
"suggestions": [
"js",
"css",
"png",
"xml"
]
}
},
{
"names": [
"--max-workers"
],
"description": "Specifies the maximum number of workers the worker-pool will spawn for transforming files. This defaults to the number of the cores available on your machine",
"takes_arg": true,
"arg": {
"name": "Number of workers"
}
},
{
"names": [
"--transformer"
],
"description": "Specify a custom transformer to be used",
"takes_arg": true,
"arg": {
"name": "transformer"
}
},
{
"names": [
"--reset-cache",
"--resetCache"
],
"description": "Removes cached files"
},
{
"names": [
"--custom-log-reporter-path",
"--customLogReporterPath"
],
"description": "Path to a JavaScript file that exports a log reporter as a replacement for TerminalReporter",
"takes_arg": true,
"arg": {
"name": "logFile"
}
},
{
"names": [
"--verbose"
],
"description": "Enables logging"
},
{
"names": [
"--https"
],
"description": "Enables https connections to the server"
},
{
"names": [
"--key"
],
"description": "Path to custom SSL key",
"takes_arg": true,
"arg": {
"name": "path",
"template": "filepaths"
}
},
{
"names": [
"--cert"
],
"description": "Path to custom SSL cert",
"takes_arg": true,
"arg": {
"name": "path",
"template": "filepaths"
}
},
{
"names": [
"--config"
],
"description": "Path to the CLI configuration file",
"takes_arg": true,
"arg": {
"name": "string"
}
},
{
"names": [
"--no-interactive"
],
"description": "Disables interactive mode"
},
{
"names": [
"-h",
"--help"
],
"description": "Output usage information"
}
]
},
{
"name": "ram-bundle",
"description": "Builds javascript as a \"Random Access Module\" bundle for offline use",
"options": [
{
"names": [
"--entry-file"
],
"description": "Path to the root JS file, either absolute or relative to JS root",
"takes_arg": true,
"arg": {
"name": "file"
}
},
{
"names": [
"--platform"
],
"description": "Either \"ios\" or \"android\" (default: \"ios\")",
"takes_arg": true,
"arg": {
"name": "platform",
"suggestions": [
"android",
"ios"
]
}
},
{
"names": [
"--transformer"
],
"description": "Specify a custom transformer to be used",
"takes_arg": true,
"arg": {
"name": "transformer"
}
},
{
"names": [
"--dev"
],
"description": "If false, warnings are disabled and the bundle is minified (default: true)",
"takes_arg": true,
"arg": {
"name": "boolean",
"suggestions": [
"true",
"false"
]
}
},
{
"names": [
"--minify"
],
"description": "Allows overriding whether bundle is minified. This defaults to false if dev is true, and true if dev is false. Disabling minification can be useful for speeding up production builds for testing purpos",
"takes_arg": true,
"arg": {
"name": "boolean",
"suggestions": [
"true",
"false"
]
}
},
{
"names": [
"--bundle-output"
],
"description": "File name where to store the resulting bundle, ex. /tmp/groups.bundle",
"takes_arg": true,
"arg": {
"name": "output file"
}
},
{
"names": [
"--bundle-encoding"
],
"description": "Encoding the bundle should be written in (https://nodejs.org/api/buffer.html#buffer_buffer). (default: \"utf8\")",
"takes_arg": true,
"arg": {
"name": "encoding",
"suggestions": [
"utf8",
"utf16le",
"latin1"
]
}
},
{
"names": [
"--max-workers"
],
"description": "Specifies the maximum number of workers the worker-pool will spawn for transforming files. This defaults to the number of the cores available on your machine",
"takes_arg": true,
"arg": {
"name": "Number of workers"
}
},
{
"names": [
"--sourcemap-output"
],
"description": "File name where to store the sourcemap file for resulting bundle, ex. /tmp/groups.map",
"takes_arg": true,
"arg": {
"name": "sourcemap-output"
}
},
{
"names": [
"--sourcemap-sources-root"
],
"description": "Path to make sourcemap's sources entries relative to, ex. /root/dir",
"takes_arg": true,
"arg": {
"name": "root",
"template": "folders"
}
},
{
"names": [
"--sourcemap-use-absolute-path"
],
"description": "Report SourceMapURL using its full path"
},
{
"names": [
"--assets-dest"
],
"description": "Directory name where to store assets referenced in the bundle",
"takes_arg": true,
"arg": {
"name": "directory",
"template": "folders"
}
},
{
"names": [
"--unstable-transform-profile"
],
"description": "Experimental, transform JS for a specific JS engine. Currently supported: hermes, hermes-canary, default",
"takes_arg": true,
"arg": {
"name": "transform-profile",
"suggestions": [
"hermes",
"hermes-canary",
"default"
]
}
},
{
"names": [
"--reset-cache"
],
"description": "Removes cached files"
},
{
"names": [
"--read-global-cache"
],
"description": "Try to fetch transformed JS code from the global cache, if configured"
},
{
"names": [
"--config"
],
"description": "Path to the CLI configuration file",
"takes_arg": true,
"arg": {
"name": "string"
}
},
{
"names": [
"--indexed-ram-bundle"
],
"description": "Force the \"Indexed RAM\" bundle file format, even when building for android"
},
{
"names": [
"-h",
"--help"
],
"description": "Output usage information"
}
]
},
{
"name": "link",
"description": "Links assets and optionally native modules",
"options": [
{
"names": [
"--platforms"
],
"description": "Scope linking to specified platforms",
"takes_arg": true,
"arg": {
"name": "list"
}
},
{
"names": [
"--all"
],
"description": "Link all native modules and assets"
},
{
"names": [
"-h",
"--help"
],
"description": "Output usage information"
}
],
"args": [
{
"name": "packageName"
}
]
},
{
"name": "upgrade",
"description": "Upgrade your app's template files to the specified or latest npm version using `rn-diff-purge` project. Only valid semver versions are allowed",
"options": [
{
"names": [
"-h",
"--help"
],
"description": "Output usage information"
}
],
"args": [
{
"name": "version"
}
]
},
{
"name": "info",
"description": "Get relevant version info about OS, toolchain and libraries",
"options": [
{
"names": [
"-h",
"--help"
],
"description": "Output usage information"
}
]
},
{
"name": "install",
"description": "Install and link native dependencies",
"options": [
{
"names": [
"-h",
"--help"
],
"description": "Output usage information"
}
],
"args": [
{
"name": "packageName"
}
]
},
{
"name": "config",
"description": "Print CLI configuration",
"options": [
{
"names": [
"-h",
"--help"
],
"description": "Output usage information"
}
]
},
{
"name": "unlink",
"description": "Unlink native dependency",
"options": [
{
"names": [
"--platforms"
],
"description": "Scope unlinking to specified platforms",
"takes_arg": true,
"arg": {
"name": "list"
}
},
{
"names": [
"-h",
"--help"
],
"description": "Output usage information"
}
],
"args": [
{
"name": "packageName"
}
]
},
{
"name": "log-ios",
"description": "Starts iOS device syslog tail",
"options": [
{
"names": [
"-h",
"--help"
],
"description": "Output usage information"
}
]
},
{
"name": "profile-hermes",
"description": "Pull and convert a Hermes tracing profile to Chrome tracing profile, then store it in the directory <destinationDir> of the local machine",
"options": [
{
"names": [
"--filename"
],
"description": "File name of the profile to be downloaded, eg. sampling-profiler-trace8593107139682635366.cpuprofile",
"takes_arg": true,
"arg": {
"name": "profile",
"template": "filepaths"
}
},
{
"names": [
"--raw"
],
"description": "Pulls the original Hermes tracing profile without any transformation"
},
{
"names": [
"--sourcemap-path"
],
"description": "The local path to your source map file, eg. /tmp/sourcemap.json",
"takes_arg": true,
"arg": {
"name": "sourcemap-path",
"template": "filepaths"
}
},
{
"names": [
"--generate-sourcemap"
],
"description": "Generates the JS bundle and source map"
},
{
"names": [
"--port"
],
"description": "Default: \"8081\"",
"takes_arg": true,
"arg": {
"name": "free port"
}
},
{
"names": [
"-h",
"--help"
],
"description": "Output usage information"
}
],
"args": [
{
"name": "destinationDir",
"template": "folders"
}
]
},
{
"name": "log-android",
"description": "Starts logkitty",
"options": [
{
"names": [
"-h",
"--help"
],
"description": "Output usage information"
}
]
},
{
"name": "run-android",
"description": "Builds your app and starts it on a connected Android emulator or device",
"options": [
{
"names": [
"--root"
],
"description": "[DEPRECATED - root is discovered automatically] Override the root directory for the android build (which contains the android directory) (default: \"\")",
"takes_arg": true,
"arg": {
"name": "root",
"template": "folders"
}
},
{
"names": [
"--variant"
],
"description": "Specify your app's build variant (default: \"debug\")",
"takes_arg": true,
"arg": {
"name": "variant",
"suggestions": [
"debug",
"release"
]
}
},
{
"names": [
"--appFolder"
],
"description": "[DEPRECATED – use \"project.android.appName\" in react-native.config.js] Specify a different application folder name for the android source. If not, we assume is \"app\"",
"takes_arg": true,
"arg": {
"name": "string",
"template": "folders"
}
},
{
"names": [
"--appId"
],
"description": "Specify an applicationId to launch after build. If not specified, `package` from AndroidManifest.xml will be used. (default: \"\")",
"takes_arg": true,
"arg": {
"name": "appId"
}
},
{
"names": [
"--appIdSuffix"
],
"description": "Specify an applicationIdSuffix to launch after build. (default: \"\")",
"takes_arg": true,
"arg": {
"name": "appIdSuffix"
}
},
{
"names": [
"--main-activity"
],
"description": "Name of the activity to start (default: \"MainActivity\")",
"takes_arg": true,
"arg": {
"name": "main activity"
}
},
{
"names": [
"--deviceId"
],
"description": "Builds your app and starts it on a specific device/simulator with the given device id (listed by running \"adb devices\" on the command line)",
"takes_arg": true,
"arg": {
"name": "deviceId"
}
},
{
"names": [
"--no-packager"
],
"description": "Do not launch packager while building"
},
{
"names": [
"--port"
],
"description": "Default: 8081",
"takes_arg": true,
"arg": {
"name": "free port"
}
},
{
"names": [
"--terminal"
],
"description": "Launches the Metro Bundler in a new window using the specified terminal path. (default: \"Apple_Terminal\")",
"takes_arg": true,
"arg": {
"name": "terminal path"
}
},
{
"names": [
"--tasks"
],
"description": "Run custom Gradle tasks. By default it's \"installDebug\"",
"takes_arg": true,
"arg": {
"name": "task list"
}
},
{
"names": [
"--no-jetifier"
],
"description": "Do not run \"jetifier\" – the AndroidX transition tool. By default it runs before Gradle to ease working with libraries that don't support AndroidX yet. See more at: https://www.npmjs.com/package/jetifi"
},
{
"names": [
"-h",
"--help"
],
"description": "Output usage information"
}
]
},
{
"name": "run-ios",
"description": "Builds your app and starts it on iOS simulator",
"options": [
{
"names": [
"--simulator"
],
"description": "Explicitly set simulator to use. Optionally include iOS version between parenthesis at the end to match an exact version: \"iPhone 6 (10.0)\" (default: \"iPhone 12\")",
"takes_arg": true,
"arg": {
"name": "simulator"
}
},
{
"names": [
"--configuration"
],
"description": "Explicitly set the scheme configuration to use (default: \"Debug\")",
"takes_arg": true,
"arg": {
"name": "config scheme"
}
},
{
"names": [
"--scheme"
],
"description": "Explicitly set Xcode scheme to use",
"takes_arg": true,
"arg": {
"name": "scheme"
}
},
{
"names": [
"--project-path"
],
"description": "Path relative to project root where the Xcode project (.xcodeproj) lives. (default: \"ios\")",
"takes_arg": true,
"arg": {
"name": "path",
"template": "folders"
}
},
{
"names": [
"--device"
],
"description": "Explicitly set device to use by name",
"takes_arg": true,
"arg": {
"name": "device name"
}
},
{
"names": [
"--udid"
],
"description": "Explicitly set device to use by udid",
"takes_arg": true,
"arg": {
"name": "udid"
}
},
{
"names": [
"--no-packager"
],
"description": "Do not launch packager while building"
},
{
"names": [
"--verbose"
],
"description": "Do not use xcpretty even if installed"
},
{
"names": [
"--port"
],
"description": "Default: 8081",
"takes_arg": true,
"arg": {
"name": "free port"
}
},
{
"names": [
"--terminal"
],
"description": "Launches the Metro Bundler in a new window using the specified terminal path. (default: \"Apple_Terminal\")",
"takes_arg": true,
"arg": {
"name": "terminal path"
}
},
{
"names": [
"-h",
"--help"
],
"description": "Output usage information"
}
]
}
],
"options": [
{
"names": [
"--version"
],
"description": "Print CLI version"
},
{
"names": [
"--verbose"
],
"description": "Increase logging verbosity"
},
{
"names": [
"-h",
"--help"
],
"description": "Output usage information"
}
]
}