firebase-ios-sdk README

The project's README from github.com/firebase/firebase-ios-sdk. As one markdown file: README.md.


[!WARNING] CocoaPods: New versions of the Firebase Apple SDK will no longer be published to CocoaPods after October 2026. Existing CocoaPods versions will remain available and installations will remain functional. See the migration guide for more information.

[!TIP] Preview Release: Firebase AI Logic's Gemini Foundation Models framework adapter is now available in preview. Get started by visiting the documentation.

Firebase Apple Open Source Development

This repository contains the source code for all Apple platform Firebase libraries except FirebaseAnalytics.

Firebase is an app development platform with libraries, services, and tools to help you build, grow, and monetize your app. Learn more about Firebase at the official Firebase website.

Supported Firebase Products

The following products are open-source and included in this repository:

[!NOTE] Firebase Analytics is not open-source, but its pre-compiled binaries are included when installing Firebase via Swift Package Manager or CocoaPods.

Installation

See the subsections below for details about the different installation methods. Where available, it's recommended to install libraries with a Swift suffix to get the best experience when writing your app in Swift.

Swift Package Manager installation

Find instructions for installing using Swift Package Manager in the Firebase get started documentation.

CocoaPods installation

Find instructions for installing with CocoaPods (pod install) in the Firebase installation options documentation.

Note: To accommodate the read-only announcement from CocoaPods, Firebase will stop publishing new versions to CocoaPods in October 2026. Learn more.

Install from GitHub

You can install from GitHub to access the Firebase repo at other branches, tags, or commits.

Background

For instructions and options about overriding pod source locations, see the Podfile Syntax Reference.

Access Firebase source snapshots

All official releases are tagged in this repo and available via CocoaPods. To access a local source snapshot or unreleased branch, use Podfile directives. Here are some example directives which use FirebaseFirestore as the example library.

To access FirebaseFirestore via a branch:

pod 'FirebaseCore', :git => 'https://github.com/firebase/firebase-ios-sdk.git', :branch => 'main'
pod 'FirebaseFirestore', :git => 'https://github.com/firebase/firebase-ios-sdk.git', :branch => 'main'

To access FirebaseFirestore via a checked-out version of the firebase-ios-sdk repo:

pod 'FirebaseCore', :path => '/path/to/firebase-ios-sdk'
pod 'FirebaseFirestore', :path => '/path/to/firebase-ios-sdk'

Carthage (iOS only)

Find instructions for the experimental Carthage distribution (iOS only) at Carthage.md within this repo.

Use Firebase from a Framework or a library

Find details about using Firebase from a Framework or a library at firebase_in_libraries.md within this repo.

Building with Firebase on Apple platforms

Firebase provides official beta support for macOS, Catalyst, and tvOS. visionOS and watchOS are community supported. Thanks to community contributions for many of the multi-platform PRs.

At this time, most Firebase products are available across Apple platforms. There are still a few gaps, especially on visionOS and watchOS. For details about the current support matrix, see this chart in the Firebase documentation.

visionOS

Where supported, visionOS works as expected with the exception of Firestore via Swift Package Manager where it is required to use the source distribution.

To enable the Firestore source distribution, quit Xcode and open the desired project from the command line with the FIREBASE_SOURCE_FIRESTORE environment variable: open --env FIREBASE_SOURCE_FIRESTORE /path/to/project.xcodeproj. To go back to using the binary distribution of Firestore, quit Xcode and open Xcode like normal, without the environment variable.

watchOS

Thanks to contributions from the community, many of Firebase SDKs now compile, run unit tests, and work on watchOS. See the Independent Watch App Sample.

Keep in mind that watchOS is not officially supported by Firebase. While we can catch basic unit test issues with GitHub Actions, there may be some changes where the SDK no longer works as expected on watchOS. If you encounter this, please file an issue.

During app setup in the console, you may get to a step that mentions something like "Checking if the app has communicated with our servers". This relies on FirebaseAnalytics and will not work on watchOS. It's safe to ignore the message and continue, the rest of the SDKs will work as expected.

Additional Crashlytics notes for watchOS

Using Crashlytics with watchOS has limited support. Due to watchOS restrictions, mach exceptions and signal crashes are not recorded. (Crashes in SwiftUI are generated as mach exceptions, so will not be recorded).

Combine

Thanks to contributions from the community, FirebaseCombineSwift contains support for Apple's Combine framework. This module is currently under development and not yet supported for use in production environments. For more details, see the docs within this repo.

Roadmap

See Roadmap for more about the Firebase Apple SDK Open Source plans and directions.

Contributing

For information on how to contribute, set up the development environment, build, or test the SDK, see the Contributing Guide.

License

The contents of this repository are licensed under the Apache License, version 2.0.

Your use of Firebase is governed by the Terms of Service for Firebase Services.

firebase-ios-sdk (firebase/firebase-ios-sdk)

tvos
Searching Database…

7K ·GitHub
Firebase-ios-sdk
What is this?This is the official collection of Firebase SDKs for Apple platforms, covering libraries like Authentication, Firestore, Cloud Functions, Messaging, Crashlytics, Storage and more.
Is this one library or a bundle of many?It is a monorepo bundling many separate Firebase libraries (Auth, Firestore, Functions, Messaging, Crashlytics, Storage, etc.) that you add individually to your app.
How do I add it to my app?Install via Swift Package Manager (recommended) following the Firebase get started docs, or via CocoaPods with pod install; you can also pull from GitHub directly for branches, tags, or commits.
Do I need Xcode and a Firebase project set up first?Yes, you need an Xcode project and a configured Firebase project/console; CocoaPods or Swift Package Manager is used to pull in the libraries.
Is CocoaPods still a safe long-term choice?No, CocoaPods publishing will stop in October 2026; existing CocoaPods versions keep working but you should plan to migrate to Swift Package Manager.
Does this work on macOS and tvOS too, or just iOS?Firebase officially beta-supports macOS, Catalyst, and tvOS, while visionOS and watchOS are only community-supported with some gaps, and FirebaseAnalytics itself is closed-source.
Does watchOS support Crashlytics fully?No, Crashlytics on watchOS has limited support because watchOS restrictions prevent recording mach exceptions and signal crashes, including SwiftUI crashes.
What is Firebase AI Logic mentioned at the top?It is a preview Gemini Foundation Models framework adapter, part of the newer FirebaseAI product included in this repo.
Can I use an unreleased branch of Firestore instead of a release?Yes, you can install from GitHub via Podfile directives to pull FirebaseFirestore from a specific branch, tag, commit, or a local checkout of the repo.
Is Combine support production-ready?No, the community-contributed FirebaseCombineSwift module is still under development and not yet supported for production use.
What are similar projects?MMKV, react-native-firebase, CocoaLumberjack, AFNetworking, SDWebImage, Mantle, swift-composable-architecture, realm-swift
Which topics is it in?crash-reporting, visionos, push-notifications, firebase, watchos, tvos, objective-c, storage, messaging, analytics, apple, authentication
Creator
firebase
Size
82.9 MB
Stars
7K
Updated
CommitOct 15Release13.0.1Oct 07
Age
9y
Commits · 90 Days