grdev.narrator 0.2.0

Suggested Alternatives

grdev.elevenlabs-cli

Additional Details

package rename

The owner has unlisted this package. This could mean that the package is deprecated, has security vulnerabilities or shouldn't be used anymore.
dotnet tool install --global grdev.narrator --version 0.2.0
                    
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest
                    
if you are setting up this repo
dotnet tool install --local grdev.narrator --version 0.2.0
                    
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=grdev.narrator&version=0.2.0
                    
nuke :add-package grdev.narrator --version 0.2.0
                    

Narrator

Narrator is a command-line tool that turns a Markdown script into AI narration, one audio clip per paragraph, using the ElevenLabs API.

The core idea is a content-addressed cache: each paragraph's audio is keyed by its content and voice settings, not its position. Edit one paragraph — even split it into two — and every other clip is reused from cache, so you never re-pay for narration that didn't change.

Documentation

Requirements

  • .NET SDK 10.0
  • An ElevenLabs API key

Install

Narrator is published as a global dotnet tool:

dotnet tool install --global grdev.narrator

Then run it as narrator. For local development from source, use scripts/install-dev-pc.ps1.

Usage

narrator --script .\script.md

Or, from source without installing:

dotnet run --project .\src\Narrator\Narrator.csproj -- --script .\script.md

Options:

Flag Required Default Notes
--script yes — Path to the Markdown script file.
--output no <script-dir>\output Output folder. Cache lives in <output>\.cache.
--watch no off Watch the script and regenerate changed paragraphs automatically.
--dry-run no off Preview cache misses and the character count to be spent — no API calls.

Voice configuration (voice id + settings) is read from YAML frontmatter at the top of the script — see the spec.

API key

Narrator reads the ElevenLabs key from, in order:

  1. apiKey in the script frontmatter (use for one-offs only).
  2. %USERPROFILE%\.narrator.json → { "apiKey": "sk_..." } (recommended).

Never commit a key in frontmatter if the script lives in a repo.

Output

One MP3 per paragraph, named NN - first five words.mp3, in sequence. Audio is meant to be finalized before editing; sequential numbering makes (re-)placement on a timeline obvious.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last Updated