https://github.com/hitblast/cutler
Declarative macOS defaults management at your fingertips, with speed.
https://github.com/hitblast/cutler
command-line-tools declarative-config macos macos-cli rust rust-cli rust-cli-apps
Last synced: 2 months ago
JSON representation
Declarative macOS defaults management at your fingertips, with speed.
- Host: GitHub
- URL: https://github.com/hitblast/cutler
- Owner: hitblast
- License: mit
- Created: 2025-03-08T15:08:49.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-03-08T15:54:49.000Z (2 months ago)
- Last Synced: 2025-03-08T16:24:33.855Z (2 months ago)
- Topics: command-line-tools, declarative-config, macos, macos-cli, rust, rust-cli, rust-cli-apps
- Language: Rust
- Homepage: https://crates.io/crates/cutler
- Size: 40 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
cutler
[](https://github.com/hitblast/cutler/actions/workflows/release.yml)
Declarative macOS defaults management at your fingertips, with speed.
> [!WARNING]
> This project is still under active development. Some of the
> written functionality here might be missing. Please wait for the initial
> release.
## Table of Contents
- [Overview](#overview)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Overview
cutler is a command-line tool that allows you to manage macOS defaults with a
simple TOML file. It is made using Rust to facilitate tiny binary size for its
functionality, and obviously, speed.
Many of us tend to use the `defaults` command-line tool to
declare specific settings on our Macs. However, this boils down to unnecessary
scripting and might also increase the chances of accidentally harming your
default configurations.
## Installation
- Using `cargo`:
```bash
cargo install cutler
```
- Using `mise`:
```bash
mise use -g cargo
```
- Using Homebrew:
```bash
# still a work-in-progress
```
## Usage
The command-line interface respects `$XDG_CONFIG_HOME` and depending on your
macOS settings, `cutler` will read the `config.toml` for your written defaults
from this path:
- `$XDG_CONFIG_HOME/cutler/config.toml` or,
- `~/.config/cutler/config.toml`
The overall structure for cutler's configuration should be as follows:
```toml
[dock]
tilesize = 46
[menuextra.clock]
FlashDateSeparators = true
```
Here, the following TOML code translates to the following command being executed:
```bash
defaults write com.apple.dock "tilesize" -int "46"
defaults write com.apple.menuextra.clock "FlashDateSeparators"
```
The interface is also type-safe and uses generic TOML parsing to ensure that the
types are designated properly. So, to apply this configuration, simply run:
```bash
cutler apply
```
Please note that `cutler apply` also generates a default configuration file for
you to get started with if no file is found in the designated directories.
SImply accept the prompt and you're good to go.
Now, to unapply the configuration, simply run:
```bash
cutler unapply
```
If you'd like to remove the file entirely, you can run the following command:
(generally not recommended since currently applied settings could become untrackable)
```bash
cutler delete
```
## Contributing
This is one of my hobby projects that I've made to solve one of my most common
problems - repeatedly applying the same settings on my MacBook. So, pull
requests are always welcome! Feel free to submit your changes or improvements by
[creating a pull request]() or by [submitting an issue]().
## License
This project has been licensed under the [MIT License](LICENSE).