clipflow-ai 1.0.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.
package/README.md ADDED
@@ -0,0 +1,220 @@
1
+ <div align="center">
2
+
3
+ # **ClipFlow AI**
4
+
5
+ ### Your AI Content Pipeline
6
+
7
+ **14 agents. One idea. Ready-to-post content.**
8
+
9
+ [![Bun](https://img.shields.io/badge/runtime-Bun-f9f1e1?logo=bun&logoColor=000)](https://bun.sh)
10
+ [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
11
+ [![Platform](https://img.shields.io/badge/platform-macOS%20%7C%20Linux%20%7C%20Windows-lightgrey)]()
12
+ [![TypeScript](https://img.shields.io/badge/TypeScript-5.x-3178C6?logo=typescript&logoColor=white)]()
13
+ [![Claude](https://img.shields.io/badge/AI-Claude-d97706?logo=anthropic&logoColor=white)]()
14
+
15
+ Type one topic. 14 AI agents research, script, storyboard, design and package it into ready-to-post content for Instagram Reels, YouTube Shorts, TikTok and more.
16
+
17
+ [**Star this repo**](https://github.com/Mohit-Bagri/Clipflow) if you find it useful :star:
18
+
19
+ ---
20
+
21
+ [Overview](#-overview) · [Prerequisites](#-prerequisites) · [Installation](#-installation) · [Quick Start](#-quick-start) · [Pipeline](#-the-pipeline) · [Modes](#-modes) · [Keyboard](#-keyboard-shortcuts) · [Export](#-export--save) · [Structure](#-project-structure) · [License](#-license)
22
+
23
+ </div>
24
+
25
+ ---
26
+
27
+ ## ▸ Overview
28
+
29
+ ClipFlow AI is a terminal-based content pipeline that turns a single idea into production-ready short-form video content. Powered by Claude, it runs 14 specialized AI agents in sequence. Each one handles a different stage of the content creation process from research and scripting to art direction and cross-platform publishing.
30
+
31
+ No browser tabs. No copy-pasting between tools. Just type your topic and let the agents work.
32
+
33
+ ### Why ClipFlow?
34
+
35
+ | # | Feature | Description |
36
+ |---|---------|-------------|
37
+ | 1 | **Full Pipeline** | 14 purpose-built agents cover every step from brief to repurposing |
38
+ | 2 | **Live Web Research** | Built-in MCP search server pulls real-time data via DuckDuckGo. No API key needed |
39
+ | 3 | **Fact-Checking** | Dedicated agent verifies every claim before it reaches the script |
40
+ | 4 | **Two Modes** | Fast mode for speed and Detailed mode for depth. Switch with one keystroke |
41
+ | 5 | **Beautiful TUI** | OpenTUI-powered terminal interface with 60fps rendering, sidebar and markdown output |
42
+ | 6 | **Real-Time Streaming** | Watch each agent think and write in real time. No waiting for batch results |
43
+ | 7 | **One-Click Export** | Save the entire pipeline output as a structured markdown file with `Ctrl+S` |
44
+ | 8 | **Cross-Platform** | Runs on macOS, Linux and Windows wherever Bun runs |
45
+ | 9 | **Multi-Platform Output** | Generates content tailored for Instagram, TikTok, YouTube, Twitter/X and LinkedIn |
46
+ | 10 | **Zero Config** | Detects your Claude authentication automatically. OAuth or API key |
47
+
48
+ ---
49
+
50
+ ## ▸ Prerequisites
51
+
52
+ | Requirement | Purpose |
53
+ |-------------|---------|
54
+ | [Bun](https://bun.sh) | JavaScript/TypeScript runtime |
55
+ | [Claude CLI](https://docs.anthropic.com/en/docs/claude-code) | AI backbone. Must be installed and authenticated |
56
+
57
+ **Authentication** ClipFlow auto-detects your Claude credentials:
58
+ - **Claude OAuth** Log in with `claude auth login` and it just works
59
+ - **API Key** Set `ANTHROPIC_API_KEY` as an environment variable
60
+
61
+ ---
62
+
63
+ ## ▸ Installation
64
+
65
+ ### Install from source
66
+
67
+ ```bash
68
+ git clone https://github.com/Mohit-Bagri/Clipflow.git
69
+ cd Clipflow
70
+ bun install
71
+ bun run dev
72
+ ```
73
+
74
+ ### Coming soon: npm
75
+
76
+ ```bash
77
+ npm install -g clipflow-ai
78
+ clipflow
79
+ ```
80
+
81
+ ---
82
+
83
+ ## ▸ Quick Start
84
+
85
+ ```bash
86
+ # Launch the interactive TUI
87
+ bun run dev
88
+
89
+ # Or pass a topic directly
90
+ bun run dev "HDFC Bank chairman quit"
91
+ ```
92
+
93
+ 1. **Type your topic** anything from breaking news to niche explainers
94
+ 2. **Tab** to switch between Fast and Detailed mode
95
+ 3. **Enter** to launch the pipeline
96
+ 4. **Arrow keys** to browse agent outputs in real time
97
+ 5. **Ctrl+S** to save the full output as markdown
98
+
99
+ > **Try:** `RBI rate cut` · `Apple Vision Pro 2` · `Zomato vs Swiggy` · `AI replacing jobs`
100
+
101
+ ---
102
+
103
+ ## ▸ The Pipeline
104
+
105
+ ClipFlow runs 14 agents in sequence. Each agent receives the accumulated output of all previous agents, building context as the pipeline progresses.
106
+
107
+ | # | Agent | Role | What It Does |
108
+ |---|-------|------|-------------|
109
+ | 1 | **The Planner** | Creative Brief | Turns your raw idea into a structured brief with audience, tone and platform targets |
110
+ | 2 | **The Journalist** | Research | Searches the web for facts, data, expert opinions and surprising angles |
111
+ | 3 | **The Scout** | Trend Analysis | Identifies trending formats, hashtags, competitors and optimal posting times |
112
+ | 4 | **The Editor** | Fact-Check | Verifies every claim and statistic. Flags anything unconfirmed |
113
+ | 5 | **The Creative Director** | Concepts | Develops 3 distinct creative angles and recommends the strongest one |
114
+ | 6 | **The Attention Grabber** | Hooks | Writes 5 scroll-stopping hooks rated by stopping power |
115
+ | 7 | **The Scriptwriter** | Script | Writes a full 30-45s script with timestamps, voiceover and visual cues |
116
+ | 8 | **The Comedy Writer** | Humor | Injects meme references, humor beats and comedic timing into the script |
117
+ | 9 | **The Art Director** | Visual Style | Defines color palette, typography, lighting and transitions |
118
+ | 10 | **The Storyboarder** | Shot Plan | Maps every shot with camera angles, movement and on-screen text |
119
+ | 11 | **The Producer** | Image Prompts | Writes AI image generation prompts for Midjourney, DALL-E and Flux for each shot |
120
+ | 12 | **The Editor** | Assembly | Creates a second-by-second editing blueprint with audio mix and color grading |
121
+ | 13 | **The Social Manager** | Publishing | Writes platform-specific captions, hashtags and A/B test plans |
122
+ | 14 | **The Multiplier** | Repurpose | Adapts content for Twitter threads, LinkedIn, blog posts, carousels and newsletters |
123
+
124
+ ---
125
+
126
+ ## ▸ Modes
127
+
128
+ | | **Fast** | **Detailed** |
129
+ |---|----------|-------------|
130
+ | **How it works** | Multiple agents collaborate together | Agents research independently then collaborate |
131
+ | **Speed** | Around 3-4 minutes | Longer. Each agent takes its time |
132
+ | **Quality** | Great for quick iterations | Best quality, deepest research |
133
+ | **Best for** | Rapid ideation, testing topics | Final production-ready output |
134
+ | **Switch** | Press `Tab` on the input screen | Press `Tab` on the input screen |
135
+
136
+ ---
137
+
138
+ ## ▸ Keyboard Shortcuts
139
+
140
+ | Shortcut | Context | Action |
141
+ |----------|---------|--------|
142
+ | `Enter` | Input screen | Submit topic and start pipeline |
143
+ | `Tab` | Input screen | Toggle between Fast and Detailed mode |
144
+ | `Tab` | Pipeline screen | Toggle sidebar visibility |
145
+ | `↑` `↓` | Pipeline screen | Navigate between agents |
146
+ | `Ctrl+S` | Pipeline screen | Save full output as markdown file |
147
+ | `Ctrl+P` | Anywhere | Open command palette |
148
+ | `Ctrl+B` | Anywhere | Toggle sidebar |
149
+ | `Ctrl+C` | Anywhere | Quit |
150
+ | `q` | Pipeline screen | Quit |
151
+
152
+ ---
153
+
154
+ ## ▸ Export and Save
155
+
156
+ Press **`Ctrl+S`** during or after the pipeline to save all agent outputs as a single markdown file.
157
+
158
+ The exported file includes:
159
+ - Topic and timestamp
160
+ - Each completed agent's output under its own heading
161
+ - Clean markdown formatting ready for sharing or editing
162
+
163
+ Files are saved to your current working directory as:
164
+ ```
165
+ clipflow_{topic}_{date}.md
166
+ ```
167
+
168
+ ---
169
+
170
+ ## ▸ Tech Stack
171
+
172
+ | Layer | Technology |
173
+ |-------|-----------|
174
+ | **Runtime** | Bun |
175
+ | **TUI Framework** | OpenTUI with Solid.js |
176
+ | **AI** | Claude via CLI subprocess |
177
+ | **Web Search** | Custom MCP server using DuckDuckGo |
178
+ | **Language** | TypeScript |
179
+
180
+ ---
181
+
182
+ ## ▸ Project Structure
183
+
184
+ ```
185
+ src/
186
+ ├── index.tsx # Entry point
187
+ ├── tui/
188
+ │ ├── App.tsx # Main OpenTUI application
189
+ │ └── theme.ts # Colors, spinner, logo
190
+ ├── lib/
191
+ │ ├── agents.ts # 14 agent definitions
192
+ │ ├── pipeline.ts # Pipeline runner
193
+ │ ├── content-style.ts # Shared prompt context
194
+ │ └── types.ts # TypeScript types
195
+ ├── auth/
196
+ │ └── claude-credentials.ts # Cross-platform Claude auth
197
+ ├── mcp/
198
+ │ └── search-server.ts # Web search MCP server
199
+ └── providers/
200
+ ├── types.ts
201
+ ├── definitions.ts
202
+ ├── auth.ts # Cross-platform auth resolver
203
+ └── index.ts
204
+ ```
205
+
206
+ ---
207
+
208
+ ## ▸ License
209
+
210
+ [MIT](LICENSE). Use it, fork it, build on it.
211
+
212
+ ---
213
+
214
+ <div align="center">
215
+
216
+ Made with :heart: in India by **[Mohit Bagri](https://mohitbagri-portfolio.vercel.app)**
217
+
218
+ [Star this repo](https://github.com/Mohit-Bagri/Clipflow) if ClipFlow helped you create something awesome
219
+
220
+ </div>
@@ -0,0 +1,2 @@
1
+ #!/usr/bin/env bun
2
+ import "../src/index.tsx";