@humeai/cli 0.0.3 → 0.0.5

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.
Files changed (3) hide show
  1. package/README.md +75 -28
  2. package/dist/hume +0 -0
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -16,6 +16,9 @@ hume login
16
16
  hume tts "Are you serious?" --description "whispered, hushed"
17
17
  hume voices create --name whisperer --last
18
18
  hume tts "I said, are you serious?" --voice-name whisperer
19
+ hume voices list # View your saved voices
20
+ hume voices list --provider HUME_AI # View Hume's voice library
21
+ hume voices delete --name whisperer # Delete a voice when no longer needed
19
22
  ```
20
23
 
21
24
  ## Installation
@@ -37,22 +40,27 @@ $ hume tts <text>
37
40
 
38
41
  ━━━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
39
42
 
40
- -d,--description #0 Description of the desired voice
41
- -c,--continue,--context-generation-id #0 Previous generation ID for continuation
42
- -l,--last,--continue-from-last Use a generation from a previous synthesis as context. If the last synthesis was created with --num-generations > 1, you must also provide --last-index
43
- --last-index #0 Index of the generation to use from the previous synthesis.
44
- -o,--output-dir #0 Output directory for generated audio files
45
- -n,--num-generations #0 Number of variations to generate
46
- -p,--prefix #0 Filename prefix for generated audio
47
- --play #0 Play audio after generation: all variations, just the first, or none
48
- --play-command #0 Command to play audio files (uses $AUDIO_FILE as placeholder for file path)
49
- --api-key #0 Override the default API key
50
- --format #0 Output audio format
51
- -v,--voice-name #0 Name of a previously saved voice
52
- --voice-id #0 Direct voice ID to use
53
- --json Output in JSON format
54
- --pretty Output in human-readable format
55
- --base-url #0 Override the default API base URL (for testing purposes)
43
+ -d,--description #0 Description of the desired voice
44
+ -c,--continue,--context-generation-id #0 Previous generation ID for continuation
45
+ -l,--last,--continue-from-last Use a generation from a previous synthesis as context. If the last synthesis was created with --num-generations > 1, you must also provide --last-index
46
+ --last-index #0 Index of the generation to use from the previous synthesis.
47
+ -o,--output-dir #0 Output directory for generated audio files
48
+ -n,--num-generations #0 Number of variations to generate
49
+ -p,--prefix #0 Filename prefix for generated audio
50
+ --play #0 Play audio after generation: all variations, just the first, or none
51
+ --play-command #0 Command to play audio files (uses $AUDIO_FILE as placeholder for file path)
52
+ --api-key #0 Override the default API key
53
+ --format #0 Output audio format
54
+ -v,--voice-name #0 Name of a previously saved voice
55
+ --voice-id #0 Direct voice ID to use
56
+ --json Output in JSON format
57
+ --pretty Output in human-readable format
58
+ --base-url #0 Override the default API base URL (for testing purposes)
59
+ --provider #0 Voice provider type (CUSTOM_VOICE or HUME_AI)
60
+ --speed #0 Speaking speed multiplier (0.25-3.0, default is 1.0)
61
+ --trailing-silence #0 Seconds of silence to add at the end (0.0-5.0, default is 0.35)
62
+ --streaming Use streaming mode for TTS generation (default: true)
63
+ --instant-mode Enable ultra-low latency mode for significantly faster generation (requires streaming=true, a voice, and incurs 10% higher cost)
56
64
 
57
65
  ━━━ Details ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
58
66
 
@@ -63,32 +71,71 @@ saved voices.
63
71
  ━━━ Examples ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
64
72
 
65
73
  Basic usage
66
- $ hume tts "Make sure to like and subscribe!" --description "The speaker is a charismatic, enthusiastic, male YouTuber in his 20s with a American accent, a slightly breathy voice, and a fast speaking rate."
74
+ $ hume tts "Make sure to like and subscribe!" --description "The speaker is a charismatic, enthusiastic, male YouTuber in his 20s with a American accent, a slightly breathy voice, and a fast speaking rate."
67
75
 
68
76
  Saving a voice you like (see `hume voices create --help`)
69
- $ hume voices create --name influencer_1 --last
77
+ $ hume voices create --name influencer_1 --last
70
78
 
71
79
  Using a previously-saved voice
72
- $ hume tts "Thanks for the 100,000,000,000 likes guys!" -v influencer_1
80
+ $ hume tts "Thanks for the 100,000,000,000 likes guys!" -v influencer_1
81
+
82
+ Using a voice from the Hume Voice Library
83
+ $ hume tts "Hello there" -v narrator --provider HUME_AI
73
84
 
74
85
  Reading from stdin
75
- $ echo "I wouldn't be here without you" | hume tts - -v influencer_1
86
+ $ echo "I wouldn't be here without you" | hume tts - -v influencer_1
76
87
 
77
88
  Continuing previous text
78
- $ hume tts "Take some arrows from the quiver" -v influencer_1
79
- $ hume tts "Take a bow, too" -v influencer_1 --last # should rhyme with 'toe' not 'cow'
89
+ $ hume tts "Take some arrows from the quiver" -v influencer_1
90
+ $ hume tts "Take a bow, too" -v influencer_1 --last # should rhyme with 'toe' not 'cow'
80
91
 
81
92
  Using custom audio player (macOS/Linux)
82
- $ hume tts "Hello world" -v narrator --play-command "mpv $AUDIO_FILE --no-video"
93
+ $ hume tts "Hello world" -v narrator --play-command "mpv $AUDIO_FILE --no-video"
83
94
 
84
95
  Using custom audio player (Windows)
85
- $ hume tts "Hello world" -v narrator --play-command "powershell -c \"[System.Media.SoundPlayer]::new('$AUDIO_FILE').PlaySync()\""
96
+ $ hume tts "Hello world" -v narrator --play-command "powershell -c \"[System.Media.SoundPlayer]::new('$AUDIO_FILE').PlaySync()\""
86
97
 
87
98
  Setting a custom audio player for the session
88
- $ hume session set tts.playCommand "vlc $AUDIO_FILE --play-and-exit"
99
+ $ hume session set tts.playCommand "vlc $AUDIO_FILE --play-and-exit"
100
+
101
+ Adjusting speech speed
102
+ $ hume tts "I am speaking very slowly" -v narrator --speed 0.75
103
+
104
+ Adding trailing silence
105
+ $ hume tts "Wait for it..." -v narrator --trailing-silence 3.5
106
+
107
+ Using instant mode for ultra-low latency
108
+ $ hume tts "Hello world" -v narrator --instant-mode
109
+
110
+ Setting instant mode in your config (always enable)
111
+ $ hume config set tts.instantMode true
112
+
113
+ ## Voice Management
114
+
115
+ Save a voice from a previous generation
116
+ $ hume voices create --name my-narrator --last
117
+
118
+ Create a voice from a specific generation ID
119
+ $ hume voices create --name my-narrator --generation-id abc123
120
+
121
+ ### Listing Voices
122
+
123
+ List your custom voices
124
+ $ hume voices list
125
+
126
+ List voices from the Hume Voice Library
127
+ $ hume voices list --provider HUME_AI
128
+
129
+ ### Deleting Voices
130
+
131
+ Delete a voice by name
132
+ $ hume voices delete --name my-narrator
89
133
 
90
134
  ━━━ See also ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
91
- * `hume voices create --help` - Save a voice for later use
92
- * `hume session --help` - Save settings temporarily so you don't have to repeat yourself
93
- * `hume config --help` - Save settings more permanently
135
+
136
+ - `hume voices create --help` - Save a voice for later use
137
+ - `hume voices list --help` - List available voices
138
+ - `hume voices delete --help` - Delete a saved voice
139
+ - `hume session --help` - Save settings temporarily so you don't have to repeat yourself
140
+ - `hume config --help` - Save settings more permanently
94
141
  ```
package/dist/hume CHANGED
Binary file
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@humeai/cli",
3
- "version": "0.0.3",
3
+ "version": "0.0.5",
4
4
  "module": "index.ts",
5
5
  "type": "module",
6
6
  "description": "CLI for Hume.ai's OCTAVE expressive TTS API",
@@ -26,7 +26,7 @@
26
26
  "bun": "^1.2.2",
27
27
  "clipanion": "^4.0.0-rc.4",
28
28
  "debug": "^4.4.0",
29
- "hume": "^0.9.15",
29
+ "hume": "^0.10.3",
30
30
  "open": "^10.1.0",
31
31
  "typanion": "^3.14.0"
32
32
  },