Skip to content

Commit 18826e9

Browse files
committed
Update docs.
1 parent d2ec178 commit 18826e9

1 file changed

Lines changed: 32 additions & 3 deletions

File tree

DOCUMENTATION.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,18 @@ Generate a standalone callout PNG for testing.
184184
screenkit callout --type info --title "Note" --body "This is important" --output callout.png
185185
```
186186

187+
#### `screenkit completion`
188+
189+
Generate shell completion script.
190+
191+
**Options:**
192+
193+
- `--shell` (required) - Shell type (`bash`, `zsh`, `powershell`, `fish`)
194+
195+
```bash
196+
screenkit completion --shell zsh
197+
```
198+
187199
### Episode Commands
188200

189201
#### `screenkit episode new`
@@ -209,6 +221,8 @@ Export an episode to video.
209221
- `--tts-api-key` - API key for TTS service (e.g., ElevenLabs)
210222
- `--tts-preset` - TTS preset name that will be used
211223
- `--overwrite` - Overwrite existing exported files (default: `false`)
224+
- `--overwrite-voiceover` - Regenerate all voiceover audio files (default: `false`)
225+
- `--overwrite-content` - Regenerate all content files (e.g., demo tapes) (default: `false`)
212226
- `--match-segment` - Only export segments matching this string
213227
- `--output-dir` - Custom output directory path
214228
- `--banner` - Display ScreenKit banner (default: `true`)
@@ -547,6 +561,7 @@ Available presets:
547561
- `discord`
548562
- `dribbble`
549563
- `github`
564+
- `instagram`
550565
- `linkedin`
551566
- `mastodon`
552567
- `snap`
@@ -833,6 +848,20 @@ tts:
833848
rate: 150 # Words per minute (optional)
834849
```
835850

851+
### `espeak` Engine
852+
853+
Uses the `espeak` command-line TTS tool.
854+
855+
```yaml
856+
tts:
857+
- id: espeak
858+
engine: espeak
859+
voice: en # Optional: Voice name
860+
rate: 150 # Optional: Speaking rate
861+
```
862+
863+
Requires `espeak` installed and in PATH.
864+
836865
### ElevenLabs Engine
837866

838867
The ElevenLabs TTS engine requires an API key. Set it via the `--tts-api-key`
@@ -862,9 +891,9 @@ tts:
862891

863892
#### ElevenLabs Output Formats
864893

865-
- MP3: `mp3_22050_32`, `mp3_44100_128`, `mp3_44100_192`
866-
- PCM: `pcm_16000`, `pcm_24000`, `pcm_44100`
867-
- Opus: `opus_48000_32`, `opus_48000_64`
894+
- MP3: `mp3_22050_32`, `mp3_24000_48`, `mp3_44100_32`, `mp3_44100_64`, `mp3_44100_96`, `mp3_44100_128`, `mp3_44100_192`
895+
- PCM: `pcm_8000`, `pcm_16000`, `pcm_22050`, `pcm_24000`, `pcm_32000`, `pcm_44100`, `pcm_48000`
896+
- Opus: `opus_48000_32`, `opus_48000_64`, `opus_48000_96`, `opus_48000_128`, `opus_48000_192`
868897
- Others: `ulaw_8000`, `alaw_8000`
869898

870899
### Disable TTS

0 commit comments

Comments
 (0)