https://github.com/chrenn/loginitemkit
Add non-sandboxed macOS applications to user login items
https://github.com/chrenn/loginitemkit
launchatlogin macos swift-package
Last synced: 8 months ago
JSON representation
Add non-sandboxed macOS applications to user login items
- Host: GitHub
- URL: https://github.com/chrenn/loginitemkit
- Owner: chrenn
- License: mit
- Created: 2020-03-02T14:28:00.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-09T14:01:07.000Z (over 3 years ago)
- Last Synced: 2025-04-23T19:03:48.205Z (about 1 year ago)
- Topics: launchatlogin, macos, swift-package
- Language: Swift
- Size: 344 KB
- Stars: 32
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# LoginItemKit
> **Warning**
> With macOS 13, Apple introduced [SMAppService](https://developer.apple.com/documentation/servicemanagement/smappservice) and deprecated the _Hide_ property.
> Please use SMAppService or a wrapper like [LaunchAtLogin-Modern](https://github.com/sindresorhus/LaunchAtLogin-Modern) for new projects.
A simple Swift package to add non-sandboxed macOS applications to user login items and to control their _Hide_ property.
## Overview
There are basically two ways to achieve _Launch at Login_ functionality on macOS.
Let's compare LoginItemKit to the popular [LaunchAtLogin](https://github.com/sindresorhus/LaunchAtLogin) package.
| []() | LaunchAtLogin | LoginItemKit |
| :------------------------------ | :------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------- |
| Framework | [ServiceManagement](https://developer.apple.com/documentation/servicemanagement/1501557-smloginitemsetenabled) | [LaunchServices](https://developer.apple.com/documentation/coreservices/klssharedfilelistsessionloginitems) |
| Deprecated | [Partly](https://developer.apple.com/documentation/servicemanagement/1431086-smcopyalljobdictionaries) (10.10) | [Yes](https://developer.apple.com/documentation/coreservices/klssharedfilelistsessionloginitems) (10.11) |
| Sandbox support | Yes | No |
| SwiftPM support | [Yes](https://github.com/sindresorhus/LaunchAtLogin/issues/4) | Yes |
| Needs helper app & build script | Yes | No |
| Shows up in system preferences | [No](https://stackoverflow.com/a/15104481) | Yes |
So feel free to use this package in all your non-sandboxed apps and let's hope that Apple does not remove the LaunchServices API from future versions of macOS.
### The _Hide_ checkbox
Checking _Hide_ can cause problems for applications using high values for `NSWindow.Level`, e.g. the tooltip windows in [Swish](https://highlyopinionated.co/swish/). Version 2 of LoginItemKit allows you to read and write this property.
## Installation
#### SwiftPM
```swift
.package(url: "https://github.com/chrenn/LoginItemKit", from: "2.0.0")
```
## API
LoginItemKit exposes a tertiary `.launchState` enum for granular control as well as a simple `.launchAtLogin` boolean.
| []() | `launchState` | `launchAtLogin { get, set }` |
| :-------------------------------- | :------------ | :--------------------------- |
| Not in Login Items | `.none` | `false`, `false` |
| In Login Items & _Hide_ checked | `.hide` | `true`, - |
| In Login Items & _Hide_ unchecked | `.show` | `true`, `true` |
### Usage
```swift
import LoginItemKit
print(LoginItemKit.launchState, LoginItemKit.launchAtLogin)
// → .none, false
LoginItemKit.launchAtLogin = true
print(LoginItemKit.launchState, LoginItemKit.launchAtLogin)
// → .show, true
LoginItemKit.launchState = .hide
print(LoginItemKit.launchState, LoginItemKit.launchAtLogin)
// → .hide, true
```
## Resources
- [LaunchAtLogin](https://github.com/sindresorhus/LaunchAtLogin)
- [LoginServiceKit](https://github.com/Clipy/LoginServiceKit)
- [HWSensors3](https://sourceforge.net/p/hwsensors/hwsensors3/code3/107/tree/trunk/hwmonitor2/HWMonitorSMC/RunAtLogin.swift#l4)
- [Marcos Crispino](https://stackoverflow.com/a/5598992)
## Used by
- [Swish](https://highlyopinionated.co/swish/)