codevator 0.1.0 → 0.1.1
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 +77 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# codevator
|
|
2
|
+
|
|
3
|
+
Elevator music for your AI coding agent. Background sounds that play while Claude Code works and stop when it needs your attention.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g codevator
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Setup
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
codevator setup
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
This installs hooks into Claude Code (`~/.claude/settings.json`) that automatically:
|
|
18
|
+
|
|
19
|
+
- **Play** music when the agent starts working
|
|
20
|
+
- **Stop** when it finishes or needs your input
|
|
21
|
+
|
|
22
|
+
## Sound Modes
|
|
23
|
+
|
|
24
|
+
Five built-in modes:
|
|
25
|
+
|
|
26
|
+
| Mode | Description |
|
|
27
|
+
|------|-------------|
|
|
28
|
+
| `elevator` | Classic smooth jazz elevator music (default) |
|
|
29
|
+
| `typewriter` | Rhythmic mechanical keystrokes |
|
|
30
|
+
| `ambient` | Soft atmospheric background |
|
|
31
|
+
| `retro` | Mellow 8-bit synthesized arpeggios |
|
|
32
|
+
| `minimal` | Deep warm hum with slow breathing |
|
|
33
|
+
|
|
34
|
+
Switch modes:
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
codevator mode ambient
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Commands
|
|
41
|
+
|
|
42
|
+
```
|
|
43
|
+
codevator setup Install hooks into Claude Code
|
|
44
|
+
codevator mode <name> Set sound mode
|
|
45
|
+
codevator on Enable sounds
|
|
46
|
+
codevator off Disable sounds
|
|
47
|
+
codevator volume <0-100> Set volume level
|
|
48
|
+
codevator status Show current settings
|
|
49
|
+
codevator uninstall Remove hooks from Claude Code
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## How It Works
|
|
53
|
+
|
|
54
|
+
Codevator registers hooks in Claude Code's settings:
|
|
55
|
+
|
|
56
|
+
- **PreToolUse** — starts playback when the agent begins working
|
|
57
|
+
- **Stop** — stops playback when the session ends
|
|
58
|
+
- **Notification** — stops on permission prompts and idle states
|
|
59
|
+
|
|
60
|
+
Music plays through your system's native audio player (`afplay` on macOS, `paplay`/`aplay` on Linux).
|
|
61
|
+
|
|
62
|
+
Config is stored at `~/.codevator/config.json`.
|
|
63
|
+
|
|
64
|
+
## Claude Code Skill
|
|
65
|
+
|
|
66
|
+
Setup also installs a Claude Code skill that lets the agent control music directly. Ask Claude to "change the music to retro" or "turn off the elevator music" and it will run the right command.
|
|
67
|
+
|
|
68
|
+
## Uninstall
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
codevator uninstall
|
|
72
|
+
npm uninstall -g codevator
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
## License
|
|
76
|
+
|
|
77
|
+
MIT
|