skills-vault/skills/voice-generation/INSTALL.md

88 lines
2.7 KiB
Markdown

# Install voice-generation
`voice-generation` provides the `voice-gen` Python CLI and a Skill wrapper for Agentic tools.
## Conda Environment
Use the repository-level `skills-vault` Conda environment.
```powershell
conda env create -f environment.yml
conda activate skills-vault
```
If the environment already exists:
```powershell
conda activate skills-vault
```
This Skill does not currently require a dedicated Conda environment. Create one only if future dependencies conflict with the shared `skills-vault` environment.
## Install Python Package
From the repository root:
```powershell
pip install -e .\skills\voice-generation
```
If the current shell has not activated the environment, use the environment Python directly:
```powershell
C:\Users\wangq\.conda\envs\skills-vault\python.exe -m pip install -e .\skills\voice-generation
```
## External Requirements
Install and authenticate MiniMax `mmx`:
```powershell
npm.cmd install -g mmx-cli
cmd /c mmx auth login
cmd /c mmx auth status
```
## Install Skill Wrapper
Use the repository installer from the repository root:
```powershell
powershell -ExecutionPolicy Bypass -File .\scripts\install-skill.ps1 -Skill voice-generation
```
Replace an existing installed copy after backing it up:
```powershell
powershell -ExecutionPolicy Bypass -File .\scripts\install-skill.ps1 -Skill voice-generation -Force -InstallClaudeLink
```
## Test
Testing is intentionally separate from migration.
Run source tests from the repository root. Disabling pytest's cache provider avoids writes under a read-only installed Skill directory:
```powershell
New-Item -ItemType Directory -Force -Path .\tmp | Out-Null
conda run -n skills-vault python -B -m pytest .\skills\voice-generation\tests -p no:cacheprovider --basetemp .\tmp\pytest-voice-generation
```
Validate the Skill structure and installed copy separately:
```powershell
conda run -n skills-vault python -B .\scripts\quick_validate.py .\skills\voice-generation
conda run -n skills-vault python -B .\scripts\quick_validate.py C:\Users\wangq\.agents\skills\voice-generation
C:\Users\wangq\.conda\envs\skills-vault\python.exe -B -m pytest C:\Users\wangq\.agents\skills\voice-generation\tests -p no:cacheprovider --basetemp .\tmp\pytest-voice-generation-installed
```
Smoke tests may call real MiniMax services and consume quota. Do not run them unless explicitly requested.
For a real long-form test, create an isolated project under the repository `tmp` directory, populate `voices.json` and `scripts\`, then run from that project root:
```powershell
conda run -n skills-vault voice-gen gen --voice <voice-name> scripts --out output --format mp3
```
The command sends the extracted narration text to MiniMax. Confirm that external transmission is intended before running it.