@bryan-gc/transcribe-cli 1.0.2 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +23 -20
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,46 +1,49 @@
1
1
  # transcribe-cli
2
2
 
3
- Una aplicación de terminal (CLI) escrita en Node.js y TypeScript para grabar audio desde el micrófono y transcribirlo utilizando la API Whisper de OpenAI.
3
+ A terminal (CLI) application built with Node.js and TypeScript that records audio from your microphone and transcribes it using the OpenAI Whisper API.
4
4
 
5
- ## Requisitos Previos del Sistema (Importante)
5
+ ## System Requirements
6
6
 
7
- Para que Node.js pueda grabar audio desde tu micrófono, necesita apoyarse en herramientas del sistema operativo. Dependiendo de tu sistema, debes instalar lo siguiente **antes** de correr el proyecto:
7
+ This tool depends on native audio utilities. Install them before running:
8
8
 
9
9
  ### Linux (Ubuntu / Debian)
10
- Necesitas instalar `sox` y las librerías de soporte de formatos de audio:
11
10
  ```bash
12
11
  sudo apt-get update
13
12
  sudo apt-get install sox libsox-fmt-all
14
13
  ```
15
14
 
16
15
  ### macOS
17
- Puedes instalar `sox` usando Homebrew:
18
16
  ```bash
19
17
  brew install sox
20
18
  ```
21
19
 
22
20
  ### Windows
23
- 1. Descarga los binarios de [SoX](https://sourceforge.net/projects/sox/).
24
- 2. Añade la carpeta donde extrajiste SoX a tu variable de entorno `PATH`.
21
+ 1. Download the binaries from [SoX](https://sourceforge.net/projects/sox/).
22
+ 2. Add the SoX folder to your `PATH` environment variable.
25
23
 
26
24
  ---
27
25
 
28
- ## Instalación del Proyecto
26
+ ## Installation
29
27
 
30
- 1. Clona el repositorio o descarga los archivos.
31
- 2. Instala las dependencias de Node:
32
- ```bash
33
- npm install
34
- ```
35
- 3. Al iniciar la aplicación por primera vez, un prompt interactivo te pedirá tu **API Key de OpenAI** y la **ruta base** para guardar los audios y glosarios. Estos datos se guardarán de forma persistente en `~/.transcribe-cli/config.json`.
28
+ ```bash
29
+ npm install -g @bryan-gc/transcribe-cli
30
+ ```
31
+
32
+ ## First Run & Configuration
33
+
34
+ On the first launch, an interactive prompt will ask you for:
35
+ - Your **OpenAI API Key**
36
+ - A **base path** where audio recordings and glossaries will be stored
37
+
38
+ Your settings are saved persistently at `~/.transcribe-cli/config.json` and reused on every subsequent run.
36
39
 
37
- ## Uso
40
+ ## Usage
38
41
 
39
- Para iniciar la aplicación, simplemente corre:
40
42
  ```bash
41
- npm start
43
+ transcribe-cli
42
44
  ```
43
45
 
44
- La aplicación mostrará un menú interactivo en la terminal. Puedes controlarlo de dos formas:
45
- - **Flechas Direccionales:** Usa Arriba/Abajo para moverte y Enter para seleccionar una opción.
46
- - **Atajos de Teclado:** Presiona `r` para grabar, `p` para pausar, `s` para detener y `t` para transcribir.
46
+ Navigate the interactive menu with:
47
+ - **Arrow keys** — move up/down
48
+ - **Enter** — confirm selection
49
+ - **Hotkeys** — press the letter shown in brackets (e.g. `r` to record, `t` to transcribe, `q` to quit)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bryan-gc/transcribe-cli",
3
- "version": "1.0.2",
3
+ "version": "1.0.3",
4
4
  "description": "CLI tool to record audio and transcribe it using OpenAI Whisper",
5
5
  "main": "dist/index.js",
6
6
  "bin": {