https://github.com/patrik-csak/auto-terminal-profile

🧑‍💻 Automatic dark / light mode for macOS Terminal
https://github.com/patrik-csak/auto-terminal-profile

dark-mode light-mode macos terminal terminal-profile

Last synced: 5 days ago
JSON representation

🧑‍💻 Automatic dark / light mode for macOS Terminal

• Host: GitHub
• URL: https://github.com/patrik-csak/auto-terminal-profile
• Owner: patrik-csak
• License: mit
• Created: 2022-06-11T02:44:28.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-27T16:27:49.000Z (2 months ago)
• Last Synced: 2025-01-28T12:39:45.409Z (13 days ago)
• Topics: dark-mode, light-mode, macos, terminal, terminal-profile
• Language: JavaScript
• Homepage: https://npmjs.com/auto-terminal-profile
• Size: 172 MB
• Stars: 65
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • Changelog: changelog.md
  • Funding: .github/funding.yml
  • License: license.txt

Awesome Lists containing this project

README

        
# Auto Terminal Profile

Automatically switch [macOS Terminal](https://en.wikipedia.org/wiki/Terminal_%28macOS%29) profiles when the [dark / light appearance mode](https://support.apple.com/guide/mac-help/use-a-light-or-dark-appearance-mchl52e1c2d2/mac) changes

![auto-terminal-profile demonstration screen recording](./documentation/demo.gif)

## Prerequisites

- [Node.js](https://nodejs.org/) 18–20

## Installation

```shell

npm install --global auto-terminal-profile

```

## Usage

### Enable automatic profile switching

To get started, enable automatic profile switching and set your preferred dark and light mode profiles:

```shell

auto-terminal-profile enable \

  --dark-profile='One Dark' \

  --light-profile='One Light'

```

### Switch profile on Terminal startup

Auto Terminal Profile only runs if Terminal is running, so the profile can fall out of sync if the macOS appearance mode changes while Terminal isn’t running.

To sync the Terminal profile to the current macOS appearance mode once:

```shell

auto-terminal-profile update-profile

```

To sync the Terminal profile to the current macOS appearance mode when Terminal app is opened, you can add that line to your shell startup script (e.g. `.zshrc`), but it will increase the startup time of new shell sessions.

### Disable automatic profile switching

```shell

auto-terminal-profile disable

```

### Help

```shell

auto-terminal-profile --help

```