Syntax
Arguments
platform
The platform to install. Optional.android- Install Android resources onlyios- Install iOS resources only (macOS required)both- Install both platforms
Options
—force, -F, —fresh
Overwrite existing files and directories.—with-icu
Include ICU (International Components for Unicode) support for Android. Adds approximately 30MB to the final app size.—without-icu
Explicitly exclude ICU support for Android.—skip-php
Do not download the PHP binaries during installation.Examples
Install both platforms (macOS only)
Install Android only with ICU support
Reinstall iOS, overwriting existing files
Quick install with defaults
What it does
- Prompts for App ID: If
NATIVEPHP_APP_IDis not set in your.envfile, you’ll be asked to provide a bundle identifier (e.g.,com.example.myapp) - Creates directories: Sets up
nativephp/directory structure in your project - Downloads resources: Installs platform-specific build tools and PHP binaries
- Publishes assets: Copies templates and configuration files
- Configures project: Sets up Android Studio/Xcode project files
- Creates CLI wrapper: Adds the
nativeexecutable to your project root
Platform requirements
Android- Not supported in WSL (Windows Subsystem for Linux)
- Requires native Windows, Linux, or macOS
- Only available on macOS
- Requires Xcode installed
See also
- native:run - Build and run your app
- native:package - Package for distribution