https://github.com/ajcwebdev/autoshow
End-to-end scripting workflow to automatically generate show notes from audio/video transcripts with Whisper.cpp, Llama.cpp, yt-dlp, and Commander.js
https://github.com/ajcwebdev/autoshow
chatgpt claude cohere llama-cpp mistral ollama whisper-cpp yt-dlp
Last synced: 6 months ago
JSON representation
End-to-end scripting workflow to automatically generate show notes from audio/video transcripts with Whisper.cpp, Llama.cpp, yt-dlp, and Commander.js
- Host: GitHub
- URL: https://github.com/ajcwebdev/autoshow
- Owner: ajcwebdev
- License: mit
- Created: 2024-04-17T03:46:50.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-23T20:38:08.000Z (9 months ago)
- Last Synced: 2024-10-24T08:25:42.210Z (9 months ago)
- Topics: chatgpt, claude, cohere, llama-cpp, mistral, ollama, whisper-cpp, yt-dlp
- Language: TypeScript
- Homepage:
- Size: 1.47 MB
- Stars: 29
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Roadmap: docs/roadmap.md
Awesome Lists containing this project
README
Autoshow
## Outline
- [Project Overview](#project-overview)
- [Key Features](#key-features)
- [Setup](#setup)
- [Run Autoshow Node Scripts](#run-autoshow-node-scripts)
- [Project Structure](#project-structure)
- [Contributors](#contributors)
## Project Overview
Autoshow automates the processing of audio and video content from various sources, including YouTube videos, playlists, podcast RSS feeds, and local media files. It performs transcription, summarization, and chapter generation using different language models (LLMs) and transcription services.
The Autoshow workflow includes the following steps:
1. The user provides input (video URL, playlist, RSS feed, or local file).
2. The system downloads the audio (if necessary).
3. Transcription is performed using the selected service.
4. A customizable prompt is inserted containing instructions for the contents of the show notes.
5. The transcript is processed by the chosen LLM to generate show notes based on the selected prompts.
6. Results are saved in markdown format with front matter.
### Key Features
- Support for multiple input types (YouTube links, RSS feeds, local video and audio files)
- Integration with various:
- LLMs (ChatGPT, Claude, Gemini, Cohere, Mistral, Fireworks, Together, Groq)
- Transcription services (Whisper.cpp, Deepgram, Assembly)
- Local LLM support with Ollama
- Customizable prompts for generating titles, summaries, chapter titles/descriptions, key takeaways, and questions to test comprehension
- Markdown output with metadata and formatted content
- Command-line interface for easy usage
- *WIP: Node.js server and React frontend*
## Setup
`scripts/setup.sh` checks to ensure a `.env` file exists, Node dependencies are installed, and the `whisper.cpp` repository is cloned and built. Run the script with the `setup` script in `package.json`.
```bash
npm run setup
```
## Run Autoshow Node Scripts
Run on a single YouTube video.
```bash
npm run as -- --video "https://www.youtube.com/watch?v=MORMZXEaONk"
```
Run on a YouTube playlist.
```bash
npm run as -- --playlist "https://www.youtube.com/playlist?list=PLCVnrVv4KhXPz0SoAVu8Rc1emAdGPbSbr"
```
Run on a list of arbitrary URLs.
```bash
npm run as -- --urls "content/example-urls.md"
```
Run on a local audio or video file.
```bash
npm run as -- --file "content/audio.mp3"
```
Run on a podcast RSS feed.
```bash
npm run as -- --rss "https://ajcwebdev.substack.com/feed"
```
Use local LLM.
```bash
npm run as -- --video "https://www.youtube.com/watch?v=MORMZXEaONk" --ollama
```
Use 3rd party LLM providers.
```bash
npm run as -- --video "https://www.youtube.com/watch?v=MORMZXEaONk" --chatgpt GPT_4o_MINI
npm run as -- --video "https://www.youtube.com/watch?v=MORMZXEaONk" --claude CLAUDE_3_5_SONNET
npm run as -- --video "https://www.youtube.com/watch?v=MORMZXEaONk" --gemini GEMINI_1_5_PRO
npm run as -- --video "https://www.youtube.com/watch?v=MORMZXEaONk" --cohere COMMAND_R_PLUS
npm run as -- --video "https://www.youtube.com/watch?v=MORMZXEaONk" --mistral MISTRAL_LARGE
npm run as -- --video "https://www.youtube.com/watch?v=MORMZXEaONk" --fireworks
npm run as -- --video "https://www.youtube.com/watch?v=MORMZXEaONk" --together
npm run as -- --video "https://www.youtube.com/watch?v=MORMZXEaONk" --groq
```
Example commands for all available CLI options can be found in [`docs/examples.md`](/docs/examples.md).
## Project Structure
- Main Entry Points (`src/cli`)
- `commander.ts`: Defines the command-line interface using Commander
- Process Commands (`src/process-commands`)
- `file.ts`: Handles local audio/video file processing
- `video.ts`: Handles single YouTube video processing
- `urls.ts`: Processes videos from a list of URLs in a file
- `playlist.ts`: Processes all videos in a YouTube playlist
- `channel.ts`: Processes all videos from a YouTube channel
- `rss.ts`: Processes podcast RSS feeds
- Process Steps (`src/process-steps`)
- Step 1 - `generate-markdown.ts` creates initial markdown file with metadata
- Step 2 - `download-audio.ts` downloads audio from YouTube videos
- Step 3 - `run-transcription.ts` manages the transcription process
- Step 4 - `select-prompt.ts` defines the prompt structure for summarization and chapter generation
- Step 5 - `run-llm.ts` handles LLM processing for selected prompts
- Transcription Services (`src/transcription`)
- `whisper.ts`: Uses Whisper.cpp for transcription
- `deepgram.ts`: Integrates Deepgram transcription service
- `assembly.ts`: Integrates AssemblyAI transcription service
- Language Models (`src/llms`)
- `ollama.ts`: Integrations Ollama's locally available models
- `chatgpt.ts`: Integrates OpenAI's GPT models
- `claude.ts`: Integrates Anthropic's Claude models
- `gemini.ts`: Integrates Google's Gemini models
- `cohere.ts`: Integrates Cohere's language models
- `mistral.ts`: Integrates Mistral AI's language models
- `fireworks.ts`: Integrates Fireworks's open source models
- `together.ts`: Integrates Together's open source models
- `groq.ts`: Integrates Groq's open source models
- Utility Files (`src/utils`)
- `logging.ts`: Reusable Chalk functions for logging colors
- `validate-option.ts`: Functions for validating CLI options and handling errors
- `format-transcript.ts`: Transcript formatting functions
- `globals.ts`: Globally defined variables and constants
- Types (`src/types`)
- `process.ts`: Types for `commander.ts` and files in `process-commands` directory
- `llms.ts`: Types for `run-llm.ts` process step and files in `llms` directory
- `transcription.ts`: Types for `run-transcription.ts` process step and files in `transcription` directory
- Server (`src/server`)
- `index.ts`: Initializes Fastify server with CORS support and defines API endpoints
- `db.ts`: Sets up SQLite database connection and schema for storing show notes
- API Routes (`src/server/routes`)
- `process.ts`: Handles different types of media processing requests (video, playlist, RSS, etc.)
- `show-note.ts`: Retrieves individual show notes from the database by ID
- `show-notes.ts`: Fetches all show notes from the database, ordered by date
- Server Utilities (`src/server/utils`)
- `req-to-opts.ts`: Maps API request data to processing options for LLM and transcription services
## Contributors
- ✨Hello beautiful human! ✨[Jenn Junod](https://jennjunod.dev/) host of [Teach Jenn Tech](https://teachjenntech.com/)