ctheme 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +155 -0
- package/bin/ctheme.js +1819 -0
- package/package.json +34 -0
package/README.md
ADDED
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
# ctheme
|
|
2
|
+
|
|
3
|
+
CLI for making your terminal look better.
|
|
4
|
+
|
|
5
|
+
It focuses on terminal theming only:
|
|
6
|
+
|
|
7
|
+
- live Apple Terminal profile switching
|
|
8
|
+
- generated config snippets for Ghostty, Kitty, and WezTerm
|
|
9
|
+
- custom theme creation with an interactive wizard
|
|
10
|
+
- Google Fonts install/search helpers
|
|
11
|
+
- reset back to your original terminal profile
|
|
12
|
+
|
|
13
|
+
## Install
|
|
14
|
+
|
|
15
|
+
From npm:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npm install -g ctheme
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
From GitHub:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
npm install -g github:arjunkshah/ctheme
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
For local development:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
npm install -g . --force
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Quick Start
|
|
34
|
+
|
|
35
|
+
Apply a bundled theme live:
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
ctheme use solarized
|
|
39
|
+
ctheme use harbor --default
|
|
40
|
+
ctheme use velvet --font "Space Mono"
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Reset anytime:
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
ctheme reset
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
See available themes:
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
ctheme list
|
|
53
|
+
ctheme preview solarized
|
|
54
|
+
ctheme status
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Theme Wizard
|
|
58
|
+
|
|
59
|
+
Launch the interactive wizard:
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
ctheme wizard
|
|
63
|
+
ctheme make
|
|
64
|
+
ctheme wizard mytheme
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
The wizard walks through:
|
|
68
|
+
|
|
69
|
+
- base preset
|
|
70
|
+
- accent, background, surface, and text colors
|
|
71
|
+
- terminal font
|
|
72
|
+
- UI font
|
|
73
|
+
- code font
|
|
74
|
+
- optional Google Fonts install
|
|
75
|
+
- optional live apply
|
|
76
|
+
|
|
77
|
+
Make a theme non-interactively:
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
ctheme make mytheme --preset harbor --accent "#ff4d6d" --bg "#0d0b14" --surface "#171321" --surface-alt "#241a35" --fg "#f7f2ff" --terminal-font "Space Mono" --ui-font "Outfit" --code-font "DM Mono"
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
Saved themes live in:
|
|
84
|
+
|
|
85
|
+
```text
|
|
86
|
+
~/.ctheme/themes
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## Terminal Targets
|
|
90
|
+
|
|
91
|
+
Supported targets:
|
|
92
|
+
|
|
93
|
+
```text
|
|
94
|
+
apple-terminal, current, ghostty, kitty, wezterm
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
Examples:
|
|
98
|
+
|
|
99
|
+
```bash
|
|
100
|
+
ctheme term apple-terminal --theme noir --font "SF Mono"
|
|
101
|
+
ctheme term ghostty --theme noir --font "JetBrains Mono" --font-size 15 --write
|
|
102
|
+
ctheme term kitty --theme ember --font "Berkeley Mono" --font-size 14 --write
|
|
103
|
+
ctheme term wezterm --theme paper --font "IBM Plex Mono" --font-size 14
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
Apple Terminal applies immediately to the current window/tab. `--default` also sets the startup/default profile.
|
|
107
|
+
|
|
108
|
+
Generated snippets live in:
|
|
109
|
+
|
|
110
|
+
```text
|
|
111
|
+
~/.ctheme/snippets
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
## Fonts
|
|
115
|
+
|
|
116
|
+
List installed families:
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
ctheme font list
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
Search Google Fonts:
|
|
123
|
+
|
|
124
|
+
```bash
|
|
125
|
+
ctheme font search "mono"
|
|
126
|
+
ctheme font search "man"
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
Install a family:
|
|
130
|
+
|
|
131
|
+
```bash
|
|
132
|
+
ctheme font install "Manrope"
|
|
133
|
+
ctheme font install "Space Mono"
|
|
134
|
+
ctheme font install "IBM Plex Mono"
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
Managed font installs go to:
|
|
138
|
+
|
|
139
|
+
```text
|
|
140
|
+
~/Library/Fonts/pretty-code
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
## Bundled Presets
|
|
144
|
+
|
|
145
|
+
```text
|
|
146
|
+
aurora, cobalt, dune, ember, espresso, forest, glacier, harbor,
|
|
147
|
+
lotus, mint, mono, neon, noir, obsidian, paper, rose,
|
|
148
|
+
solarized, solarized-dark, velvet
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
Bundled themes intentionally vary their font pairings so they do not all feel the same.
|
|
152
|
+
|
|
153
|
+
## Contributing
|
|
154
|
+
|
|
155
|
+
Development notes are in [DEVELOPMENT.md](/Users/arjunkshah21/Downloads/pretty-code/DEVELOPMENT.md).
|