Capacitor Config Builder (capacitor.config.ts / .json)
Set your app ID, name and web directory, add server and plugin options, and get a capacitor.config.ts or capacitor.config.json file you can drop into an Ionic or Capacitor project.
Use the tool
Why this tool exists
Capacitor reads one config file at sync time, and a typo in a key is ignored without complaint. The plugin sections for the splash screen, status bar, keyboard and push notifications each have their own option names, and it is hard to remember them while you are also fighting a native build.
This builder writes the file in either TypeScript or JSON from a short form. It also reminds you when a live-reload server URL is present, because that setting must not ship in a release build. Everything is produced in your browser, so internal hostnames and bundle IDs are not sent anywhere.
How to use it
- Enter the app ID, app name and webDir where your built web assets live.
- Optionally set a server URL for live reload, cleartext traffic and the Android scheme.
- Tick the SplashScreen, StatusBar, Keyboard or PushNotifications plugins you use and set their values.
- Choose TypeScript or JSON, copy the result into your project root and run npx cap sync.
Frequently asked questions
Should I keep server.url in a production build?
No. The server URL points the native shell at a development server for live reload. Remove it before you build release binaries, or the app will try to load your dev machine instead of the bundled files.
What does the cleartext option change?
It sets server.cleartext and allows mixed content on Android, so plain HTTP is permitted. Use it only for local development against an HTTP server, never for a released app.
Does it cover every Capacitor setting?
No. It covers the common fields and four popular plugins. Other plugins and platform options can be added by hand to the generated file, following the Capacitor documentation.