Docs UI Examples Benchmarks Showcase

Configuration (`myphp.json`)

myphp.json, at the root of a project, describes the application and how myphp dev, myphp run, myphp build, and myphp generate package it. Every field is optional:

{
  "name": "Notes",
  "displayName": "Notes",
  "identifier": "com.example.notes",
  "version": "1.0.0",
  "entry": "app.php",
  "out": "build",
  "icon": "resources/icon.png",
  "exclude": ["design", "docs"],
  "i18n": {
    "dir": "locales",
    "source": "en"
  }
}

Core fields

FieldDefaultDescription
namedirectory nameApplication identifier/slug name (used for executable and bundle names)
displayNamenameLocalized user-facing title shown on the home screen, Dock, and title bar
slugderived from nameLowercase ASCII letters, digits, and hyphens for archive and package file names
identifiercom.myphp.<name>Reverse-DNS bundle identifier (CFBundleIdentifier on macOS/iOS, applicationId on Android)
version"0.1.0"Semantic version string
entry"app.php" (or "main.php")Main PHP entry script
out"dist"Output directory for packaged builds
icon"resources/icon.png"Square PNG icon (1024×1024 recommended), converted automatically for all 5 platforms
exclude[]Extra directories or glob patterns excluded from app bundles (tests/, *.local.php are excluded automatically)
resources[]Extra files or directories copied into App::path(PathName::Resources)
urlSchemes[]Custom URL schemes handled by the app (myapp://... via App::onOpenURL)
fileAssociations[]Document file extensions associated with the app ([{ "ext": ["md"], "name": "Markdown" }])
i18nnullLocalization catalog directory and source locale ({ "dir": "locales", "source": "en" })
ffigen / jnigen[]Native C/ObjC (ffigen) and Android Java (jnigen) wrapper definitions generated by myphp generate

Platform-specific options

macos

  • icon: Optional .icon (Xcode 26 Icon Composer), Assets.car, or .icns overriding icon.
  • minimumSystemVersion: Minimum macOS version (default "12.0").
  • signingIdentity: Code-signing identity (default "-", ad-hoc signing).
  • entitlements: Path to .entitlements plist.
  • provisioningProfile: Path to .provisionprofile embedded before signing.
  • notarize: { "keychainProfile": "..." } for Apple notarization during myphp build.

windows

  • displayName, installDirName, publisher: Metadata for the .exe version resource and NSIS installer.
  • certificate, signCommand, timestampUrl: Authenticode code signing options.

linux

  • maintainer: Package maintainer (Name <email>) for .deb and Arch PKGBUILD.
  • comment, categories: Desktop entry metadata.