@eldrforge/audio-tools 0.1.12 → 0.1.13
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.
- package/guide/index.md +57 -0
- package/package.json +5 -4
package/guide/index.md
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# @eldrforge/audio-tools - Agentic Guide
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
Audio recording tools for voice-driven development workflows. Enables voice note capture, device management, and transcription.
|
|
6
|
+
|
|
7
|
+
## Key Features
|
|
8
|
+
|
|
9
|
+
- **Audio Recording** - Record voice notes from command line
|
|
10
|
+
- **Device Management** - List and select audio input devices
|
|
11
|
+
- **Countdown Timer** - Visual countdown before recording starts
|
|
12
|
+
- **Transcription** - Convert audio to text via AI service
|
|
13
|
+
- **Cross-platform** - Works on macOS, Linux, and Windows
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { recordAudio, listDevices, transcribe } from '@eldrforge/audio-tools';
|
|
19
|
+
|
|
20
|
+
// List available devices
|
|
21
|
+
const devices = await listDevices();
|
|
22
|
+
|
|
23
|
+
// Record audio
|
|
24
|
+
const audioFile = await recordAudio({
|
|
25
|
+
duration: 60,
|
|
26
|
+
countdown: 3,
|
|
27
|
+
device: devices[0]
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
// Transcribe
|
|
31
|
+
const text = await transcribe(audioFile);
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Dependencies
|
|
35
|
+
|
|
36
|
+
- @eldrforge/ai-service - Transcription via OpenAI
|
|
37
|
+
- @theunwalked/unplayable - Audio recording engine
|
|
38
|
+
|
|
39
|
+
## Package Structure
|
|
40
|
+
|
|
41
|
+
```
|
|
42
|
+
src/
|
|
43
|
+
├── recording.ts # Audio recording
|
|
44
|
+
├── devices.ts # Device management
|
|
45
|
+
├── countdown.ts # Countdown timer
|
|
46
|
+
├── transcription.ts # Audio transcription
|
|
47
|
+
├── types.ts # Type definitions
|
|
48
|
+
└── index.ts
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Key Exports
|
|
52
|
+
|
|
53
|
+
- `recordAudio()` - Record audio from microphone
|
|
54
|
+
- `listDevices()` - List available audio devices
|
|
55
|
+
- `transcribe()` - Transcribe audio to text
|
|
56
|
+
- `countdown()` - Display countdown timer
|
|
57
|
+
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@eldrforge/audio-tools",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.13",
|
|
4
4
|
"description": "Audio recording tools for voice-driven development workflows",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"type": "module",
|
|
@@ -11,7 +11,8 @@
|
|
|
11
11
|
}
|
|
12
12
|
},
|
|
13
13
|
"files": [
|
|
14
|
-
"dist"
|
|
14
|
+
"dist",
|
|
15
|
+
"guide"
|
|
15
16
|
],
|
|
16
17
|
"repository": {
|
|
17
18
|
"type": "git",
|
|
@@ -39,7 +40,7 @@
|
|
|
39
40
|
"author": "Tim O'Brien <tobrien@discursive.com>",
|
|
40
41
|
"license": "Apache-2.0",
|
|
41
42
|
"dependencies": {
|
|
42
|
-
"@eldrforge/ai-service": "^0.1.
|
|
43
|
+
"@eldrforge/ai-service": "^0.1.19",
|
|
43
44
|
"@theunwalked/unplayable": "^0.0.21"
|
|
44
45
|
},
|
|
45
46
|
"peerDependencies": {
|
|
@@ -55,7 +56,7 @@
|
|
|
55
56
|
}
|
|
56
57
|
},
|
|
57
58
|
"devDependencies": {
|
|
58
|
-
"@eldrforge/shared": "^0.1.
|
|
59
|
+
"@eldrforge/shared": "^0.1.8",
|
|
59
60
|
"@eslint/eslintrc": "^3.3.1",
|
|
60
61
|
"@eslint/js": "^9.33.0",
|
|
61
62
|
"@swc/core": "^1.13.3",
|