vidgen 0.0.1
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 +781 -0
- package/bin/dev.cmd +3 -0
- package/bin/dev.js +5 -0
- package/bin/run.cmd +3 -0
- package/bin/run.js +5 -0
- package/dist/commands/db/init.d.ts +6 -0
- package/dist/commands/db/init.js +18 -0
- package/dist/commands/generate/stt.d.ts +13 -0
- package/dist/commands/generate/stt.js +73 -0
- package/dist/commands/generate/tts.d.ts +11 -0
- package/dist/commands/generate/tts.js +30 -0
- package/dist/commands/index/chunk.d.ts +11 -0
- package/dist/commands/index/chunk.js +55 -0
- package/dist/commands/index/describe.d.ts +11 -0
- package/dist/commands/index/describe.js +29 -0
- package/dist/commands/index/embed.d.ts +11 -0
- package/dist/commands/index/embed.js +29 -0
- package/dist/commands/index/save.d.ts +10 -0
- package/dist/commands/index/save.js +24 -0
- package/dist/commands/project/create.d.ts +11 -0
- package/dist/commands/project/create.js +63 -0
- package/dist/commands/project/delete.d.ts +9 -0
- package/dist/commands/project/delete.js +31 -0
- package/dist/commands/project/get.d.ts +9 -0
- package/dist/commands/project/get.js +39 -0
- package/dist/commands/project/list.d.ts +6 -0
- package/dist/commands/project/list.js +26 -0
- package/dist/commands/project/validate.d.ts +10 -0
- package/dist/commands/project/validate.js +29 -0
- package/dist/commands/search/asset.d.ts +12 -0
- package/dist/commands/search/asset.js +35 -0
- package/dist/commands/segment/add.d.ts +11 -0
- package/dist/commands/segment/add.js +49 -0
- package/dist/commands/segment/delete.d.ts +9 -0
- package/dist/commands/segment/delete.js +29 -0
- package/dist/commands/segment/list.d.ts +9 -0
- package/dist/commands/segment/list.js +33 -0
- package/dist/commands/segment/update.d.ts +13 -0
- package/dist/commands/segment/update.js +50 -0
- package/dist/commands/video/caption.d.ts +12 -0
- package/dist/commands/video/caption.js +43 -0
- package/dist/commands/video/trim.d.ts +13 -0
- package/dist/commands/video/trim.js +52 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -0
- package/dist/lib/db.d.ts +7 -0
- package/dist/lib/db.js +39 -0
- package/dist/lib/stt/deepgram-to-combo.d.ts +2 -0
- package/dist/lib/stt/deepgram-to-combo.js +49 -0
- package/dist/lib/stt/deepgram.d.ts +18 -0
- package/dist/lib/stt/deepgram.js +71 -0
- package/dist/lib/stt/detect-language.d.ts +2 -0
- package/dist/lib/stt/detect-language.js +31 -0
- package/dist/lib/stt/index.d.ts +50 -0
- package/dist/lib/stt/index.js +50 -0
- package/dist/lib/stt/types.d.ts +65 -0
- package/dist/lib/stt/types.js +1 -0
- package/dist/lib/types.d.ts +131 -0
- package/dist/lib/types.js +1 -0
- package/oclif.manifest.json +874 -0
- package/package.json +79 -0
package/README.md
ADDED
|
@@ -0,0 +1,781 @@
|
|
|
1
|
+
removideo
|
|
2
|
+
=================
|
|
3
|
+
|
|
4
|
+
A CLI for all video tasks
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
[](https://oclif.io)
|
|
8
|
+
[](https://npmjs.org/package/removideo)
|
|
9
|
+
[](https://npmjs.org/package/removideo)
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
<!-- toc -->
|
|
13
|
+
* [Usage](#usage)
|
|
14
|
+
* [Commands](#commands)
|
|
15
|
+
<!-- tocstop -->
|
|
16
|
+
# Usage
|
|
17
|
+
<!-- usage -->
|
|
18
|
+
```sh-session
|
|
19
|
+
$ npm install -g vidgen
|
|
20
|
+
$ vidgen COMMAND
|
|
21
|
+
running command...
|
|
22
|
+
$ vidgen (--version)
|
|
23
|
+
vidgen/0.0.1 darwin-x64 node-v24.1.0
|
|
24
|
+
$ vidgen --help [COMMAND]
|
|
25
|
+
USAGE
|
|
26
|
+
$ vidgen COMMAND
|
|
27
|
+
...
|
|
28
|
+
```
|
|
29
|
+
<!-- usagestop -->
|
|
30
|
+
# Commands
|
|
31
|
+
<!-- commands -->
|
|
32
|
+
* [`vidgen db init`](#vidgen-db-init)
|
|
33
|
+
* [`vidgen generate stt`](#vidgen-generate-stt)
|
|
34
|
+
* [`vidgen generate tts`](#vidgen-generate-tts)
|
|
35
|
+
* [`vidgen help [COMMAND]`](#vidgen-help-command)
|
|
36
|
+
* [`vidgen index chunk`](#vidgen-index-chunk)
|
|
37
|
+
* [`vidgen index describe`](#vidgen-index-describe)
|
|
38
|
+
* [`vidgen index embed`](#vidgen-index-embed)
|
|
39
|
+
* [`vidgen index save`](#vidgen-index-save)
|
|
40
|
+
* [`vidgen plugins`](#vidgen-plugins)
|
|
41
|
+
* [`vidgen plugins add PLUGIN`](#vidgen-plugins-add-plugin)
|
|
42
|
+
* [`vidgen plugins:inspect PLUGIN...`](#vidgen-pluginsinspect-plugin)
|
|
43
|
+
* [`vidgen plugins install PLUGIN`](#vidgen-plugins-install-plugin)
|
|
44
|
+
* [`vidgen plugins link PATH`](#vidgen-plugins-link-path)
|
|
45
|
+
* [`vidgen plugins remove [PLUGIN]`](#vidgen-plugins-remove-plugin)
|
|
46
|
+
* [`vidgen plugins reset`](#vidgen-plugins-reset)
|
|
47
|
+
* [`vidgen plugins uninstall [PLUGIN]`](#vidgen-plugins-uninstall-plugin)
|
|
48
|
+
* [`vidgen plugins unlink [PLUGIN]`](#vidgen-plugins-unlink-plugin)
|
|
49
|
+
* [`vidgen plugins update`](#vidgen-plugins-update)
|
|
50
|
+
* [`vidgen project create`](#vidgen-project-create)
|
|
51
|
+
* [`vidgen project delete ID`](#vidgen-project-delete-id)
|
|
52
|
+
* [`vidgen project get ID`](#vidgen-project-get-id)
|
|
53
|
+
* [`vidgen project list`](#vidgen-project-list)
|
|
54
|
+
* [`vidgen project validate`](#vidgen-project-validate)
|
|
55
|
+
* [`vidgen search asset`](#vidgen-search-asset)
|
|
56
|
+
* [`vidgen segment add`](#vidgen-segment-add)
|
|
57
|
+
* [`vidgen segment delete ID`](#vidgen-segment-delete-id)
|
|
58
|
+
* [`vidgen segment list PROJECTID`](#vidgen-segment-list-projectid)
|
|
59
|
+
* [`vidgen segment update ID`](#vidgen-segment-update-id)
|
|
60
|
+
* [`vidgen video caption`](#vidgen-video-caption)
|
|
61
|
+
* [`vidgen video trim`](#vidgen-video-trim)
|
|
62
|
+
|
|
63
|
+
## `vidgen db init`
|
|
64
|
+
|
|
65
|
+
Initialize the Turso database schema (projects and segments tables).
|
|
66
|
+
|
|
67
|
+
```
|
|
68
|
+
USAGE
|
|
69
|
+
$ vidgen db init
|
|
70
|
+
|
|
71
|
+
DESCRIPTION
|
|
72
|
+
Initialize the Turso database schema (projects and segments tables).
|
|
73
|
+
|
|
74
|
+
EXAMPLES
|
|
75
|
+
$ vidgen db init
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
_See code: [src/commands/db/init.ts](https://github.com/xo-o/vidgen/blob/v0.0.1/src/commands/db/init.ts)_
|
|
79
|
+
|
|
80
|
+
## `vidgen generate stt`
|
|
81
|
+
|
|
82
|
+
Generate a Speech-to-Text (STT) transcript from an audio file using Deepgram. Populates the SpeechToText object in a Segment.
|
|
83
|
+
|
|
84
|
+
```
|
|
85
|
+
USAGE
|
|
86
|
+
$ vidgen generate stt -a <value> -o <value> [-l <value>] [-m <value>] [-s <value>]
|
|
87
|
+
|
|
88
|
+
FLAGS
|
|
89
|
+
-a, --audio=<value> (required) URL or local path to the audio file to transcribe
|
|
90
|
+
-l, --language=<value> Target language for transcription (e.g. "en"). Omit for auto-detection.
|
|
91
|
+
-m, --model=<value> [default: nova-3] Deepgram model to use
|
|
92
|
+
-o, --output=<value> (required) Path to write the transcript JSON output
|
|
93
|
+
-s, --segmentId=<value> Segment ID to update with the STT result
|
|
94
|
+
|
|
95
|
+
DESCRIPTION
|
|
96
|
+
Generate a Speech-to-Text (STT) transcript from an audio file using Deepgram. Populates the SpeechToText object in a
|
|
97
|
+
Segment.
|
|
98
|
+
|
|
99
|
+
EXAMPLES
|
|
100
|
+
$ vidgen generate stt --audio https://storage.example.com/seg_001.mp3 --output ./captions/seg_001.json
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
_See code: [src/commands/generate/stt.ts](https://github.com/xo-o/vidgen/blob/v0.0.1/src/commands/generate/stt.ts)_
|
|
104
|
+
|
|
105
|
+
## `vidgen generate tts`
|
|
106
|
+
|
|
107
|
+
Generate a Text-to-Speech (TTS) audio file from a script. Populates the TextToSpeech object in a Segment.
|
|
108
|
+
|
|
109
|
+
```
|
|
110
|
+
USAGE
|
|
111
|
+
$ vidgen generate tts -o <value> -t <value> -v <value>
|
|
112
|
+
|
|
113
|
+
FLAGS
|
|
114
|
+
-o, --output=<value> (required) Path or URL to write the generated audio file
|
|
115
|
+
-t, --text=<value> (required) The script text to convert to speech
|
|
116
|
+
-v, --voiceId=<value> (required) Voice ID to use for the TTS provider (e.g. ElevenLabs, OpenAI)
|
|
117
|
+
|
|
118
|
+
DESCRIPTION
|
|
119
|
+
Generate a Text-to-Speech (TTS) audio file from a script. Populates the TextToSpeech object in a Segment.
|
|
120
|
+
|
|
121
|
+
EXAMPLES
|
|
122
|
+
$ vidgen generate tts --text "Blockchain is revolutionizing..." --voiceId en-US-1 --output ./audio/seg_001.mp3
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
_See code: [src/commands/generate/tts.ts](https://github.com/xo-o/vidgen/blob/v0.0.1/src/commands/generate/tts.ts)_
|
|
126
|
+
|
|
127
|
+
## `vidgen help [COMMAND]`
|
|
128
|
+
|
|
129
|
+
Display help for vidgen.
|
|
130
|
+
|
|
131
|
+
```
|
|
132
|
+
USAGE
|
|
133
|
+
$ vidgen help [COMMAND...] [-n]
|
|
134
|
+
|
|
135
|
+
ARGUMENTS
|
|
136
|
+
[COMMAND...] Command to show help for.
|
|
137
|
+
|
|
138
|
+
FLAGS
|
|
139
|
+
-n, --nested-commands Include all nested commands in the output.
|
|
140
|
+
|
|
141
|
+
DESCRIPTION
|
|
142
|
+
Display help for vidgen.
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.37/src/commands/help.ts)_
|
|
146
|
+
|
|
147
|
+
## `vidgen index chunk`
|
|
148
|
+
|
|
149
|
+
Slice a video into fixed-duration chunks and extract keyframes for downstream analysis.
|
|
150
|
+
|
|
151
|
+
```
|
|
152
|
+
USAGE
|
|
153
|
+
$ vidgen index chunk -o <value> -u <value> [-d <value>]
|
|
154
|
+
|
|
155
|
+
FLAGS
|
|
156
|
+
-d, --duration=<value> [default: 5] Duration in seconds for each chunk
|
|
157
|
+
-o, --output=<value> (required) Output directory for chunk files and keyframes
|
|
158
|
+
-u, --url=<value> (required) URL or local path to the video file
|
|
159
|
+
|
|
160
|
+
DESCRIPTION
|
|
161
|
+
Slice a video into fixed-duration chunks and extract keyframes for downstream analysis.
|
|
162
|
+
|
|
163
|
+
EXAMPLES
|
|
164
|
+
$ vidgen index chunk --url ./video.mp4 --duration 5 --output ./chunks
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
_See code: [src/commands/index/chunk.ts](https://github.com/xo-o/vidgen/blob/v0.0.1/src/commands/index/chunk.ts)_
|
|
168
|
+
|
|
169
|
+
## `vidgen index describe`
|
|
170
|
+
|
|
171
|
+
Use a Vision AI model to generate a text description of an image or video keyframe.
|
|
172
|
+
|
|
173
|
+
```
|
|
174
|
+
USAGE
|
|
175
|
+
$ vidgen index describe -i <value> -o <value> [-m <value>]
|
|
176
|
+
|
|
177
|
+
FLAGS
|
|
178
|
+
-i, --image=<value> (required) Path or URL to the image/keyframe to describe
|
|
179
|
+
-m, --model=<value> [default: gemini-flash] Vision model to use for description
|
|
180
|
+
-o, --output=<value> (required) Path to write the description JSON output
|
|
181
|
+
|
|
182
|
+
DESCRIPTION
|
|
183
|
+
Use a Vision AI model to generate a text description of an image or video keyframe.
|
|
184
|
+
|
|
185
|
+
EXAMPLES
|
|
186
|
+
$ vidgen index describe --image ./chunks/frame_001.jpg --output ./descriptions/frame_001.json
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
_See code: [src/commands/index/describe.ts](https://github.com/xo-o/vidgen/blob/v0.0.1/src/commands/index/describe.ts)_
|
|
190
|
+
|
|
191
|
+
## `vidgen index embed`
|
|
192
|
+
|
|
193
|
+
Convert a text description into a vector embedding for semantic search.
|
|
194
|
+
|
|
195
|
+
```
|
|
196
|
+
USAGE
|
|
197
|
+
$ vidgen index embed -o <value> -t <value> [-m <value>]
|
|
198
|
+
|
|
199
|
+
FLAGS
|
|
200
|
+
-m, --model=<value> [default: text-embedding-3-small] Embedding model to use
|
|
201
|
+
-o, --output=<value> (required) Path to write the embedding JSON output
|
|
202
|
+
-t, --text=<value> (required) The text description to embed
|
|
203
|
+
|
|
204
|
+
DESCRIPTION
|
|
205
|
+
Convert a text description into a vector embedding for semantic search.
|
|
206
|
+
|
|
207
|
+
EXAMPLES
|
|
208
|
+
$ vidgen index embed --text "A bitcoin coin spinning on a blue background" --output ./embeddings/frame_001.json
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
_See code: [src/commands/index/embed.ts](https://github.com/xo-o/vidgen/blob/v0.0.1/src/commands/index/embed.ts)_
|
|
212
|
+
|
|
213
|
+
## `vidgen index save`
|
|
214
|
+
|
|
215
|
+
Save a video chunk's metadata (timecodes, description, embedding) to the RAG database.
|
|
216
|
+
|
|
217
|
+
```
|
|
218
|
+
USAGE
|
|
219
|
+
$ vidgen index save -d <value> -m <value>
|
|
220
|
+
|
|
221
|
+
FLAGS
|
|
222
|
+
-d, --db=<value> (required) Database connection string
|
|
223
|
+
-m, --metadata=<value> (required) Path to the metadata JSON file containing chunk info, description, and embedding
|
|
224
|
+
|
|
225
|
+
DESCRIPTION
|
|
226
|
+
Save a video chunk's metadata (timecodes, description, embedding) to the RAG database.
|
|
227
|
+
|
|
228
|
+
EXAMPLES
|
|
229
|
+
$ vidgen index save --metadata ./chunk_001_meta.json --db postgresql://user:pass@localhost/db
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
_See code: [src/commands/index/save.ts](https://github.com/xo-o/vidgen/blob/v0.0.1/src/commands/index/save.ts)_
|
|
233
|
+
|
|
234
|
+
## `vidgen plugins`
|
|
235
|
+
|
|
236
|
+
List installed plugins.
|
|
237
|
+
|
|
238
|
+
```
|
|
239
|
+
USAGE
|
|
240
|
+
$ vidgen plugins [--json] [--core]
|
|
241
|
+
|
|
242
|
+
FLAGS
|
|
243
|
+
--core Show core plugins.
|
|
244
|
+
|
|
245
|
+
GLOBAL FLAGS
|
|
246
|
+
--json Format output as json.
|
|
247
|
+
|
|
248
|
+
DESCRIPTION
|
|
249
|
+
List installed plugins.
|
|
250
|
+
|
|
251
|
+
EXAMPLES
|
|
252
|
+
$ vidgen plugins
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.58/src/commands/plugins/index.ts)_
|
|
256
|
+
|
|
257
|
+
## `vidgen plugins add PLUGIN`
|
|
258
|
+
|
|
259
|
+
Installs a plugin into vidgen.
|
|
260
|
+
|
|
261
|
+
```
|
|
262
|
+
USAGE
|
|
263
|
+
$ vidgen plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
|
|
264
|
+
|
|
265
|
+
ARGUMENTS
|
|
266
|
+
PLUGIN... Plugin to install.
|
|
267
|
+
|
|
268
|
+
FLAGS
|
|
269
|
+
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
|
|
270
|
+
-h, --help Show CLI help.
|
|
271
|
+
-s, --silent Silences npm output.
|
|
272
|
+
-v, --verbose Show verbose npm output.
|
|
273
|
+
|
|
274
|
+
GLOBAL FLAGS
|
|
275
|
+
--json Format output as json.
|
|
276
|
+
|
|
277
|
+
DESCRIPTION
|
|
278
|
+
Installs a plugin into vidgen.
|
|
279
|
+
|
|
280
|
+
Uses npm to install plugins.
|
|
281
|
+
|
|
282
|
+
Installation of a user-installed plugin will override a core plugin.
|
|
283
|
+
|
|
284
|
+
Use the VIDGEN_NPM_LOG_LEVEL environment variable to set the npm loglevel.
|
|
285
|
+
Use the VIDGEN_NPM_REGISTRY environment variable to set the npm registry.
|
|
286
|
+
|
|
287
|
+
ALIASES
|
|
288
|
+
$ vidgen plugins add
|
|
289
|
+
|
|
290
|
+
EXAMPLES
|
|
291
|
+
Install a plugin from npm registry.
|
|
292
|
+
|
|
293
|
+
$ vidgen plugins add myplugin
|
|
294
|
+
|
|
295
|
+
Install a plugin from a github url.
|
|
296
|
+
|
|
297
|
+
$ vidgen plugins add https://github.com/someuser/someplugin
|
|
298
|
+
|
|
299
|
+
Install a plugin from a github slug.
|
|
300
|
+
|
|
301
|
+
$ vidgen plugins add someuser/someplugin
|
|
302
|
+
```
|
|
303
|
+
|
|
304
|
+
## `vidgen plugins:inspect PLUGIN...`
|
|
305
|
+
|
|
306
|
+
Displays installation properties of a plugin.
|
|
307
|
+
|
|
308
|
+
```
|
|
309
|
+
USAGE
|
|
310
|
+
$ vidgen plugins inspect PLUGIN...
|
|
311
|
+
|
|
312
|
+
ARGUMENTS
|
|
313
|
+
PLUGIN... [default: .] Plugin to inspect.
|
|
314
|
+
|
|
315
|
+
FLAGS
|
|
316
|
+
-h, --help Show CLI help.
|
|
317
|
+
-v, --verbose
|
|
318
|
+
|
|
319
|
+
GLOBAL FLAGS
|
|
320
|
+
--json Format output as json.
|
|
321
|
+
|
|
322
|
+
DESCRIPTION
|
|
323
|
+
Displays installation properties of a plugin.
|
|
324
|
+
|
|
325
|
+
EXAMPLES
|
|
326
|
+
$ vidgen plugins inspect myplugin
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.58/src/commands/plugins/inspect.ts)_
|
|
330
|
+
|
|
331
|
+
## `vidgen plugins install PLUGIN`
|
|
332
|
+
|
|
333
|
+
Installs a plugin into vidgen.
|
|
334
|
+
|
|
335
|
+
```
|
|
336
|
+
USAGE
|
|
337
|
+
$ vidgen plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
|
|
338
|
+
|
|
339
|
+
ARGUMENTS
|
|
340
|
+
PLUGIN... Plugin to install.
|
|
341
|
+
|
|
342
|
+
FLAGS
|
|
343
|
+
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
|
|
344
|
+
-h, --help Show CLI help.
|
|
345
|
+
-s, --silent Silences npm output.
|
|
346
|
+
-v, --verbose Show verbose npm output.
|
|
347
|
+
|
|
348
|
+
GLOBAL FLAGS
|
|
349
|
+
--json Format output as json.
|
|
350
|
+
|
|
351
|
+
DESCRIPTION
|
|
352
|
+
Installs a plugin into vidgen.
|
|
353
|
+
|
|
354
|
+
Uses npm to install plugins.
|
|
355
|
+
|
|
356
|
+
Installation of a user-installed plugin will override a core plugin.
|
|
357
|
+
|
|
358
|
+
Use the VIDGEN_NPM_LOG_LEVEL environment variable to set the npm loglevel.
|
|
359
|
+
Use the VIDGEN_NPM_REGISTRY environment variable to set the npm registry.
|
|
360
|
+
|
|
361
|
+
ALIASES
|
|
362
|
+
$ vidgen plugins add
|
|
363
|
+
|
|
364
|
+
EXAMPLES
|
|
365
|
+
Install a plugin from npm registry.
|
|
366
|
+
|
|
367
|
+
$ vidgen plugins install myplugin
|
|
368
|
+
|
|
369
|
+
Install a plugin from a github url.
|
|
370
|
+
|
|
371
|
+
$ vidgen plugins install https://github.com/someuser/someplugin
|
|
372
|
+
|
|
373
|
+
Install a plugin from a github slug.
|
|
374
|
+
|
|
375
|
+
$ vidgen plugins install someuser/someplugin
|
|
376
|
+
```
|
|
377
|
+
|
|
378
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.58/src/commands/plugins/install.ts)_
|
|
379
|
+
|
|
380
|
+
## `vidgen plugins link PATH`
|
|
381
|
+
|
|
382
|
+
Links a plugin into the CLI for development.
|
|
383
|
+
|
|
384
|
+
```
|
|
385
|
+
USAGE
|
|
386
|
+
$ vidgen plugins link PATH [-h] [--install] [-v]
|
|
387
|
+
|
|
388
|
+
ARGUMENTS
|
|
389
|
+
PATH [default: .] path to plugin
|
|
390
|
+
|
|
391
|
+
FLAGS
|
|
392
|
+
-h, --help Show CLI help.
|
|
393
|
+
-v, --verbose
|
|
394
|
+
--[no-]install Install dependencies after linking the plugin.
|
|
395
|
+
|
|
396
|
+
DESCRIPTION
|
|
397
|
+
Links a plugin into the CLI for development.
|
|
398
|
+
|
|
399
|
+
Installation of a linked plugin will override a user-installed or core plugin.
|
|
400
|
+
|
|
401
|
+
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
|
|
402
|
+
command will override the user-installed or core plugin implementation. This is useful for development work.
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
EXAMPLES
|
|
406
|
+
$ vidgen plugins link myplugin
|
|
407
|
+
```
|
|
408
|
+
|
|
409
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.58/src/commands/plugins/link.ts)_
|
|
410
|
+
|
|
411
|
+
## `vidgen plugins remove [PLUGIN]`
|
|
412
|
+
|
|
413
|
+
Removes a plugin from the CLI.
|
|
414
|
+
|
|
415
|
+
```
|
|
416
|
+
USAGE
|
|
417
|
+
$ vidgen plugins remove [PLUGIN...] [-h] [-v]
|
|
418
|
+
|
|
419
|
+
ARGUMENTS
|
|
420
|
+
[PLUGIN...] plugin to uninstall
|
|
421
|
+
|
|
422
|
+
FLAGS
|
|
423
|
+
-h, --help Show CLI help.
|
|
424
|
+
-v, --verbose
|
|
425
|
+
|
|
426
|
+
DESCRIPTION
|
|
427
|
+
Removes a plugin from the CLI.
|
|
428
|
+
|
|
429
|
+
ALIASES
|
|
430
|
+
$ vidgen plugins unlink
|
|
431
|
+
$ vidgen plugins remove
|
|
432
|
+
|
|
433
|
+
EXAMPLES
|
|
434
|
+
$ vidgen plugins remove myplugin
|
|
435
|
+
```
|
|
436
|
+
|
|
437
|
+
## `vidgen plugins reset`
|
|
438
|
+
|
|
439
|
+
Remove all user-installed and linked plugins.
|
|
440
|
+
|
|
441
|
+
```
|
|
442
|
+
USAGE
|
|
443
|
+
$ vidgen plugins reset [--hard] [--reinstall]
|
|
444
|
+
|
|
445
|
+
FLAGS
|
|
446
|
+
--hard Delete node_modules and package manager related files in addition to uninstalling plugins.
|
|
447
|
+
--reinstall Reinstall all plugins after uninstalling.
|
|
448
|
+
```
|
|
449
|
+
|
|
450
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.58/src/commands/plugins/reset.ts)_
|
|
451
|
+
|
|
452
|
+
## `vidgen plugins uninstall [PLUGIN]`
|
|
453
|
+
|
|
454
|
+
Removes a plugin from the CLI.
|
|
455
|
+
|
|
456
|
+
```
|
|
457
|
+
USAGE
|
|
458
|
+
$ vidgen plugins uninstall [PLUGIN...] [-h] [-v]
|
|
459
|
+
|
|
460
|
+
ARGUMENTS
|
|
461
|
+
[PLUGIN...] plugin to uninstall
|
|
462
|
+
|
|
463
|
+
FLAGS
|
|
464
|
+
-h, --help Show CLI help.
|
|
465
|
+
-v, --verbose
|
|
466
|
+
|
|
467
|
+
DESCRIPTION
|
|
468
|
+
Removes a plugin from the CLI.
|
|
469
|
+
|
|
470
|
+
ALIASES
|
|
471
|
+
$ vidgen plugins unlink
|
|
472
|
+
$ vidgen plugins remove
|
|
473
|
+
|
|
474
|
+
EXAMPLES
|
|
475
|
+
$ vidgen plugins uninstall myplugin
|
|
476
|
+
```
|
|
477
|
+
|
|
478
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.58/src/commands/plugins/uninstall.ts)_
|
|
479
|
+
|
|
480
|
+
## `vidgen plugins unlink [PLUGIN]`
|
|
481
|
+
|
|
482
|
+
Removes a plugin from the CLI.
|
|
483
|
+
|
|
484
|
+
```
|
|
485
|
+
USAGE
|
|
486
|
+
$ vidgen plugins unlink [PLUGIN...] [-h] [-v]
|
|
487
|
+
|
|
488
|
+
ARGUMENTS
|
|
489
|
+
[PLUGIN...] plugin to uninstall
|
|
490
|
+
|
|
491
|
+
FLAGS
|
|
492
|
+
-h, --help Show CLI help.
|
|
493
|
+
-v, --verbose
|
|
494
|
+
|
|
495
|
+
DESCRIPTION
|
|
496
|
+
Removes a plugin from the CLI.
|
|
497
|
+
|
|
498
|
+
ALIASES
|
|
499
|
+
$ vidgen plugins unlink
|
|
500
|
+
$ vidgen plugins remove
|
|
501
|
+
|
|
502
|
+
EXAMPLES
|
|
503
|
+
$ vidgen plugins unlink myplugin
|
|
504
|
+
```
|
|
505
|
+
|
|
506
|
+
## `vidgen plugins update`
|
|
507
|
+
|
|
508
|
+
Update installed plugins.
|
|
509
|
+
|
|
510
|
+
```
|
|
511
|
+
USAGE
|
|
512
|
+
$ vidgen plugins update [-h] [-v]
|
|
513
|
+
|
|
514
|
+
FLAGS
|
|
515
|
+
-h, --help Show CLI help.
|
|
516
|
+
-v, --verbose
|
|
517
|
+
|
|
518
|
+
DESCRIPTION
|
|
519
|
+
Update installed plugins.
|
|
520
|
+
```
|
|
521
|
+
|
|
522
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.58/src/commands/plugins/update.ts)_
|
|
523
|
+
|
|
524
|
+
## `vidgen project create`
|
|
525
|
+
|
|
526
|
+
Create a new video project in the Turso database.
|
|
527
|
+
|
|
528
|
+
```
|
|
529
|
+
USAGE
|
|
530
|
+
$ vidgen project create -a 1:1|16:9|9:16|11 -t <value> [-d <value>]
|
|
531
|
+
|
|
532
|
+
FLAGS
|
|
533
|
+
-a, --aspectRatio=<option> (required) [default: 9:16] Project aspect ratio
|
|
534
|
+
<options: 1:1|16:9|9:16|11>
|
|
535
|
+
-d, --description=<value> Optional project description
|
|
536
|
+
-t, --title=<value> (required) Project title
|
|
537
|
+
|
|
538
|
+
DESCRIPTION
|
|
539
|
+
Create a new video project in the Turso database.
|
|
540
|
+
|
|
541
|
+
EXAMPLES
|
|
542
|
+
$ vidgen project create --title "Crypto Explainers" --aspectRatio 9:16
|
|
543
|
+
```
|
|
544
|
+
|
|
545
|
+
_See code: [src/commands/project/create.ts](https://github.com/xo-o/vidgen/blob/v0.0.1/src/commands/project/create.ts)_
|
|
546
|
+
|
|
547
|
+
## `vidgen project delete ID`
|
|
548
|
+
|
|
549
|
+
Delete a project and all its associated segments from the Turso database.
|
|
550
|
+
|
|
551
|
+
```
|
|
552
|
+
USAGE
|
|
553
|
+
$ vidgen project delete ID
|
|
554
|
+
|
|
555
|
+
ARGUMENTS
|
|
556
|
+
ID Project ID to delete
|
|
557
|
+
|
|
558
|
+
DESCRIPTION
|
|
559
|
+
Delete a project and all its associated segments from the Turso database.
|
|
560
|
+
|
|
561
|
+
EXAMPLES
|
|
562
|
+
$ vidgen project delete <project-id>
|
|
563
|
+
```
|
|
564
|
+
|
|
565
|
+
_See code: [src/commands/project/delete.ts](https://github.com/xo-o/vidgen/blob/v0.0.1/src/commands/project/delete.ts)_
|
|
566
|
+
|
|
567
|
+
## `vidgen project get ID`
|
|
568
|
+
|
|
569
|
+
Retrieve a full project schema including its segments from the Turso database.
|
|
570
|
+
|
|
571
|
+
```
|
|
572
|
+
USAGE
|
|
573
|
+
$ vidgen project get ID
|
|
574
|
+
|
|
575
|
+
ARGUMENTS
|
|
576
|
+
ID Project ID to retrieve
|
|
577
|
+
|
|
578
|
+
DESCRIPTION
|
|
579
|
+
Retrieve a full project schema including its segments from the Turso database.
|
|
580
|
+
|
|
581
|
+
EXAMPLES
|
|
582
|
+
$ vidgen project get <project-id>
|
|
583
|
+
```
|
|
584
|
+
|
|
585
|
+
_See code: [src/commands/project/get.ts](https://github.com/xo-o/vidgen/blob/v0.0.1/src/commands/project/get.ts)_
|
|
586
|
+
|
|
587
|
+
## `vidgen project list`
|
|
588
|
+
|
|
589
|
+
List all video projects stored in the Turso database.
|
|
590
|
+
|
|
591
|
+
```
|
|
592
|
+
USAGE
|
|
593
|
+
$ vidgen project list
|
|
594
|
+
|
|
595
|
+
DESCRIPTION
|
|
596
|
+
List all video projects stored in the Turso database.
|
|
597
|
+
|
|
598
|
+
EXAMPLES
|
|
599
|
+
$ vidgen project list
|
|
600
|
+
```
|
|
601
|
+
|
|
602
|
+
_See code: [src/commands/project/list.ts](https://github.com/xo-o/vidgen/blob/v0.0.1/src/commands/project/list.ts)_
|
|
603
|
+
|
|
604
|
+
## `vidgen project validate`
|
|
605
|
+
|
|
606
|
+
Validate a Schema JSON file against the TypeScript Schema interface structure before saving to a database.
|
|
607
|
+
|
|
608
|
+
```
|
|
609
|
+
USAGE
|
|
610
|
+
$ vidgen project validate -s <value> [--strict]
|
|
611
|
+
|
|
612
|
+
FLAGS
|
|
613
|
+
-s, --schema=<value> (required) Path to the Schema JSON file to validate
|
|
614
|
+
--strict Fail on missing optional fields in addition to required field validation
|
|
615
|
+
|
|
616
|
+
DESCRIPTION
|
|
617
|
+
Validate a Schema JSON file against the TypeScript Schema interface structure before saving to a database.
|
|
618
|
+
|
|
619
|
+
EXAMPLES
|
|
620
|
+
$ vidgen project validate --schema ./schema.json
|
|
621
|
+
|
|
622
|
+
$ vidgen project validate --schema ./schema.json --strict
|
|
623
|
+
```
|
|
624
|
+
|
|
625
|
+
_See code: [src/commands/project/validate.ts](https://github.com/xo-o/vidgen/blob/v0.0.1/src/commands/project/validate.ts)_
|
|
626
|
+
|
|
627
|
+
## `vidgen search asset`
|
|
628
|
+
|
|
629
|
+
Semantically search the video RAG database for the best matching clip for a given query. Returns matching VisualBroll / Clip metadata.
|
|
630
|
+
|
|
631
|
+
```
|
|
632
|
+
USAGE
|
|
633
|
+
$ vidgen search asset -d <value> -q <value> [-l <value>] [-t video|image]
|
|
634
|
+
|
|
635
|
+
FLAGS
|
|
636
|
+
-d, --db=<value> (required) Database connection string
|
|
637
|
+
-l, --limit=<value> [default: 1] Maximum number of results to return
|
|
638
|
+
-q, --query=<value> (required) The natural language search query (e.g. comes from a Segment's searchQuery field)
|
|
639
|
+
-t, --type=<option> Filter results by asset type
|
|
640
|
+
<options: video|image>
|
|
641
|
+
|
|
642
|
+
DESCRIPTION
|
|
643
|
+
Semantically search the video RAG database for the best matching clip for a given query. Returns matching VisualBroll
|
|
644
|
+
/ Clip metadata.
|
|
645
|
+
|
|
646
|
+
EXAMPLES
|
|
647
|
+
$ vidgen search asset --query "bitcoin coin spinning on blue background" --db postgresql://user:pass@localhost/db --limit 3
|
|
648
|
+
```
|
|
649
|
+
|
|
650
|
+
_See code: [src/commands/search/asset.ts](https://github.com/xo-o/vidgen/blob/v0.0.1/src/commands/search/asset.ts)_
|
|
651
|
+
|
|
652
|
+
## `vidgen segment add`
|
|
653
|
+
|
|
654
|
+
Add a new segment to a project. Data should be a JSON string matching the Segment interface.
|
|
655
|
+
|
|
656
|
+
```
|
|
657
|
+
USAGE
|
|
658
|
+
$ vidgen segment add -d <value> -p <value> [-n <value>]
|
|
659
|
+
|
|
660
|
+
FLAGS
|
|
661
|
+
-d, --data=<value> (required) JSON string of the segment data
|
|
662
|
+
-n, --order=<value> Order index for the segment
|
|
663
|
+
-p, --projectId=<value> (required) Project ID to attach the segment to
|
|
664
|
+
|
|
665
|
+
DESCRIPTION
|
|
666
|
+
Add a new segment to a project. Data should be a JSON string matching the Segment interface.
|
|
667
|
+
|
|
668
|
+
EXAMPLES
|
|
669
|
+
$ vidgen segment add --projectId <project-id> --data '{"title":"Scene 1","text":"Hello"}' --order 0
|
|
670
|
+
```
|
|
671
|
+
|
|
672
|
+
_See code: [src/commands/segment/add.ts](https://github.com/xo-o/vidgen/blob/v0.0.1/src/commands/segment/add.ts)_
|
|
673
|
+
|
|
674
|
+
## `vidgen segment delete ID`
|
|
675
|
+
|
|
676
|
+
Delete a specific segment from the Turso database.
|
|
677
|
+
|
|
678
|
+
```
|
|
679
|
+
USAGE
|
|
680
|
+
$ vidgen segment delete ID
|
|
681
|
+
|
|
682
|
+
ARGUMENTS
|
|
683
|
+
ID Segment ID to delete
|
|
684
|
+
|
|
685
|
+
DESCRIPTION
|
|
686
|
+
Delete a specific segment from the Turso database.
|
|
687
|
+
|
|
688
|
+
EXAMPLES
|
|
689
|
+
$ vidgen segment delete <segment-id>
|
|
690
|
+
```
|
|
691
|
+
|
|
692
|
+
_See code: [src/commands/segment/delete.ts](https://github.com/xo-o/vidgen/blob/v0.0.1/src/commands/segment/delete.ts)_
|
|
693
|
+
|
|
694
|
+
## `vidgen segment list PROJECTID`
|
|
695
|
+
|
|
696
|
+
List all segments associated with a specific project.
|
|
697
|
+
|
|
698
|
+
```
|
|
699
|
+
USAGE
|
|
700
|
+
$ vidgen segment list PROJECTID
|
|
701
|
+
|
|
702
|
+
ARGUMENTS
|
|
703
|
+
PROJECTID Project ID to list segments for
|
|
704
|
+
|
|
705
|
+
DESCRIPTION
|
|
706
|
+
List all segments associated with a specific project.
|
|
707
|
+
|
|
708
|
+
EXAMPLES
|
|
709
|
+
$ vidgen segment list <project-id>
|
|
710
|
+
```
|
|
711
|
+
|
|
712
|
+
_See code: [src/commands/segment/list.ts](https://github.com/xo-o/vidgen/blob/v0.0.1/src/commands/segment/list.ts)_
|
|
713
|
+
|
|
714
|
+
## `vidgen segment update ID`
|
|
715
|
+
|
|
716
|
+
Update an existing segment's data.
|
|
717
|
+
|
|
718
|
+
```
|
|
719
|
+
USAGE
|
|
720
|
+
$ vidgen segment update ID -d <value> [-n <value>]
|
|
721
|
+
|
|
722
|
+
ARGUMENTS
|
|
723
|
+
ID Segment ID to update
|
|
724
|
+
|
|
725
|
+
FLAGS
|
|
726
|
+
-d, --data=<value> (required) JSON string of the segment data to merge/update
|
|
727
|
+
-n, --order=<value> New order index for the segment
|
|
728
|
+
|
|
729
|
+
DESCRIPTION
|
|
730
|
+
Update an existing segment's data.
|
|
731
|
+
|
|
732
|
+
EXAMPLES
|
|
733
|
+
$ vidgen segment update <segment-id> --data '{"title":"New Title"}'
|
|
734
|
+
```
|
|
735
|
+
|
|
736
|
+
_See code: [src/commands/segment/update.ts](https://github.com/xo-o/vidgen/blob/v0.0.1/src/commands/segment/update.ts)_
|
|
737
|
+
|
|
738
|
+
## `vidgen video caption`
|
|
739
|
+
|
|
740
|
+
Generate SRT captions from a JSON transcript and optionally embed them into a video.
|
|
741
|
+
|
|
742
|
+
```
|
|
743
|
+
USAGE
|
|
744
|
+
$ vidgen video caption -o <value> -t <value> [-b] [-v <value>]
|
|
745
|
+
|
|
746
|
+
FLAGS
|
|
747
|
+
-b, --burnIn
|
|
748
|
+
-o, --output=<value> (required)
|
|
749
|
+
-t, --transcript=<value> (required)
|
|
750
|
+
-v, --video=<value>
|
|
751
|
+
|
|
752
|
+
DESCRIPTION
|
|
753
|
+
Generate SRT captions from a JSON transcript and optionally embed them into a video.
|
|
754
|
+
```
|
|
755
|
+
|
|
756
|
+
_See code: [src/commands/video/caption.ts](https://github.com/xo-o/vidgen/blob/v0.0.1/src/commands/video/caption.ts)_
|
|
757
|
+
|
|
758
|
+
## `vidgen video trim`
|
|
759
|
+
|
|
760
|
+
Precisely trim a video file using start and end timestamps.
|
|
761
|
+
|
|
762
|
+
```
|
|
763
|
+
USAGE
|
|
764
|
+
$ vidgen video trim -i <value> -o <value> -s <value> [-d <value>] [-e <value>]
|
|
765
|
+
|
|
766
|
+
FLAGS
|
|
767
|
+
-d, --duration=<value> Duration to trim
|
|
768
|
+
-e, --end=<value> End timestamp
|
|
769
|
+
-i, --input=<value> (required) Input video file path
|
|
770
|
+
-o, --output=<value> (required) Output video file path
|
|
771
|
+
-s, --start=<value> (required) Start timestamp
|
|
772
|
+
|
|
773
|
+
DESCRIPTION
|
|
774
|
+
Precisely trim a video file using start and end timestamps.
|
|
775
|
+
|
|
776
|
+
EXAMPLES
|
|
777
|
+
$ vidgen video trim --input input.mp4 --start 00:00:10 --end 00:00:20 --output trimmed.mp4
|
|
778
|
+
```
|
|
779
|
+
|
|
780
|
+
_See code: [src/commands/video/trim.ts](https://github.com/xo-o/vidgen/blob/v0.0.1/src/commands/video/trim.ts)_
|
|
781
|
+
<!-- commandsstop -->
|