macos-defaults/readme.md

68 lines
3.3 KiB
Markdown
Raw Permalink Normal View History

2020-01-09 10:03:02 +00:00
# Welcome to macOS-defaults 👋
2023-08-17 13:54:54 +00:00
[![macos-defaults.com status](https://img.shields.io/pingpong/uptime/sp_92e9dcd33e474926853ac99968debf88)](https://macos-defaults.pingpong.host/)
2022-08-16 09:11:05 +00:00
[![Documentation](https://img.shields.io/badge/documentation-yes-brightgreen.svg)](https://github.com/yannbertrand/macos-defaults/tree/main)
2020-01-09 10:03:02 +00:00
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](#)
[![Twitter: macos_defaults](https://img.shields.io/twitter/follow/macos_defaults.svg?style=social)](https://twitter.com/macos_defaults)
2023-08-17 13:54:54 +00:00
[![Twitter: _YannBertrand](https://img.shields.io/twitter/follow/_YannBertrand.svg?style=social)](https://twitter.com/_YannBertrand)
2020-01-09 10:03:02 +00:00
**Stability: 2 - Stable**
2020-01-09 10:03:02 +00:00
https://macos-defaults.com
`defaults` commands allow you to programmatically set System Settings of your Mac. 🤖⚙️🔧
An up-to-date list of [macOS `defaults` commands](https://macos-defaults.com) with demos. ✨
2020-01-09 10:03:02 +00:00
2020-09-12 23:28:22 +00:00
## Add a command
2023-08-17 13:54:54 +00:00
All the listed `defaults` commands are Markdown files stored in the [docs folder](./docs). It is recommended to look at a few of them before proposing a new one:
- https://macos-defaults.com/dock/orientation.html
- https://macos-defaults.com/dock/autohide-time-modifier.html
- https://macos-defaults.com/screenshots/disable-shadow.html
Here are the mandatory infos to add a new command:
- The defaults command's domain
- The command's key
- A neutral title
- A simple description
- Parameter type, and list of accepted values when applicable
- Other command dependency
- A scenario to test the command is still working
- The corresponding option access from UI when it exists
- At least two examples with a small text description
- Ideally, an image or video for each example
- Compatible versions it has been tested on
Some images and videos are built programmatically. Take a look at the [record folder](./record/#readme) to find out how to record some. I will always prefer images and videos examples as they help maintenance a lot! Please consider it if you want to [open a PR](https://github.com/yannbertrand/macos-defaults/compare).
2020-01-09 10:03:02 +00:00
### How to discover a `defaults` command
2023-08-17 13:54:54 +00:00
Using this [bash script](diff.sh) (`bash ./diff.sh`), you'll be able to find out which key changed when you change a system or app settings.
After you find the key with your options, simply run `defaults find ${keyname}` to find the domain it is saved in.
2020-01-09 10:03:02 +00:00
# macOS-defaults recorder 📷
Programmatically record a Mac screen with a predefined list of actions 📹.
The project also contains scripts that run desktop actions, take screenshots or record videos. The goal is to avoid having to manually recheck the status of commands with each new major version of macOS.
## How does it work?
2023-08-17 13:54:54 +00:00
Take a look at the [record folder](./record/#readme) if you want to go deeper.
# macOS-defaults builder 🤖
This project used to help compare Static Site Generators (SSG). We now removed this part but you can still find an old comparison between a few of them (Docsify, Docusaurus, VuePress and GitHub markdown) [in the project history](https://github.com/yannbertrand/macos-defaults/tree/1716cb77e7c17f8317e18e9b9418cc834bb3486c/build).
2020-01-09 10:03:02 +00:00
# Show your support
2023-08-17 13:54:54 +00:00
2020-01-09 10:03:02 +00:00
Give a ⭐️ if this project helped you!
2023-08-17 13:54:54 +00:00
---
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_