Developing

The taurify CLI inspects your application project to determine default configuration values for your application dev and build scripts, dev server URL and build dist output path. It automatically supports Vite, Webpack, create-react-app, Parcel and esbuild. If it cannot resolve the configuration automatically, you must configure the productionSrc, devSrc, beforeDevCommand and beforeBuildCommand values. For more information, see the configuration documentation page.

Desktop

The taurify dev starts your development server and instantly opens a window that loads your frontend as a native application.

npm

npm exec taurify dev

yarn

yarn taurify dev

pnpm

pnpm taurify dev

bun

bunx taurify dev

Opening the Web Inspector

You can open the Web Inspector to debug your application by performing a right-click on the webview and clicking “Inspect” or using the Ctrl + Shift + I shortcut on Windows and Linux or Cmd + Option + I shortcut on macOS.

Mobile

Taurify lets you run your app directly on physical mobile devices or emulators. Additionally, you can use the Taurify mobile app to develop your app without needing to install any dependencies.

Caution

To develop your app for mobile, your development server must listen on the local IP address and your mobile device must be connected on the same network.

In order to accomplish this, either use the host option in your development server (such as the Vite --host CLI option) or rely on the TAURIFY_DEV_HOST or TAURI_DEV_HOST environment variable, which contains the IP address that your development server can use to be reachable by the mobile app.

Note that the TAURIFY_DEV_HOST and TAURI_DEV_HOST environment variables are only available on mobile commands.

Example Vite configuration, which also configures HMR to work with the mobile app:

vite.config.js

import { defineConfig } from 'vite'

const host = process.env.TAURI_DEV_HOST

export default defineConfig({
  server: {
    host: host || false,
    port: 3001,
    strictPort: false,
    hmr: host
      ? {
          protocol: 'ws',
          host,
          port: 3002
        }
      : undefined
  }
})

Running on iOS

To run your app on iOS, you must have a Mac with Xcode installed.

The taurify dev --ios command starts your app on a connected physical iOS device, prompting for a simulator to be selected if none is connected.

npm

npm exec taurify dev -- --ios

yarn

yarn taurify dev --ios

pnpm

pnpm taurify dev --ios

bun

bunx taurify dev --ios

It is recommended to use the --open flag to open the app on Xcode for the initial setup. Xcode guides you through the process of connecting a physical device or creating a new simulator.

npm

npm exec taurify dev -- --ios --open

yarn

yarn taurify dev --ios --open

pnpm

pnpm taurify dev --ios --open

bun

bunx taurify dev --ios --open

Running on Android

To run your app on Android, you must have a device with Android Studio installed.

The taurify dev --android command starts your app on a connected physical Android device, prompting for an Android emulator to be selected if none is connected.

npm

npm exec taurify dev -- --android

yarn

yarn taurify dev --android

pnpm

pnpm taurify dev --android

bun

bunx taurify dev --android

It is recommended to use the --open flag to open the app on Android Studio for the initial setup. Android Studio guides you through the process of connecting a physical device or creating a new emulator.

npm

npm exec taurify dev -- --android --open

yarn

yarn taurify dev --android --open

pnpm

pnpm taurify dev --android --open

bun

bunx taurify dev --android --open

Taurify Mobile App

The taurify dev --mobile command can be used to start your app for mobile. It prints a QR code that must be read with the Taurify mobile app so you can develop your application on Android and iOS without worrying about Android Studio or Xcode.

npm

npm exec taurify dev -- --mobile

yarn

yarn taurify dev --mobile

pnpm

pnpm taurify dev --mobile

bun

bunx taurify dev --mobile

Download the Taurify app for iOS or Android to start developing your app for mobile:

Opening the Web Inspector

• iOS

  Safari must be used to access the Web Inspector for your iOS application.

  Open the Safari on your Mac machine, choose Safari > Settings in the menu bar, click Advanced, then select Show features for web developers.

  If you are running on a physical device you must enable Web Inspector in Settings > Safari > Advanced.

  After following all steps you should see a Develop menu in Safari, where you will find the connected devices and applications to inspect. Select your device or simulator and click on localhost to open the Safari Developer Tools window.

• Android

  The inspector is enabled by default for Android emulators, but you must enable it for physical devices. Connect your Android device to the computer, open the Settings app in the Android device, select About, scroll to Build Number and tap that 7 times. This will enable Developer Mode for your Android device and the Developer Options settings.

  To enable application debugging on your device you must enter the Developer Options settings, toggle on the developer options switch and enable USB Debugging.

  Note

  Each Android distribution has its own way to enable the Developer Mode, please check your manufacturer’s documentation for more information.

  The Web Inspector for Android is powered by Google Chrome’s DevTools and can be accessed by navigating to chrome://inspect in the Chrome browser on your computer. Your device or emulator should appear in the remote devices list if your Android application is running, and you can open the developer tools by clicking inspect on the entry matching your device.