@wovin/tranz-cli 0.0.26

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2024-2026, gotjoshua
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,447 @@
+# @wovin/tranz-cli
+
+CLI for audio and video transcription
+
+[![JSR](https://jsr.io/badges/@wovin/tranz-cli)](https://jsr.io/@wovin/tranz-cli)
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+
+- [Quick Start](#quick-start)
+- [Setup / Configuration](#setup--configuration)
+- [Commands](#commands)
+
+# Quick Start
+
+Transcribe an audio file using the Mistral provider with speaker diarization and segment-level timestamps:
+
+```sh
+tranz scribe --provider mistral --timestamps segment --diarization path/to/audio.file
+```
+
+# Setup / Configuration
+
+## Installation
+
+```sh
+# npm
+npm install -g @wovin/tranz-cli
+
+# pnpm
+pnpm add -g @wovin/tranz-cli
+
+# yarn
+yarn global add @wovin/tranz-cli
+
+# deno
+deno install -g jsr:@wovin/tranz-cli
+
+# jsr (for any runtime)
+npx jsr add -g @wovin/tranz-cli
+```
+
+## API Key Configuration
+
+The `scribe` command supports multiple transcription providers. For API-based providers (Mistral, GreenPT), you need to configure an API key.
+
+### Option 1: Environment Variable (Recommended)
+
+```sh
+export MISTRAL_API_KEY="your-api-key-here"
+tranz scribe path/to/audio.mp3
+```
+
+### Option 2: Secret File
+
+Create a secret file in the project directory:
+
+```sh
+mkdir -p secret
+echo "your-api-key-here" > secret/mistral
+```
+
+The tool will automatically look for `secret/mistral` if the `MISTRAL_API_KEY` environment variable is not set.
+
+## Supported Providers
+
+- **whisper** (default) - Local Whisper transcription (no API key needed)
+- **mistral** - Mistral Voxtral transcription API
+- **greenpt** - GreenPT transcription API
+
+For GreenPT, use the same pattern with `GREENPT_API_KEY` or `secret/greenpt`.
+
+## Common Examples
+
+### Basic transcription with Whisper (local, no API key)
+```sh
+tranz scribe path/to/audio.mp3
+```
+
+### Mistral with specific model
+```sh
+tranz scribe path/to/audio.mp3 --provider mistral --model voxtral-mini-latest
+```
+
+### Mistral with word-level timestamps and diarization
+```sh
+tranz scribe path/to/audio.mp3 --provider mistral --timestamps word --diarization
+```
+
+### Transcribe with preprocessing and normalization
+```sh
+tranz scribe path/to/audio.mp3 --prep --norm
+```
+
+### GreenPT with language specification
+```sh
+tranz scribe path/to/audio.mp3 --provider greenpt --language en
+```
+
+# Usage
+
+```sh-session
+$ npm install -g @wovin/tranz-cli
+$ tranz COMMAND
+running command...
+$ tranz (--version)
+@wovin/tranz-cli/0.0.26 linux-x64 node-v22.20.0
+$ tranz --help [COMMAND]
+USAGE
+  $ tranz COMMAND
+  ...
+```
+
+# Commands
+
+- [`tranz help [COMMANDS]`](#tranz-help-commands)
+- [`tranz plugins`](#tranz-plugins)
+- [`tranz plugins:install PLUGIN...`](#tranz-pluginsinstall-plugin)
+- [`tranz plugins:inspect PLUGIN...`](#tranz-pluginsinspect-plugin)
+- [`tranz plugins:install PLUGIN...`](#tranz-pluginsinstall-plugin-1)
+- [`tranz plugins:link PLUGIN`](#tranz-pluginslink-plugin)
+- [`tranz plugins:uninstall PLUGIN...`](#tranz-pluginsuninstall-plugin)
+- [`tranz plugins:uninstall PLUGIN...`](#tranz-pluginsuninstall-plugin-1)
+- [`tranz plugins:uninstall PLUGIN...`](#tranz-pluginsuninstall-plugin-2)
+- [`tranz plugins update`](#tranz-plugins-update)
+- [`tranz prep INPUT`](#tranz-prep-input)
+- [`tranz scribe INPUT`](#tranz-scribe-input)
+
+## `tranz help [COMMANDS]`
+
+Display help for tranz.
+
+```
+USAGE
+  $ tranz help [COMMANDS] [-n]
+
+ARGUMENTS
+  COMMANDS  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for tranz.
+```
+
+_See code:_ [_@oclif/plugin-help_](https://github.com/oclif/plugin-help/blob/v5.2.15/src/commands/help.ts)
+
+## `tranz plugins`
+
+List installed plugins.
+
+```
+USAGE
+  $ tranz plugins [--json] [--core]
+
+FLAGS
+  --core  Show core plugins.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  List installed plugins.
+
+EXAMPLES
+  $ tranz plugins
+```
+
+_See code:_ [_@oclif/plugin-plugins_](https://github.com/oclif/plugin-plugins/blob/v3.1.8/src/commands/plugins/index.ts)
+
+## `tranz plugins:install PLUGIN...`
+
+Installs a plugin into the CLI.
+
+```
+USAGE
+  $ tranz plugins:install PLUGIN...
+
+ARGUMENTS
+  PLUGIN  Plugin to install.
+
+FLAGS
+  -f, --force    Run yarn install with force flag.
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Installs a plugin into the CLI.
+  Can be installed from npm or a git url.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
+  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
+  the CLI without the need to patch and update the whole CLI.
+
+
+ALIASES
+  $ tranz plugins add
+
+EXAMPLES
+  $ tranz plugins:install myplugin
+
+  $ tranz plugins:install https://github.com/someuser/someplugin
+
+  $ tranz plugins:install someuser/someplugin
+```
+
+## `tranz plugins:inspect PLUGIN...`
+
+Displays installation properties of a plugin.
+
+```
+USAGE
+  $ tranz plugins:inspect PLUGIN...
+
+ARGUMENTS
+  PLUGIN  [default: .] Plugin to inspect.
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Displays installation properties of a plugin.
+
+EXAMPLES
+  $ tranz plugins:inspect myplugin
+```
+
+_See code:_ [_@oclif/plugin-plugins_](https://github.com/oclif/plugin-plugins/blob/v3.1.8/src/commands/plugins/inspect.ts)
+
+## `tranz plugins:install PLUGIN...`
+
+Installs a plugin into the CLI.
+
+```
+USAGE
+  $ tranz plugins:install PLUGIN...
+
+ARGUMENTS
+  PLUGIN  Plugin to install.
+
+FLAGS
+  -f, --force    Run yarn install with force flag.
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Installs a plugin into the CLI.
+  Can be installed from npm or a git url.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
+  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
+  the CLI without the need to patch and update the whole CLI.
+
+
+ALIASES
+  $ tranz plugins add
+
+EXAMPLES
+  $ tranz plugins:install myplugin
+
+  $ tranz plugins:install https://github.com/someuser/someplugin
+
+  $ tranz plugins:install someuser/someplugin
+```
+
+_See code:_ [_@oclif/plugin-plugins_](https://github.com/oclif/plugin-plugins/blob/v3.1.8/src/commands/plugins/install.ts)
+
+## `tranz plugins:link PLUGIN`
+
+Links a plugin into the CLI for development.
+
+```
+USAGE
+  $ tranz plugins:link PLUGIN
+
+ARGUMENTS
+  PATH  [default: .] path to plugin
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Links a plugin into the CLI for development.
+  Installation of a linked plugin will override a user-installed or core plugin.
+
+  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
+  command will override the user-installed or core plugin implementation. This is useful for development work.
+
+
+EXAMPLES
+  $ tranz plugins:link myplugin
+```
+
+_See code:_ [_@oclif/plugin-plugins_](https://github.com/oclif/plugin-plugins/blob/v3.1.8/src/commands/plugins/link.ts)
+
+## `tranz plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ tranz plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ tranz plugins unlink
+  $ tranz plugins remove
+```
+
+## `tranz plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ tranz plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ tranz plugins unlink
+  $ tranz plugins remove
+```
+
+_See code:_ [_@oclif/plugin-plugins_](https://github.com/oclif/plugin-plugins/blob/v3.1.8/src/commands/plugins/uninstall.ts)
+
+## `tranz plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ tranz plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ tranz plugins unlink
+  $ tranz plugins remove
+```
+
+## `tranz plugins update`
+
+Update installed plugins.
+
+```
+USAGE
+  $ tranz plugins update [-h] [-v]
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Update installed plugins.
+```
+
+_See code:_ [_@oclif/plugin-plugins_](https://github.com/oclif/plugin-plugins/blob/v3.1.8/src/commands/plugins/update.ts)
+
+## `tranz prep INPUT`
+
+Prepare audio file - normalize, noise reduce, split on silence
+
+```
+USAGE
+  $ tranz prep INPUT [-n] [-o <value>] [-s <value>] [-d <value>]
+
+ARGUMENTS
+  INPUT  input file
+
+FLAGS
+  -d, --sildur=<value>   [default: 1.1] silence duration
+  -n, --norm             do normalization?
+  -o, --output=<value>   [default: ./out] output directory
+  -s, --silence=<value>  [default: -45dB] silence threshold
+
+DESCRIPTION
+  Prepare audio file - normalize, noise reduce, split on silence
+
+EXAMPLES
+  $ tranz prep path/to/audio.mp3
+```
+
+_See code:_ [_src/commands/prep/index.ts_](https://gitlab.com/onezoomin/ztax/tranz/-/blob/main/packages/tranz-cli/src/commands/prep/index.ts)
+
+## `tranz scribe INPUT`
+
+Transcribe audio file - optionally prepare first
+
+```
+USAGE
+  $ tranz scribe INPUT [-o <value>] [-p] [-n] [-d]
+
+ARGUMENTS
+  INPUT  input file
+
+FLAGS
+  -d, --separate_speakers  separate via diarization
+  -n, --norm               do normalization?
+  -o, --output=<value>     [default: ./out] output directory
+  -p, --prep               do prep?
+
+DESCRIPTION
+  Transcribe audio file - optionally prepare first
+
+EXAMPLES
+  $ tranz scribe 'path/to/16khz-audiofile.wav'
+  runs whisper and outputs and saves a transcription json
+
+  $ tranz scribe 'path/to/whatever-audiofile.mp3' -p
+  first prepares and then runs whisper and outputs and saves a transcription json
+```
+
+_See code:_ [_src/commands/scribe/index.ts_](https://gitlab.com/onezoomin/ztax/tranz/-/blob/main/packages/tranz-cli/src/commands/scribe/index.ts)

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\dev" %*

package/bin/dev.js

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+
+import {fileURLToPath} from 'node:url'
+import {dirname} from 'node:path'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = dirname(__filename)
+
+// In dev mode, run from the parent directory
+await (await import('@oclif/core')).run(process.argv.slice(2), __dirname)

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/bin/run.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env bun
+// eslint-disable-next-line node/shebang
+(async () => {
+  const oclif = await import('@oclif/core')
+  await oclif.execute({type: 'esm', dir: import.meta.url})
+})()

package/dist/commands/prep/index.d.ts

@@ -0,0 +1,59 @@
+import { Command, Config } from '@oclif/core';
+type GenericObject = Record<string, any>;
+type FfmpegResults = {
+    ffmpegChain: any;
+    outputPath: string;
+};
+type PrepProps = {
+    input: string;
+    outdir: string;
+    silthr: string;
+    sildur: string;
+    norm: boolean;
+    verbose: boolean;
+};
+type PrepResult = {
+    props: PrepProps;
+    info: GenericObject;
+    results: FfmpegResults;
+};
+export default class Prep extends Command {
+    static description: string;
+    static DEFAULTS: {
+        SILDUR: string;
+        SILBUF: number;
+        SILTHR: string;
+        RNNN: string;
+    };
+    static args: {
+        name: string;
+        description: string;
+        required: boolean;
+    }[];
+    static flags: {
+        norm: import("@oclif/core/lib/interfaces/parser").BooleanFlag<boolean>;
+        verbose: import("@oclif/core/lib/interfaces/parser").BooleanFlag<boolean>;
+        outdir: import("@oclif/core/lib/interfaces/parser").OptionFlag<string>;
+        silthr: import("@oclif/core/lib/interfaces/parser").OptionFlag<string>;
+        sildur: import("@oclif/core/lib/interfaces/parser").OptionFlag<string>;
+    };
+    /**
+     * subroutines
+     */
+    static normalize: (path: string, outputDir: string) => Promise<string>;
+    static removeSilence: (inputPath: string, silence: string | number, sildur: string | number, output?: string) => Promise<void>;
+    /**
+     * cli only (depends on config and fs situation)
+     */
+    static ensureRnnnIsCached: (config: Config) => Promise<string>;
+    /**
+     * doPrep
+     */
+    doPrep(props: PrepProps): Promise<PrepResult>;
+    /**
+     * only for cli parsing
+     */
+    run(): Promise<void>;
+    static examples: string[];
+}
+export {};