Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mbenoukaiss/clapet
Clapet is a utility that aims to improve clamshell mode on your Macbook by automatically managing sleep when an external display is detected
https://github.com/mbenoukaiss/clapet
clamshell macos pmset sleep swiftui
Last synced: 26 days ago
JSON representation
Clapet is a utility that aims to improve clamshell mode on your Macbook by automatically managing sleep when an external display is detected
- Host: GitHub
- URL: https://github.com/mbenoukaiss/clapet
- Owner: mbenoukaiss
- License: gpl-3.0
- Created: 2022-11-20T20:58:48.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-23T20:13:56.000Z (4 months ago)
- Last Synced: 2024-08-24T21:16:56.591Z (4 months ago)
- Topics: clamshell, macos, pmset, sleep, swiftui
- Language: Swift
- Homepage:
- Size: 381 KB
- Stars: 71
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- Mac-Menubar-Megalist - Clapet
README
# Clapet
Clapet is a utility that aims to improve clamshell mode on your Macbook.
Clamshell mode on mac keeps your mac awake when you close the lid but it
only works when a power adapter is connected. This app aims to solve this
problem by allowing clamshell mode even on battery.
When an external display is detected while on battery or power adapter, the application will
disable sleep so you can use your computer with the lid closed, and as soon as the external
display is unplugged, sleep will be enabled again to preserve battery.
**After macOS updates you may have to go through the _Manual configuration_ step again**
## Features
* Automatically disable sleep if an external display is connected
* Disable sleep for a specified amount of time
* Manage sleep through shortcuts
## Installing
You can download the app from the [release](https://github.com/mbenoukaiss/clapet/releases/latest)
tab or by [clicking this link](https://github.com/mbenoukaiss/clapet/releases/latest/download/Clapet.app.zip)
link directly.
When the application is done downloading, you can open the zip file and move the `Clapet.app` file it to
the `Application` folder on your mac and run it for the first time.
**You may be unable to start the application** since I do not have an Apple Developper licence, to fix this
problem you can right click the application and click Open, your mac should then allow you to bypass the
security warning.
Due to the way it works, Clapet can also not be submitted to the AppStore.
### Manual configuration
When launched the application will ask you to configure the `pmset` utility, if you skipped it
you can still do it from the advanced tab in settings or you can do it manually by following the
instructions below.
The application uses the command line utility `pmset` to work. This utility requires root
permissions to be ran. If no changes are made the application will ask for password each time
it either disables or enables sleep which can get annoying.
In order to disable password requirement to run `pmset` you will need to edit the sudoers file.
Running the following command will open the sudoers file in Vim, you can choose another editor by
setting the `EDITOR` variable before (for example `EDITOR="nano" sudo visudo`)
```shell
sudo visudo
```
Then add the following line at the bottom of the file and replace `username` by your username
```
username ALL = NOPASSWD : /usr/bin/pmset
```
You should now be able to run `sudo pmset` without entering your password. The configuration in this step
may get erased after a macOS upate, you should do it again if the app starts asking for permissions again.
### Uninstalling
If you want to uninstall the app, remove the line added in the sudoers file mentioned in
the **Manual configuration** section and delete the application from your computer.
## Contributing
Any kind of contribution either through pull requests or simple issues describing a feature
you'd like to have in the application or a problem you get when using it are welcome.
## License
This project is licensed under the terms of the [GNU GPLv3](./LICENSE) license