@humeai/cli 0.0.1 → 0.0.2

package/README.md

@@ -1,15 +1,94 @@
-# hume-cli
+# Hume TTS CLI
 
-To install dependencies:
+This is a CLI for Hume AI's [Octave TTS](https://hume.ai/blog/octave-the-first-text-to-speech-model-that-understands-what-it-s-saying) API.
 
-```bash
-bun install
+Unlike conventional TTS that merely "reads" words, Octave is a speech-language model that understands what words mean in context, unlocking a new level of expressiveness. It acts out characters, generates voices from prompts, and takes instructions to modify the emotion and style of a given utterance.
+
+This CLI uses Hume's [Typescript SDK](https://github.com/humeai/hume-typescript-sdk) behind the scenes.
+
+## Quickstart
+
+```shell
+npm install -g @humeai-cli
+hume login
+# Use the browser to login to platform.hume.ai to retrieve your
+# API keys
+hume tts "Are you serious?" --description "whispered, hushed"
+hume voices create --name whisperer --last
+hume tts "I said, are you serious?" --voice-name whisperer
+```
+
+## Installation
+
+The Hume CLI is distributed [via NPM](https://www.npmjs.com/package/@humeai/cli). You can install it globally via:
+
+```shell
+npm install -g @humeai/cli
 ```
 
-To run:
+## Usage
 
-```bash
-bun run index.ts
 ```
+Text to speech
+
+━━━ Usage ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+$ hume tts <text>
+
+━━━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+  -d,--description #0                         Description of the desired voice
+  -c,--continue,--context-generation-id #0    Previous generation ID for continuation
+  -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
+  --last-index #0                             Index of the generation to use from the previous synthesis.
+  -o,--output-dir #0                          Output directory for generated audio files
+  -n,--num-generations #0                     Number of variations to generate
+  -p,--prefix #0                              Filename prefix for generated audio
+  --play #0                                   Play audio after generation: all variations, just the first, or none
+  --play-command #0                           Command to play audio files (uses $AUDIO_FILE as placeholder for file path)
+  --api-key #0                                Override the default API key
+  --format #0                                 Output audio format
+  -v,--voice-name #0                          Name of a previously saved voice
+  --voice-id #0                               Direct voice ID to use
+  --json                                      Output in JSON format
+  --pretty                                    Output in human-readable format
+  --base-url #0                               Override the default API base URL (for testing purposes)
+
+━━━ Details ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
-This project was created using `bun init` in bun v1.2.1. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
+This command converts text to speech using Hume AI's advanced AI voice
+synthesis. You can specify voice characteristics through descriptions or use
+saved voices.
+
+━━━ Examples ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+Basic usage
+  $ 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."
+
+Saving a voice you like (see `hume voices create --help`)
+  $ hume voices create --name influencer_1 --last
+
+Using a previously-saved voice
+  $ hume tts "Thanks for the 100,000,000,000 likes guys!" -v influencer_1
+
+Reading from stdin
+  $ echo "I wouldn't be here without you" | hume tts - -v influencer_1
+
+Continuing previous text
+  $ hume tts "Take some arrows from the quiver" -v influencer_1
+  $ hume tts "Take a bow, too" -v influencer_1 --last # should rhyme with 'toe' not 'cow'
+
+Using custom audio player (macOS/Linux)
+  $ hume tts "Hello world" -v narrator --play-command "mpv $AUDIO_FILE --no-video"
+
+Using custom audio player (Windows)
+  $ hume tts "Hello world" -v narrator --play-command "powershell -c \"[System.Media.SoundPlayer]::new('$AUDIO_FILE').PlaySync()\""
+
+Setting a custom audio player for the session
+  $ hume session set tts.playCommand "vlc $AUDIO_FILE --play-and-exit"
+
+━━━ See also ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+  * `hume voices create --help` - Save a voice for later use
+  * `hume session --help` - Save settings temporarily so you don't have to repeat yourself
+  * `hume config --help` - Save settings more permanently
+```

package/package.json

@@ -1,16 +1,39 @@
 {
   "name": "@humeai/cli",
-  "version": "0.0.1",
-  "description": "A CLI tool",
-  "main": "src/index.ts",
-  "bin": {
-    "your-command-name": "./dist/hume"
+  "version": "0.0.2",
+  "module": "index.ts",
+  "type": "module",
+  "description": "CLI for Hume.ai's OCTAVE expressive TTS API",
+  "devDependencies": {
+    "@types/bun": "^1.2.2",
+    "@types/debug": "^4.1.12",
+    "prettier": "^3.5.2"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
   },
-  "files": [
-    "./dist/hume"
-  ],
   "scripts": {
+    "test": "bun test",
+    "test:verbose": "BUN_TEST_VERBOSE=1 bun test",
+    "typecheck": "tsc --noEmit",
+    "format": "prettier --write \"**/*.{ts,js,json,md}\"",
+    "format:check": "prettier --check \"**/*.{ts,js,json,md}\"",
     "prebuild": "bun build src/index.ts --compile --outfile dist/hume",
     "prepublishOnly": "npm run prebuild"
+  },
+  "dependencies": {
+    "@clack/prompts": "^0.10.0",
+    "bun": "^1.2.2",
+    "clipanion": "^4.0.0-rc.4",
+    "debug": "^4.4.0",
+    "hume": "^0.9.12",
+    "open": "^10.1.0",
+    "typanion": "^3.14.0"
+  },
+  "files": [
+    "dist/hume"
+  ],
+  "bin": {
+    "hume": "dist/hume"
   }
 }

package/src/index.ts

@@ -1 +0,0 @@
-console.log("Hello via Bun!");