voice-dashboard 0.1.0

Daily-friendly MiniMax batch TTS CLI

🎙️ Voice Dashboard

A practical MiniMax batch Text-to-Speech CLI for daily workflows.

🌍 English | 🇹🇼 繁體中文

Features • Quick Start • Common Options • Documentation

✨ Features

• Plain-text paragraph splitting by empty lines, generating one MP3 per segment.
• Three input sources (choose one):
  • File path: ttsrun <file.txt>
  • Standard input: ttsrun --stdin
  • Clipboard on supported systems: ttsrun --clipboard
• Optional merge: only merges when --merge is provided.
• Output control for automation and scripting:
  • --quiet
  • --verbose
  • --json-summary
• Output artifacts for traceability:
  • manifest.json
  • errors.jsonl

🚀 Quick Start

1) Set API key

export MINIMAX_API_KEY="your_new_key"

2) Install

For regular local use from source:

python3 -m pip install .

Once the package is published to PyPI, prefer pipx for CLI-style installation:

pipx install voice-dashboard

If you explicitly want the package in an existing Python environment:

python3 -m pip install voice-dashboard

Homebrew support is planned but not published yet. The intended path is documented in docs/HOMEBREW.md.

For contributor setup, use the development guide and editable install instead.

3) Run

# File input
ttsrun examples/sample.txt

# Stdin input
pbpaste | ttsrun --stdin

# Merge only when you need a combined output
pbpaste | ttsrun --stdin --merge

⚙️ Common Options

• --output-dir <dir>: write outputs to a fixed directory.
• --output-root <dir>: set the default output root.
• --name <label>: customize job folder suffix.
• --merge: merge all successful segments and remove segment files.
• --open: open output directory after completion.
• --config <path>: use a specific config file.
• --version: print the installed CLI version.
• doctor: inspect config, API key, and optional dependencies.
• config path: print the resolved config path.
• config show: print the effective config as JSON.
• config example: print a sample config JSON.
• config init: write an example config file.
• --quiet / --verbose: control progress output on stderr.
• --json-summary: print the final manifest summary as JSON.

Preferred management commands:

ttsrun doctor
ttsrun config path
ttsrun config show
ttsrun config init

ttsrun run <input_path> is also supported as an explicit batch subcommand. The older management flags remain available as a deprecated compatibility layer.

📖 Documentation

• Full usage guide: docs/USAGE.md
• Development guide: docs/DEVELOPMENT.md
• Homebrew guide: docs/HOMEBREW.md
• Release guide: docs/RELEASING.md
• Product roadmap: docs/ROADMAP.md

(back to top)

📄 License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details.

👥 Author

Leon Wong - leonwong282

🙏 Acknowledgments

• Best-README-Template
• Shields.io
• MiniMax

📞 Support

• 📝 Open an issue
• 💬 Start a discussion

---

⭐ Star this repository if it helped you!

Made with ❤️ by Leon