Initialize

Connect a Flutter project to an app in the console. You do this once per project; it works for Android and iOS together.

Before you start

Connect the project

  1. Run init

    From the project root, the folder with pubspec.yaml:

    $ overpush init --app-id cp_your_app_id

    Without --app-id, it asks for it. If this computer isn't signed in yet, your browser opens to sign in, and the project is connected as soon as you do. There's nothing to copy back.

  2. Add the package

    $ flutter pub add overpush

    That's the only change to your app's code. You don't call anything from main.dart.

  3. Commit

    Commit overpush.yaml and the pubspec.yaml change. Teammates who clone the project run overpush init once on their own computer.

What init changes

FileWhatCommit it?
overpush.yamlThe app id, and any options you add later.Yes
.overpush/keyThis computer's key for this app.No. It's added to .gitignore for you.
AndroidManifest.xmlAdds the INTERNET permission if the app doesn't have it, so Android can download patches. --no-fix only reports it.Yes

The app id isn't a secret; it ends up inside your app. What lets a computer publish is its key, which stays on that computer.

Several computers, and CI

Each computer that runs overpush init gets its own key. The console lists them under the app's Settings, where you can remove one; that computer stops being able to publish at once. For CI, see Continuous integration.

Reconnecting

To connect a project to a different app, or start fresh:

$ overpush init --force

To disconnect this computer, overpush logout removes its key.

What's next

Create a releaseBuild the version you put in the store. Flutter versionsWhat's supported on each platform.