Skip to content
OpenCharly

sherpa-onnx

Recipe card from the charly-tools plugin (Images — the deployable catalog).

sherpa-onnx – Offline TTS

Section titled “sherpa-onnx – Offline TTS”

Candy Properties

Section titled “Candy Properties”
Property Value
Install files charly.yml (run: step)
Depends none

Environment

Section titled “Environment”
Variable Value
SHERPA_ONNX_RUNTIME_DIR ~/.local/share/sherpa-onnx/runtime
SHERPA_ONNX_MODEL_DIR ~/.local/share/sherpa-onnx/models
SHERPA_ONNX_VITS_DATA_DIR ~/.local/share/sherpa-onnx/models/vits-piper-en_US-lessac-high/espeak-ng-data

Usage

Section titled “Usage”
# box charly.yml — compose the candy as an inline list in the box body
my-box:
  candy:
    base: fedora
    candy: [sherpa-onnx]

Synthesise Speech

Section titled “Synthesise Speech”

The baked vits-piper-en_US-lessac-high voice synthesises offline. Every option takes the = form, and --vits-data-dir is required: the piper voice speaks espeak-ng phonemes, so leaving it empty exits 255 with Not a model using characters as modeling unit. The candy exports that data dir, so the invocation below works with nothing but the installed runtime:

Terminal window
~/.local/share/sherpa-onnx/runtime/bin/sherpa-onnx-offline-tts \
  --vits-model=$SHERPA_ONNX_MODEL_DIR/vits-piper-en_US-lessac-high/en_US-lessac-high.onnx \
  --vits-tokens=$SHERPA_ONNX_MODEL_DIR/vits-piper-en_US-lessac-high/tokens.txt \
  --vits-data-dir=$SHERPA_ONNX_VITS_DATA_DIR \
  --output-filename=/tmp/out.wav "hello"

The candy’s plan: runs that same invocation as a check:, so a voice that cannot synthesise fails the plan instead of passing every check.

Used In Boxes

Section titled “Used In Boxes”
Section titled “Related Candies”
Section titled “Related Commands”

When to Use This Skill

Section titled “When to Use This Skill”

Use when the user asks about:

  • Offline text-to-speech
  • sherpa-onnx TTS engine
  • ONNX-based speech synthesis
  • The sherpa-onnx candy
Section titled “Related”
  • /charly-image:layer — candy authoring reference (charly.yml schema, plan-step verbs, service declarations)
  • /charly-check:check — declarative testing (check: block, charly check box, charly check live)