this repo has no description
update documentation
+30
-10
+4
changelog.md
+4
changelog.md
···
7
7
8
8
## [Unreleased](https://github.com/patrik-csak/terminal-profile/compare/v3.0.2...HEAD)
9
9
10
+
### Added
11
+
12
+
- Documentation explaining how to automatically update Terminal profile when opening Terminal
13
+
10
14
### Changed
11
15
12
16
- **BREAKING**: `update-profile` gets appearance mode from OS instead of from `DARKMODE` environment variable
+26
-10
readme.md
+26
-10
readme.md
···
1
-
# `auto-terminal-profile`
1
+
# Auto Terminal Profile
2
2
3
-
Automatically switch the macOS Terminal profile based on the system-wide dark / light appearance mode
3
+
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
4
4
5
5
6
6
7
7
## Prerequisites
8
8
9
-
- [Node.js](https://nodejs.org/en/) 18–20
9
+
- [Node.js](https://nodejs.org/) 18–20
10
10
11
11
## Installation
12
12
13
-
```sh
13
+
```shell
14
14
npm install --global auto-terminal-profile
15
15
```
16
16
17
17
## Usage
18
18
19
+
### Enable automatic profile switching
20
+
19
21
To get started, enable automatic profile switching and set your preferred dark and light mode profiles:
20
22
21
-
```sh
23
+
```shell
22
24
auto-terminal-profile enable \
23
25
--dark-profile='One Dark' \
24
26
--light-profile='One Light'
25
27
```
26
28
27
-
For more information view the help output:
29
+
### Switch profile on Terminal startup
30
+
31
+
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.
28
32
29
-
```sh
30
-
auto-terminal-profile --help
33
+
To sync the Terminal profile to the current macOS appearance mode once:
34
+
35
+
```shell
36
+
auto-terminal-profile update-profile
31
37
```
32
38
33
-
## Acknowledgements
39
+
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.
34
40
35
-
Thanks [Bouke van der Bijl](https://bou.ke) for his project [dark-mode-notify](https://github.com/bouk/dark-mode-notify), which this project depends on
41
+
### Disable automatic profile switching
42
+
43
+
```shell
44
+
auto-terminal-profile disable
45
+
```
46
+
47
+
### Help
48
+
49
+
```shell
50
+
auto-terminal-profile --help
51
+
```