@drakulavich/parakeet-cli 0.1.2 → 0.1.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.
- package/README.md +14 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,10 +12,18 @@ Fast multilingual speech-to-text CLI powered by NVIDIA Parakeet ONNX models. Zer
|
|
|
12
12
|
|
|
13
13
|
## Install
|
|
14
14
|
|
|
15
|
+
Using Bun (recommended):
|
|
16
|
+
|
|
15
17
|
```bash
|
|
16
18
|
bun install -g @drakulavich/parakeet-cli
|
|
17
19
|
```
|
|
18
20
|
|
|
21
|
+
Using npm (requires Bun runtime installed):
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
npm install -g @drakulavich/parakeet-cli
|
|
25
|
+
```
|
|
26
|
+
|
|
19
27
|
Or clone and link locally:
|
|
20
28
|
|
|
21
29
|
```bash
|
|
@@ -25,6 +33,8 @@ bun install
|
|
|
25
33
|
bun link
|
|
26
34
|
```
|
|
27
35
|
|
|
36
|
+
> **Note:** Bun is required as the runtime — the CLI uses Bun-native APIs and TypeScript execution. You can use either `bun` or `npm` as the package manager to install it, but Bun must be available in PATH to run the `parakeet` command.
|
|
37
|
+
|
|
28
38
|
## Usage
|
|
29
39
|
|
|
30
40
|
```bash
|
|
@@ -86,9 +96,10 @@ Uses [NVIDIA Parakeet TDT 0.6B v3](https://huggingface.co/nvidia/parakeet-tdt-0.
|
|
|
86
96
|
|
|
87
97
|
## Requirements
|
|
88
98
|
|
|
89
|
-
- [Bun](https://bun.sh) >= 1.3
|
|
99
|
+
- [Bun](https://bun.sh) >= 1.3 (runtime)
|
|
90
100
|
- [ffmpeg](https://ffmpeg.org) installed and in PATH
|
|
91
101
|
- ~3GB disk space for model cache
|
|
102
|
+
- npm or Bun can be used as the package manager
|
|
92
103
|
|
|
93
104
|
### macOS (Apple Silicon)
|
|
94
105
|
|
|
@@ -97,7 +108,7 @@ Works natively on M1/M2/M3/M4. Install dependencies with Homebrew:
|
|
|
97
108
|
```bash
|
|
98
109
|
brew install ffmpeg
|
|
99
110
|
curl -fsSL https://bun.sh/install | bash
|
|
100
|
-
bun install -g @drakulavich/parakeet-cli
|
|
111
|
+
bun install -g @drakulavich/parakeet-cli # or: npm install -g @drakulavich/parakeet-cli
|
|
101
112
|
```
|
|
102
113
|
|
|
103
114
|
### Linux
|
|
@@ -105,7 +116,7 @@ bun install -g @drakulavich/parakeet-cli
|
|
|
105
116
|
```bash
|
|
106
117
|
apt install ffmpeg # or yum, pacman, etc.
|
|
107
118
|
curl -fsSL https://bun.sh/install | bash
|
|
108
|
-
bun install -g @drakulavich/parakeet-cli
|
|
119
|
+
bun install -g @drakulavich/parakeet-cli # or: npm install -g @drakulavich/parakeet-cli
|
|
109
120
|
```
|
|
110
121
|
|
|
111
122
|
## OpenClaw Integration
|