CLI Overview

@pwa-kit/cli has two commands:

• init: create/configure a PWAKit project
• sync: apply config into native project files

Install and run

Recommended (no global install):

npx @pwa-kit/cli init my-pwa-ios

Optional global install:

npm install -g @pwa-kit/cli
pwa-kit init my-pwa-ios

Run sync after manual edits to pwa-config.json:

cd my-pwa-ios && npx @pwa-kit/cli sync

No-clone workflow

You do not need to clone eddmann/pwa-kit to build an app.

If init does not find PWAKitApp.xcodeproj, it downloads the latest template release, extracts it, writes config, and runs sync.

Command behavior summary

• init:
  • interactive when --url is omitted in a TTY
  • non-interactive when --url is provided
  • validates URL/bundle/color/orientation/display inputs
  • fetches web manifest when available (name/colors/orientation/display/icon)
  • runs sync automatically
• sync:
  • requires project + config file
  • supports apply, --dry-run, and --validate

Read next

• Detailed setup flow: init Command
• Sync behavior and validation: sync Command
• Full flag matrix and examples: CLI Reference