### start Source: https://github.com/flexn-io/renative-docs/blob/main/docs/api/cli.md Starts the React Native bundler. ```APIDOC ## start ### Description Starts react-native bundler. ### Provided By @rnv/engine-rn ### Depends On [`configureSoft`](#configuresoft) ### Available Options [`reset`](#reset), [`reset-hard`](#reset-hard), [`reset-assets`](#reset-assets), [`app-config-ID`](#app-config-id), [`package-manager`](#package-manager) ### Example ```bash npx rnv start ``` ``` -------------------------------- ### Install @flexn/create-template-starter Source: https://github.com/flexn-io/renative-docs/blob/main/docs/templates/overview.md Use this command to create a new project with the @flexn/create-template-starter template. Ensure you have the Renative CLI installed. ```bash rnv new --template @flexn/create-template-starter@latest ``` -------------------------------- ### Install @rnv/template-starter Source: https://github.com/flexn-io/renative-docs/blob/main/docs/templates/overview.md Use this command to create a new project with the @rnv/template-starter template. Ensure you have the Renative CLI installed. ```bash rnv new --template @rnv/template-starter@latest ``` -------------------------------- ### Start Local Development Server Source: https://github.com/flexn-io/renative-docs/blob/main/README.md Starts a local development server for live previewing changes. No restart is needed for most updates. ```bash yarn start ``` -------------------------------- ### Start Server/Bundler Source: https://github.com/flexn-io/renative-docs/blob/main/docs/concepts/cli.md Starts the development server or bundler for a specific platform. Defaults to Metro bundler if no platform is specified. ```bash rnv start -p ``` -------------------------------- ### Using NPX for ReNative Commands Source: https://github.com/flexn-io/renative-docs/blob/main/docs/overview/quickstart.md It is recommended to use 'npx rnv ...' for all commands after initial project setup to ensure the correct ReNative version is used, preventing compatibility issues. Ensure npx is installed globally. ```bash npm install npx -g ``` -------------------------------- ### Install ReNative CLI Source: https://github.com/flexn-io/renative-docs/blob/main/docs/api/node/renative/index.md Install the latest version of the ReNative CLI globally using npm. ```bash npm i -g rnv ``` -------------------------------- ### Launch Target Source: https://github.com/flexn-io/renative-docs/blob/main/docs/concepts/cli.md Starts an emulator, simulator, or device for a specified platform. ```bash rnv target launch -p ``` -------------------------------- ### Install Native-Base Shoutem Theme Plugin Source: https://github.com/flexn-io/renative-docs/blob/main/docs/plugins/overview.md Install the native-base-shoutem-theme plugin, version 0.2.3. It is available for all listed platforms. ```bash npx rnv plugin add native-base-shoutem-theme ``` -------------------------------- ### Install @sentry/tracing Plugin Source: https://github.com/flexn-io/renative-docs/blob/main/docs/plugins/overview.md This command installs the @sentry/tracing plugin, which is available for numerous platforms. ```bash npx rnv plugin add @sentry/tracing ``` -------------------------------- ### Start Web Server Only Source: https://github.com/flexn-io/renative-docs/blob/main/docs/platforms/web.md If you only need to start the local server without opening the browser, use this command. ```bash rnv start -p web ``` -------------------------------- ### Install @lightningjs/sdk Plugin Source: https://github.com/flexn-io/renative-docs/blob/main/docs/plugins/overview.md This command installs the @lightningjs/sdk plugin for your Renative project. It provides the Software Development Kit for LightningJS. ```bash npx rnv plugin add @lightningjs/sdk ``` -------------------------------- ### Runtime Configuration Example Source: https://github.com/flexn-io/renative-docs/blob/main/docs/guides/advanced-configuration.md An example of how to define runtime values within a renative.runtime.json file. This file is generated during the rnv build process. ```json { "runtime": { "foo": "bar" } } ``` -------------------------------- ### Install react-navigation Plugin Source: https://github.com/flexn-io/renative-docs/blob/main/docs/plugins/overview.md Use this command to add the react-navigation plugin to your project. ```bash npx rnv plugin add react-navigation ``` -------------------------------- ### Install react-native-picker Plugin Source: https://github.com/flexn-io/renative-docs/blob/main/docs/plugins/overview.md Use this command to add the react-native-picker plugin to your Renative project. Ensure you have the Renative CLI installed. ```bash npx rnv plugin add react-native-picker ``` -------------------------------- ### Print ReNative Version Source: https://github.com/flexn-io/renative-docs/blob/main/docs/concepts/cli.md Displays the currently installed version of ReNative. ```bash rnv --version ``` -------------------------------- ### Install react-native-lottie Source: https://github.com/flexn-io/renative-docs/blob/main/docs/plugins/overview.md Use this command to add the react-native-lottie plugin to your Renative project. ```bash npx rnv plugin add react-native-lottie ``` -------------------------------- ### Install @react-native-community/netinfo Source: https://github.com/flexn-io/renative-docs/blob/main/docs/plugins/overview.md Use this command to add the @react-native-community/netinfo plugin to your project. ```bash npx rnv plugin add @react-native-community/netinfo ``` -------------------------------- ### Install react-native-home-indicator Source: https://github.com/flexn-io/renative-docs/blob/main/docs/plugins/overview.md Use this command to add the react-native-home-indicator plugin to your project. ```bash npx rnv plugin add react-native-home-indicator ``` -------------------------------- ### getInstalledTemplateOptions Source: https://github.com/flexn-io/renative-docs/blob/main/docs/api/node/rnv-core/modules.md Gets prompt options for selecting installed Renative templates. ```APIDOC ## getInstalledTemplateOptions ### Description Gets prompt options for selecting installed Renative templates. ### Method Not applicable (Function Signature) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Parameters - **c** (RnvContext) - Required - The Renative context object. ### Returns - **PromptOptions** - An object containing prompt options for template selection. ``` -------------------------------- ### New Plugin Definition Structure (1.0.0+) Source: https://github.com/flexn-io/renative-docs/blob/main/docs/upgrades/1.0.md Example of the updated plugin definition structure for `renative.json` starting from ReNative version 1.0.0. Platform-specific configurations are now nested under `templateAndroid` and `templateXcode`. ```json "plugins": { "@mapbox/react-native-mapbox-gl": { "android": { "templateAndroid": { "implementation": " implementation (project(':mapbox-react-native-mapbox-gl')) {\n implementation ('com.squareup.okhttp3:okhttp:3.6.0') {\n force = true\n }\n }", }, "package": "com.mapbox.rctmgl.RCTMGLPackage", "path": "{{PLUGIN_ROOT}}/android/rctmgl", "projectName": "mapbox-react-native-mapbox-gl" }, "ios": { "templateXcode": { "appDelegateImports": ["RNCPushNotificationIOS"], "appDelegateMethods": { "application": { "didFailToRegisterForRemoteNotificationsWithError": [ "RNCPushNotificationIOS.didFailToRegisterForRemoteNotificationsWithError(error)" ], "didReceive": null, "didReceive": ["RNCPushNotificationIOS.didReceive(notification)"], "didReceiveRemoteNotification": [ "RNCPushNotificationIOS.didReceiveRemoteNotification(userInfo, fetchCompletionHandler: completionHandler)" ], "didRegister": ["RNCPushNotificationIOS.didRegister(notificationSettings)"], "didRegisterForRemoteNotificationsWithDeviceToken": [ "RNCPushNotificationIOS.didRegisterForRemoteNotifications(withDeviceToken: deviceToken)" ] }, "userNotificationCenter": { "willPresent": ["completionHandler([.alert, .badge, .sound])"] } }, }, "path": "{{PLUGIN_ROOT}}", "podName": "RNCPushNotificationIOS" }, } } ``` -------------------------------- ### Install ReNative CLI Source: https://github.com/flexn-io/renative-docs/blob/main/docs/overview/installation.md Install the ReNative CLI globally using npm. Ensure you have Node.js version 18.19.1 or newer installed. ```bash npm install rnv -g ``` -------------------------------- ### Install @flexn/create Plugin Source: https://github.com/flexn-io/renative-docs/blob/main/docs/plugins/overview.md Use this command to add the @flexn/create plugin to your project. ```bash npx rnv plugin add @flexn/create ``` -------------------------------- ### Create New ReNative Project Source: https://github.com/flexn-io/renative-docs/blob/main/docs/api/node/renative/index.md Start a new project using the ReNative CLI. ```bash rnv new ``` -------------------------------- ### Install Dependencies Source: https://github.com/flexn-io/renative-docs/blob/main/README.md Installs project dependencies using Yarn. ```bash yarn ``` -------------------------------- ### Install Fabric Plugin Source: https://github.com/flexn-io/renative-docs/blob/main/docs/plugins/overview.md This command installs the Fabric plugin, which is compatible with iOS and Android. ```bash npx rnv plugin add Fabric ``` -------------------------------- ### List Configurations Source: https://github.com/flexn-io/renative-docs/blob/main/docs/concepts/cli.md Prints out the current global and per-project configurations. ```bash rnv config list ``` -------------------------------- ### Install @flexn/sdk Plugin Source: https://github.com/flexn-io/renative-docs/blob/main/docs/plugins/overview.md Use this command to add the @flexn/sdk plugin to your project. ```bash npx rnv plugin add @flexn/sdk ``` -------------------------------- ### Install Certificates (macOS) Source: https://github.com/flexn-io/renative-docs/blob/main/docs/api/cli.md Installs certificates into the macOS keychain. This command is provided by @rnv/engine-rn. ```bash npx rnv crypto installCerts ``` -------------------------------- ### Launch App with Available iOS Simulators Source: https://github.com/flexn-io/renative-docs/blob/main/docs/platforms/ios.md Command to launch the application and let ReNative display a list of available iOS simulator options. ```bash rnv run -p ios -t ? ``` -------------------------------- ### areNodeModulesInstalled Source: https://github.com/flexn-io/renative-docs/blob/main/docs/api/node/rnv-core/modules.md Checks if the Node.js modules for the project are installed. Returns a boolean indicating the installation status. ```APIDOC ## areNodeModulesInstalled ### Description Checks if the Node.js modules for the project are installed. Returns a boolean indicating the installation status. ### Method `areNodeModulesInstalled(): boolean` ### Returns `boolean` - `true` if Node.js modules are installed, `false` otherwise. #### Defined in projects/npm.d.ts:3 ``` -------------------------------- ### Install @react-native-camera-roll/camera-roll Plugin Source: https://github.com/flexn-io/renative-docs/blob/main/docs/plugins/overview.md Install the @react-native-camera-roll/camera-roll plugin for your Renative project. This plugin is compatible with Android and iOS. ```bash npx rnv plugin add @react-native-camera-roll/camera-roll ``` -------------------------------- ### Install tipsi-stripe Plugin Source: https://github.com/flexn-io/renative-docs/blob/main/docs/plugins/overview.md Use this command to add the tipsi-stripe plugin to your Renative project. Note that this uses an experimental version. ```bash npx rnv plugin add tipsi-stripe ``` -------------------------------- ### Print Help Source: https://github.com/flexn-io/renative-docs/blob/main/docs/concepts/cli.md Displays the help message for the ReNative CLI. ```bash rnv ``` -------------------------------- ### Install Next-SEO Plugin Source: https://github.com/flexn-io/renative-docs/blob/main/docs/plugins/overview.md Use this command to integrate the next-seo plugin into your Renative project. It is compatible with all major platforms. ```bash npx rnv plugin add next-seo ``` -------------------------------- ### checkNpxIsInstalled Source: https://github.com/flexn-io/renative-docs/blob/main/docs/api/node/rnv-core/modules.md Verifies if npx is installed on the system. This is an asynchronous function that returns a promise resolving to `true` if npx is installed. ```APIDOC ## checkNpxIsInstalled ### Description Verifies if npx is installed on the system. This is an asynchronous function that returns a promise resolving to `true` if npx is installed. ### Method `checkNpxIsInstalled(): Promise` ### Returns `Promise` - A promise that resolves to `true` if npx is installed. #### Defined in projects/npm.d.ts:2 ``` -------------------------------- ### Run on Simulator Source: https://github.com/flexn-io/renative-docs/blob/main/docs/platforms/ios.md Commands to start the ReNative development server and run the application on an iOS simulator. ```bash rnv start rnv run -p ios ``` -------------------------------- ### Install Provisioning Certificates (macOS) Source: https://github.com/flexn-io/renative-docs/blob/main/docs/api/cli.md Installs provisioning certificates found in the workspace on macOS. This command is provided by @rnv/engine-rn. ```bash npx rnv crypto installProfiles ``` -------------------------------- ### Launch WebOS Emulator Source: https://github.com/flexn-io/renative-docs/blob/main/docs/platforms/webos.md Launches the webOS emulator using the ReNative CLI. Ensure the emulator is installed and configured. ```bash rnv target launch -p webos -t emulator ``` -------------------------------- ### Launch Emulator with Available Options Source: https://github.com/flexn-io/renative-docs/blob/main/docs/platforms/ios.md Command to launch an iOS emulator and let ReNative display a list of available target options. ```bash rnv target launch -p ios -t ? ``` -------------------------------- ### Install rnv-platform-info Plugin Source: https://github.com/flexn-io/renative-docs/blob/main/docs/plugins/overview.md Use this command to add the rnv-platform-info plugin to your Renative project. ```bash npx rnv plugin add rnv-platform-info ``` -------------------------------- ### Start React-Native Bundler Source: https://github.com/flexn-io/renative-docs/blob/main/docs/api/cli.md Starts the React-Native bundler. This command is provided by @rnv/engine-rn and supports options for resetting caches. ```bash npx rnv start ``` -------------------------------- ### printBoxStart Source: https://github.com/flexn-io/renative-docs/blob/main/docs/api/node/rnv-core/modules.md Returns a string representing the start of a formatted box, with optional additional string. ```APIDOC ## printBoxStart ### Description Returns a string representing the start of a formatted box, with optional additional string. ### Parameters #### Path Parameters - **str** (string) - Description not available - **str2?** (string) - Optional - Description not available ### Returns `string` ### Defined in logger/index.d.ts:25 ``` -------------------------------- ### Start Chromecast Server Only Source: https://github.com/flexn-io/renative-docs/blob/main/docs/platforms/chromecast.md Command to only start the local development server for the Chromecast platform without running the app. ```bash rnv start -p chromecast ``` -------------------------------- ### List Available Plugins Source: https://github.com/flexn-io/renative-docs/blob/main/docs/api/cli.md Shows a list of all available plugins for the project. This command depends on the 'project configure' command. ```bash npx rnv plugin list ``` -------------------------------- ### List Available Platforms Source: https://github.com/flexn-io/renative-docs/blob/main/docs/api/cli.md Lists all available platforms for the project. This command depends on the 'project configure' command. ```bash npx rnv platform list ``` -------------------------------- ### Install @flexn/shopify-flash-list Plugin Source: https://github.com/flexn-io/renative-docs/blob/main/docs/plugins/overview.md Use this command to add the @flexn/shopify-flash-list plugin to your project. ```bash npx rnv plugin add @flexn/shopify-flash-list ``` -------------------------------- ### isYarnInstalled Source: https://github.com/flexn-io/renative-docs/blob/main/docs/api/node/rnv-core/modules.md Checks if Yarn is installed on the system. This function does not require any parameters and returns a string indicating Yarn is installed or true if it is. ```APIDOC ## isYarnInstalled ### Description Checks if Yarn is installed on the system. ### Returns `string` | `true` - Indicates if Yarn is installed. ### Defined in projects/npm.d.ts:5 ``` -------------------------------- ### Install react-native-device-info Source: https://github.com/flexn-io/renative-docs/blob/main/docs/plugins/overview.md Use this command to add the react-native-device-info plugin to your Renative project. ```bash npx rnv plugin add react-native-device-info ``` -------------------------------- ### Install @react-native-community/blur Plugin Source: https://github.com/flexn-io/renative-docs/blob/main/docs/plugins/overview.md Install the @react-native-community/blur plugin for your Renative project. This plugin is compatible with Android, iOS, and Web platforms. ```bash npx rnv plugin add @react-native-community/blur ``` -------------------------------- ### Install theoplayer Plugin Source: https://github.com/flexn-io/renative-docs/blob/main/docs/plugins/overview.md Use this command to add the theoplayer plugin to your Renative project. ```bash npx rnv plugin add theoplayer ``` -------------------------------- ### Build Web App Source: https://github.com/flexn-io/renative-docs/blob/main/docs/platforms/web.md This command builds your deployable web application. The output will be in the `./platformBuilds/_web/public` directory. ```bash rnv build -p web ``` -------------------------------- ### Install renative Plugin Source: https://github.com/flexn-io/renative-docs/blob/main/docs/plugins/overview.md Use this command to add the renative plugin to your Renative project. ```bash npx rnv plugin add renative ``` -------------------------------- ### build Source: https://github.com/flexn-io/renative-docs/blob/main/docs/api/cli.md Builds the project binary. ```APIDOC ## build ### Description Build project binary. ### Provided By @rnv/engine-rn ### Depends On [`package`](#package) ### Available Options [`provisioning-style`](#provisioning-style), [`provision-profile-specifier`](#provision-profile-specifier), [`code-sign-identity`](#code-sign-identity), [`xcodebuild-args`](#xcodebuild-args) ### Example ```bash npx rnv build ``` ``` -------------------------------- ### Launch Tizen Emulator Source: https://github.com/flexn-io/renative-docs/blob/main/docs/platforms/tizenmobile.md Launches a specific Tizen simulator. Ensure you have the required TV VM setup. ```bash rnv target launch -p tizenmobile -t M-5.0-x86 ``` -------------------------------- ### Example of Plugin Overrides in renative.json Source: https://github.com/flexn-io/renative-docs/blob/main/docs/upgrades/1.0.md This example shows plugin overrides that should be removed in ReNative 1.0. New versions of plugins are inherited from the template. ```json "plugins": { "@react-native-community/cli-platform-ios": "source:rnv", "@react-native-community/cli": "source:rnv", "react-native-tvos": "source:rnv", "react-native-web": "source:rnv", "next": "source:rnv" } ``` -------------------------------- ### isTemplateInstalled Source: https://github.com/flexn-io/renative-docs/blob/main/docs/api/node/rnv-core/modules.md Checks if a specific Renative template is installed in the project. It takes an RnvContext object as input and returns the template name if installed, or false otherwise. ```APIDOC ## isTemplateInstalled ### Description Checks if a specific Renative template is installed. ### Parameters #### Path Parameters - `c` (RnvContext) - Required - The Renative context object. ### Returns `string` | `false` - The name of the installed template, or false if not installed. ### Defined in templates/index.d.ts:7 ``` -------------------------------- ### Build Flavour Injectors Example Source: https://github.com/flexn-io/renative-docs/blob/main/docs/concepts/config-folders.md Demonstrates how to inject build-flavor specific files into a project before the build process. This is useful for configurations like Firebase or Crashlytics. ```directory structure . ├── appConfigs └── helloworld ├── assets ├── plugins │ └── some-plugin │ └── builds │ ├── android@release │ │ └── fileToBeInjectedInReleaseMode.txt │ └── android@debug │ └── fileToBeInjectedInDebugMode.txt └── builds ├── android@release │ └── fileToBeInjectedInReleaseMode.txt └── android@debug └── fileToBeInjectedInDebugMode.txt ``` -------------------------------- ### Install @react-navigation/elements Plugin Source: https://github.com/flexn-io/renative-docs/blob/main/docs/plugins/overview.md Install the @react-navigation/elements plugin to utilize pre-built UI components for navigation within your Renative project. This can speed up UI development. ```bash npx rnv plugin add @react-navigation/elements ``` -------------------------------- ### Connecting a Hook to a Build Pipe Source: https://github.com/flexn-io/renative-docs/blob/main/docs/concepts/build-hooks.md Shows how to connect a custom hook method to a predefined ReNative build pipe. This example hooks the 'hello' function to run before 'rnv configure'. ```javascript const pipes = { 'configure:before': hooks.hello }; ``` -------------------------------- ### checkRequiredPackage Source: https://github.com/flexn-io/renative-docs/blob/main/docs/api/node/rnv-core/modules.md Checks if a required package is installed and meets the specified version requirements. It can optionally skip asking the user, skip installation, or skip version checking. ```APIDOC ## checkRequiredPackage ### Description Checks if a required package is installed and meets the specified version requirements. It can optionally skip asking the user, skip installation, or skip version checking. ### Parameters #### Path Parameters - `c` (RnvContext) - Required - The Renative context object. - `pkg` (string) - Required - The name of the package to check. - `version` (string) - Required - The required version of the package. - `type` (NpmDepKey) - Required - The type of dependency. - `skipAsking` (boolean) - Optional - If true, skips asking the user for confirmation. - `skipInstall` (boolean) - Optional - If true, skips installing the package if it's missing. - `skipVersionCheck` (boolean) - Optional - If true, skips checking the package version. ### Returns `Promise` - A promise that resolves to true if the package is valid, false otherwise. ``` -------------------------------- ### Install @react-navigation/native Plugin Source: https://github.com/flexn-io/renative-docs/blob/main/docs/plugins/overview.md Install the @react-navigation/native plugin, which is essential for integrating React Navigation with native mobile platforms in your Renative project. It provides core navigation functionalities. ```bash npx rnv plugin add @react-navigation/native ``` -------------------------------- ### Run ReNative App on Web Source: https://github.com/flexn-io/renative-docs/blob/main/docs/overview/quickstart.md Builds and runs the current ReNative application in a web browser. ```bash rnv run -p web ``` -------------------------------- ### getAppFolder Source: https://github.com/flexn-io/renative-docs/blob/main/docs/api/node/rnv-core/modules.md Gets the application folder path. ```APIDOC ## getAppFolder ### Description Gets the application folder path. ### Parameters #### Path Parameters - `c` (RnvContext) - The Renative context object. - `isRelativePath?` (boolean) - Whether to return a relative path. ### Returns `string` - The path to the app folder. ``` -------------------------------- ### Install react-navigation-drawer Plugin Source: https://github.com/flexn-io/renative-docs/blob/main/docs/plugins/overview.md Use this command to add the react-navigation-drawer plugin to your Renative project. ```bash npx rnv plugin add react-navigation-drawer ``` -------------------------------- ### installPackageDependencies Source: https://github.com/flexn-io/renative-docs/blob/main/docs/api/node/rnv-core/modules.md Asynchronously installs package dependencies for the project. ```APIDOC ## installPackageDependencies ### Description Asynchronously installs package dependencies for the project. ### Method Not specified (likely a function call in an SDK) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **c** (RnvContext) - The Renative context object. - **failOnError** (boolean) - Optional - Whether to fail the process if an error occurs during installation. ### Request Example ```javascript installPackageDependencies(rnvContext, true) ``` ### Response #### Success Response - **Promise** - A promise that resolves with a boolean indicating if installation was successful. #### Response Example ```json true ``` ``` -------------------------------- ### Install react-native-media-query Plugin Source: https://github.com/flexn-io/renative-docs/blob/main/docs/plugins/overview.md Use this command to add the react-native-media-query plugin to your Renative project. ```bash npx rnv plugin add react-native-media-query ``` -------------------------------- ### installPackageDependenciesAndPlugins Source: https://github.com/flexn-io/renative-docs/blob/main/docs/api/node/rnv-core/modules.md Asynchronously installs both package dependencies and plugins for the project. ```APIDOC ## installPackageDependenciesAndPlugins ### Description Asynchronously installs both package dependencies and plugins for the project. ### Method Not specified (likely a function call in an SDK) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **c** (RnvContext) - The Renative context object. ### Request Example ```javascript installPackageDependenciesAndPlugins(rnvContext) ``` ### Response #### Success Response - **Promise** - A promise that resolves when installation is complete. #### Response Example ```json null ``` ``` -------------------------------- ### Install react-native-image-crop-picker-no-npm Source: https://github.com/flexn-io/renative-docs/blob/main/docs/plugins/overview.md Use this command to add the react-native-image-crop-picker-no-npm plugin to your project. ```bash npx rnv plugin add react-native-image-crop-picker-no-npm ```