Skip to content
Add “Launch at Login” functionality to your macOS app in seconds
Swift Shell Objective-C
Branch: master
Clone or download
Latest commit bf07cd1 Jan 21, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Enable the repo Sponsor button May 23, 2019
LaunchAtLogin.xcodeproj 3.0.0 Jan 21, 2020
LaunchAtLogin 3.0.0 Jan 21, 2020
LaunchAtLoginHelper Meta tweaks Jul 20, 2018
.editorconfig Init Jul 30, 2017
.gitattributes Meta tweaks Jun 29, 2018
.gitignore Init Jul 30, 2017
before-after.md Simplify the readme May 4, 2018
license Init Jul 30, 2017
readme.md 3.0.0 Jan 21, 2020

readme.md

LaunchAtLogin

Add “Launch at Login” functionality to your macOS app in seconds

It's usually quite a convoluted and error-prone process to add this. No more!

This package works with both sandboxed and non-sandboxed apps and it's App Store compatible and used in apps like Plash, Dato, Lungo, and Battery Indicator.

Requirements

  • macOS 10.12+
  • Xcode 11+
  • Swift 5+

Install

Carthage

github "sindresorhus/LaunchAtLogin"

Usage

Add a new "Run Script Phase" below "Embed Frameworks" in "Build Phases" with the following:

"${PROJECT_DIR}/Carthage/Build/Mac/LaunchAtLogin.framework/Resources/copy-helper.sh"

Use it in your app:

import LaunchAtLogin

print(LaunchAtLogin.isEnabled)
//=> false

LaunchAtLogin.isEnabled = true

print(LaunchAtLogin.isEnabled)
//=> true

No need to store any state to UserDefaults.

Note that the Mac App Store guidelines requires “launch at login” functionality to be enabled in response to a user action. This is usually solved by making it a preference that is disabled by default. Many apps also let the user activate it in a welcome screen.

How does it work?

The framework bundles the helper app needed to launch your app and copies it into your app at build time.

FAQ

My app doesn't show up in “System Preferences › Users & Groups › Login Items”

This is the expected behavior, unfortunately.

My app doesn't launch at login when testing

This is usually caused by having one or more older builds of your app laying around somewhere on the system, and macOS picking one of those instead, which doesn't have the launch helper, and thus fails to start.

Some things you can try:

  • Bump the version & build of your app so macOS is more likely to pick it.
  • Delete the DerivedData directory.
  • Ensure you don't have any other builds laying around somewhere.

Some helpful Stack Overflow answers:

Can you support CocoaPods?

CocoaPods used to be supported, but it did not work well and there was no easy way to fix it, so support was dropped. Even though you mainly use CocoaPods, you can still use Carthage just for this package without any problems.

I'm getting a 'SMCopyAllJobDictionaries' was deprecated in OS X 10.10 warning

Apple deprecated that API without providing an alternative. Apple engineers have stated that it's still the preferred API to use. I plan to use it as long as it's available. There are workarounds I can implement if Apple ever removes the API, so rest assured, this module will be made to work even then. If you want to see this resolved, submit a Feedback Assistant report with the following text. There's unfortunately still no way to suppress warnings in Swift.

Related

  • Defaults - Swifty and modern UserDefaults
  • Preferences - Add a preferences window to your macOS app in minutes
  • DockProgress - Show progress in your app's Dock icon
  • create-dmg - Create a good-looking DMG for your macOS app in seconds
  • More…
You can’t perform that action at this time.