Text of github.com › home-assistant › iOS as Styx crawled it on Nov 18, 2026. The page may have changed since. Only its words are kept, without pictures or layout.

Open the live page

GitHub - home-assistant/iOS: :iphone: Home Assistant for Apple platforms · GitHub

Skip to content You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert Branches Tags Open more actions menu Latest commit History 5,073 Commits 5,073 Commits Folders and files Name Name Last commit message Last commit date .agents/ skills .agents/ skills .claude .claude .githooks .githooks .github .github BuildTools BuildTools Configuration Configuration HomeAssistant.xcodeproj HomeAssistant.xcodeproj Sources Sources Tests Tests Tools Tools WatchApp/ Assets.xcassets WatchApp/ Assets.xcassets fastlane fastlane icons icons .claude.json .claude.json .cursorrules .cursorrules .env.sample .env.sample .gitattributes .gitattributes .gitignore .gitignore .rubocop.yml .rubocop.yml .ruby-version .ruby-version .swiftformat .swiftformat .swiftlint.yml .swiftlint.yml .windsurfrules .windsurfrules .yamllint.yml .yamllint.yml AGENTS.md AGENTS.md AI_POLICY.md AI_POLICY.md CLA.md CLA.md CLAUDE.md CLAUDE.md CODE_OF_CONDUCT.md CODE_OF_CONDUCT.md CONTRIBUTING.md CONTRIBUTING.md Gemfile Gemfile Gemfile.lock Gemfile.lock LICENSE.md LICENSE.md Package.resolved Package.resolved README.md README.md codecov.yaml codecov.yaml swiftgen.yml swiftgen.yml swiftgen.yml.file-list.in swiftgen.yml.file-list.in swiftgen.yml.file-list.out swiftgen.yml.file-list.out Repository files navigation Home Assistant for Apple Platforms Getting Started Home Assistant uses Bundler, Homebrew, and SPM to manage build dependencies.

You'll need Xcode 27.0 (or later), currently a beta, which you can download from Apple Developer Downloads . You can get the app running using the following commands: git clone https://github.com/home-assistant/iOS.git cd iOS # Install the Ruby tooling (Fastlane) using one of the following. # Swift Package Manager dependencies are resolved automatically by Xcode. # # install ruby via homebrew, use that brew install ruby@3.1 $( brew --prefix ) /opt/ruby@3.1/bin/bundle install # # install ruby via rbenv, use that brew install rbenv ruby-build rbenv install bundle install # # install ruby via mise, use that brew install mise mise install bundle install Once this completes, you can launch HomeAssistant.xcodeproj and run the App-Debug scheme onto your simulator or iOS device.

Testing just the frontend To just test the frontend , you can use a simulator version built by our GitHub actions. Install Xcode from the App Store making sure it's at least the version noted above. You do not need to install or run anything else. Launch the simulator at /Applications/Xcode.app/Contents/Developer/Applications/Simulator.app or in Xcode under the Xcode menu > Open Developer Tool. Open a simulator under File > Open Simulator.

You can install older versions of iOS in Xcode's Components preferences. Download a simulator build from the the GitHub action under "Artifacts." Drag the result .app on drop it on top of the simulator. Locate the app on the home screen and click it to launch. The simulator behaves different than you might expect: Action Effect Click Tap Click & drag Scroll Hold ⌥ Add a second touch point Hold ⇧⌥ Move both touch points ⌘←, ⌘→ Rotate ⌘S Take screenshot ⌘R Record video ⌘K Toggle software keyboard You can now debug the WebView in this simulator build using Safari's Web Inspector: Make sure "Show Develop menu in menu bar" is enabled in Safari's Advanced preferences.

Under the Develop menu, expand the "Simulator" menu for the simulator you've opened. Choose the WebView you want to inspect. A new window will open. Code Signing Although the app is set up to use Automatic provisioning for Debug builds, you'll need to customize a few of the options. This is because the app makes heavy use of entitlements that require code signing, even for simulator builds. Edit the file Configuration/HomeAssistant.overrides.xcconfig (which will not exist by default and is ignored by git) and add the following: DEVELOPMENT_TEAM = YourTeamID BUNDLE_ID_PREFIX = some.bundle.prefix Xcode should generate provisioning profiles in your Team ID and our configuration will disable features your team doesn't have like Critical Alerts.

You can find your Team ID on Apple's developer portal ; it looks something like ABCDEFG123 . Code style Linters run as part of Pull Request checks. Additionally, some linting requirements can be autocorrected. # checks for linting problems, doesn't fix bundle exec fastlane lint # checks for linting problems and fixes them bundle exec fastlane autocorrect To run autocorrect automatically before each commit, install the git pre-commit hook once: bundle exec fastlane install_git_hooks In the Xcode project, the autocorrectable linters will not modify your source code but will provide warnings.

This project uses several linters: SwiftFormat SwiftLint (for things SwiftFormat doesn't automate) Rubocop (largely for Fastlane) YamlLint (largely for GitHub Actions) Continuous Integration We use Github Actions alongside Fastlane to perform continuous integration both by unit testing and deploying to App Store Connect . Mac Developer ID builds are available as an artifact on every build of master. Environment variables Fastlane scripts read from the environment or .env file for configuration like team IDs.

See .env.sample for available values. Deployment Although all the deployment is done through Github Actions, you can do it manually through Fastlane : Deployment to App Store Connect # creates the builds and uploads to the app store # each save their artifacts to build/ bundle exec fastlane mac build bundle exec fastlane ios build Contributing See CONTRIBUTING.md LICENSE Apache-2.0 Credits The format and some content of this README.md comes from the SwipeIt project.

About 📱 Home Assistant for Apple platforms companion.home-assistant.io Topics hacktoberfest home-assistant home-automation ios macos open-source-app swift Resources Readme Apache-2.0 license Code of conduct Code of conduct Contributing Contributing Security policy Security policy Activity Custom properties Stars 2.4k stars Watchers 74 watching Forks 570 forks Report repository Releases Used by Contributors Languages You can’t perform that action at this time.