Workflows
The command blocks below have an npm, pnpm, Yarn and Bun tab; the site remembers the one you pick. See Getting Started to install the CLI.
Analyze An Expo Project
Audience: Expo maintainers and bundler authors.
npx vifx doctor <expo-project-path>
npx vifx setup <expo-project-path> --yes --expo-go
npx vifx build <expo-project-path>
npx vifx expo audit <expo-project-path>
npx vifx expo dev <expo-project-path> --platform ios --expo-go
npx vifx expo export <expo-project-path> --out-dir dist/expopnpm vifx doctor <expo-project-path>
pnpm vifx setup <expo-project-path> --yes --expo-go
pnpm vifx build <expo-project-path>
pnpm vifx expo audit <expo-project-path>
pnpm vifx expo dev <expo-project-path> --platform ios --expo-go
pnpm vifx expo export <expo-project-path> --out-dir dist/expoyarn vifx doctor <expo-project-path>
yarn vifx setup <expo-project-path> --yes --expo-go
yarn vifx build <expo-project-path>
yarn vifx expo audit <expo-project-path>
yarn vifx expo dev <expo-project-path> --platform ios --expo-go
yarn vifx expo export <expo-project-path> --out-dir dist/expobun vifx doctor <expo-project-path>
bun vifx setup <expo-project-path> --yes --expo-go
bun vifx build <expo-project-path>
bun vifx expo audit <expo-project-path>
bun vifx expo dev <expo-project-path> --platform ios --expo-go
bun vifx expo export <expo-project-path> --out-dir dist/expoUse this flow to move from config to Vite bundle production, audit evidence, the Expo Go dev server, and export artifacts. Keep EAS and native app binary workflows unchanged.
Analyze A React Native Project
Audience: bare React Native maintainers.
npx vifx doctor <rn-project-path>
npx vifx metro inspect <rn-project-path> --platform ios
npx vifx init <rn-project-path> --write
npx vifx build <rn-project-path> --platform iospnpm vifx doctor <rn-project-path>
pnpm vifx metro inspect <rn-project-path> --platform ios
pnpm vifx init <rn-project-path> --write
pnpm vifx build <rn-project-path> --platform iosyarn vifx doctor <rn-project-path>
yarn vifx metro inspect <rn-project-path> --platform ios
yarn vifx init <rn-project-path> --write
yarn vifx build <rn-project-path> --platform iosbun vifx doctor <rn-project-path>
bun vifx metro inspect <rn-project-path> --platform ios
bun vifx init <rn-project-path> --write
bun vifx build <rn-project-path> --platform iosUse captured Metro output as the reference before comparing Vifx/Vite bundles.
Inspect Metro Output
Audience: bundler researchers.
npx vifx metro inspect <project-path> --platform ios
npx vifx metro inspect <project-path> --platform android --json > report.jsonpnpm vifx metro inspect <project-path> --platform ios
pnpm vifx metro inspect <project-path> --platform android --json > report.jsonyarn vifx metro inspect <project-path> --platform ios
yarn run --silent vifx metro inspect <project-path> --platform android --json > report.jsonbun vifx metro inspect <project-path> --platform ios
bun vifx metro inspect <project-path> --platform android --json > report.jsonvifx metro inspect reads Metro output captured under metro-output/<platform> in the project. Metro is the comparison baseline. Vifx should make differences visible before claiming replacement behavior.
Run Compatibility Tests
Audience: package authors and CI maintainers.
vifx compat run runs the compatibility matrix against the Metro and Vifx adapters and prints a terminal, JSON or Markdown report. The matrix is built from the fixtures in the Vifx repository, so it runs from a clone of the repository; CONTRIBUTING.md explains how. See the compatibility report format for the report schema.
Treat compatibility as a report with context, not a single boolean.
Use Direct Vite Configuration
Audience: maintainers who need a hand-authored Vite surface.
npx vifx setup <expo-project-path> --yes --with-vite-config
npx vifx build <expo-project-path>
npx vifx expo audit <expo-project-path>pnpm vifx setup <expo-project-path> --yes --with-vite-config
pnpm vifx build <expo-project-path>
pnpm vifx expo audit <expo-project-path>yarn vifx setup <expo-project-path> --yes --with-vite-config
yarn vifx build <expo-project-path>
yarn vifx expo audit <expo-project-path>bun vifx setup <expo-project-path> --yes --with-vite-config
bun vifx build <expo-project-path>
bun vifx expo audit <expo-project-path>Direct Vite config is an advanced opt-in. It is not required for the main setup flow.
Start Expo Development
Audience: Expo app developers.
npx vifx expo dev <expo-project-path> --platform ios --expo-go
npx vifx expo dev <expo-project-path> --platform android --expo-go --port 5174
npx vifx expo dev <expo-project-path> --platform iospnpm vifx expo dev <expo-project-path> --platform ios --expo-go
pnpm vifx expo dev <expo-project-path> --platform android --expo-go --port 5174
pnpm vifx expo dev <expo-project-path> --platform iosyarn vifx expo dev <expo-project-path> --platform ios --expo-go
yarn vifx expo dev <expo-project-path> --platform android --expo-go --port 5174
yarn vifx expo dev <expo-project-path> --platform iosbun vifx expo dev <expo-project-path> --platform ios --expo-go
bun vifx expo dev <expo-project-path> --platform android --expo-go --port 5174
bun vifx expo dev <expo-project-path> --platform iosThe --expo-go workflow serves the Expo Go manifest, bundle, source maps and assets from Vifx/Vite artifacts, with Fast Refresh on by default. One server serves one platform, so the Android server runs on a second port. See Dev Server and Fast Refresh for the details and the current limitations.
Without --expo-go, the server requires a configured Expo target with reactNativeCompat: "web" and serves the browser preview.
Generate Expo Export Artifacts
Audience: maintainers working on Metro-free Expo export artifacts.
npx vifx expo export <expo-project-path> --out-dir dist/expo
npx vifx expo audit <expo-project-path> --export-root dist/expopnpm vifx expo export <expo-project-path> --out-dir dist/expo
pnpm vifx expo audit <expo-project-path> --export-root dist/expoyarn vifx expo export <expo-project-path> --out-dir dist/expo
yarn vifx expo audit <expo-project-path> --export-root dist/expobun vifx expo export <expo-project-path> --out-dir dist/expo
bun vifx expo audit <expo-project-path> --export-root dist/expoThe generated output is limited to bundles, source maps, assets, manifest.json, and metadata.json.
