Narration-Studio/usage.txt at main · phyce/Narration-Studio · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Narration Studio - TTS Server

Usage:
  --mode string
        Server mode: gui, http, websocket, grpc, tcp, namedpipe, filesystem, library (default "gui")
  --port int
        Server port (for applicable modes) (default 8989)
  --host string
        Server host (for applicable modes) (default "localhost")
  --config string
        Path to custom config JSON file
  --background
        Run server in background mode
  --status
        Check status of background server
  --stop
        Stop background server
  --play string
        Play an audio file (supports WAV, FLAC, OGG, MP3)
  --help
        Show help

Available modes:
  gui        - Launch GUI application (default)
  http       - Start HTTP REST API server
  websocket  - Start WebSocket server (not implemented)
  grpc       - Start gRPC server (not implemented)
  tcp        - Start TCP socket server (not implemented)
  namedpipe  - Start named pipe server (not implemented)
  filesystem - Start file-based server (not implemented)
  library    - Shared library mode (not implemented)

Process Management:
  --background   - Run server in background mode
  --status       - Check status of background server
  --stop         - Stop background server

Examples:
  ./narration-studio --mode=http --port=8989 --config=/path/to/config.json
  ./narration-studio --mode=http --background --port=8989
  ./narration-studio --status
  ./narration-studio --stop
  ./narration-studio --play=/path/to/audio.wav
  ./narration-studio --play=output.mp3
  ./narration-studio --config=/path/to/my-config.json