vidistill 0.1.0

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 (4) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +96 -0
  3. package/dist/index.js +3369 -0
  4. package/package.json +49 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Sitao Ma
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,96 @@
1
+ # vidistill
2
+
3
+ Video intelligence distiller — turn any video into structured notes, transcripts, and insights using Gemini.
4
+
5
+ Feed it a YouTube URL or local video file. It analyzes the content through multiple AI passes (scene analysis, transcript, visuals, code extraction, people, chat, implicit signals) and synthesizes everything into organized markdown output.
6
+
7
+ ## Install
8
+
9
+ ```
10
+ npm install -g vidistill
11
+ ```
12
+
13
+ Requires Node.js 22+ and [ffmpeg](https://ffmpeg.org/).
14
+
15
+ ## Usage
16
+
17
+ ```
18
+ vidistill [input] [options]
19
+ ```
20
+
21
+ **Arguments:**
22
+
23
+ - `input` — YouTube URL or local file path (prompted interactively if omitted)
24
+
25
+ **Options:**
26
+
27
+ - `-c, --context` — context about the video (e.g. "CS lecture", "product demo")
28
+ - `-o, --output` — output directory (default: `./vidistill-output/`)
29
+
30
+ **Examples:**
31
+
32
+ ```bash
33
+ # Interactive mode — prompts for everything
34
+ vidistill
35
+
36
+ # YouTube video
37
+ vidistill "https://youtube.com/watch?v=dQw4w9WgXcQ"
38
+
39
+ # Local file with context
40
+ vidistill ./lecture.mp4 --context "distributed systems lecture"
41
+
42
+ # Custom output directory
43
+ vidistill ./demo.mp4 -o ./notes/
44
+ ```
45
+
46
+ ## API Key
47
+
48
+ vidistill needs a Gemini API key. It checks these sources in order:
49
+
50
+ 1. `GEMINI_API_KEY` environment variable
51
+ 2. `~/.vidistill/config.json`
52
+ 3. Interactive prompt (with option to save for next time)
53
+
54
+ Get a key at [ai.google.dev](https://ai.google.dev/).
55
+
56
+ ## Output
57
+
58
+ vidistill creates a folder per video with structured files:
59
+
60
+ ```
61
+ vidistill-output/my-video/
62
+ ├── guide.md # overview and navigation
63
+ ├── transcript.md # full timestamped transcript
64
+ ├── combined.md # transcript + visual notes merged
65
+ ├── notes.md # meeting/lecture notes
66
+ ├── code.md # extracted code blocks and reconstructions
67
+ ├── people.md # speakers and participants
68
+ ├── chat.md # chat messages and links
69
+ ├── action-items.md # tasks and follow-ups
70
+ ├── insights.md # implicit signals and analysis
71
+ ├── links.md # all URLs mentioned
72
+ ├── metadata.json # processing metadata
73
+ └── raw/ # raw pass outputs
74
+ ```
75
+
76
+ Which files are generated depends on the video content — a coding tutorial gets `code.md`, a meeting gets `people.md` and `action-items.md`, etc.
77
+
78
+ ## How It Works
79
+
80
+ 1. **Input** — downloads YouTube video via yt-dlp or reads local file, compresses if over 2GB
81
+ 2. **Pass 0** — scene analysis to classify video type and determine processing strategy
82
+ 3. **Pass 1** — transcript extraction with speaker identification
83
+ 4. **Pass 2** — visual content extraction (screen states, diagrams, slides)
84
+ 5. **Pass 3** — specialist passes based on video type:
85
+ - 3a: code reconstruction (coding videos)
86
+ - 3b: people and social dynamics (meetings)
87
+ - 3c: chat and links (live streams)
88
+ - 3d: implicit signals (all types)
89
+ 6. **Synthesis** — cross-references all passes into unified analysis
90
+ 7. **Output** — generates structured markdown files
91
+
92
+ Long videos are segmented automatically. Passes that fail are skipped gracefully.
93
+
94
+ ## License
95
+
96
+ MIT