@makeitvisible/cli 0.1.0 → 0.2.0

package/README.md

@@ -10,6 +10,7 @@ The Visible CLI helps technical teams analyze code, PRs, and repositories to gen
 - **Pull Request Analysis**: Analyze GitHub PRs with automatic context extraction
 - **AI-Powered Code Exploration**: Use "The Detective" agent to intelligently explore and understand codebases
 - **Artifact Generation**: Create structured artifacts ready for documentation generation
+- **Video Generation**: Automatically generate professional tutorial and release videos from your code
 
 ## Installation
 
@@ -49,6 +50,7 @@ The CLI requires the following environment variables:
 export OPENAI_API_KEY=sk-your-openai-api-key
 
 # Required for posting artifacts to Visible API
+# For local dev, defaults to http://localhost:3000/api and no API key is required
 export VISIBLE_API_BASE_URL=https://your-visible-instance.com
 export VISIBLE_API_KEY=your-api-key
 
@@ -78,6 +80,9 @@ visible analyze diff --no-post
 **Options:**
 - `[range]` - Git commit range (default: `HEAD~1..HEAD`)
 - `--no-post` - Skip posting artifact to Visible API
+- `--video [path]` - Generate video (optional: output directory)
+- `--video-format <format>` - Video format: `mp4` or `webm`
+- `--video-resolution <res>` - Resolution: `1080p`, `720p`, `480p`, `square`, `vertical`
 
 ### `visible analyze pr`
 
@@ -98,6 +103,9 @@ visible analyze pr --url https://github.com/owner/repo/pull/123 --no-post
 - `--url <url>` - Pull request URL
 - `--number <number>` - Pull request number (uses current repo)
 - `--no-post` - Skip posting artifact to Visible API
+- `--video [path]` - Generate video (optional: output directory)
+- `--video-format <format>` - Video format: `mp4` or `webm`
+- `--video-resolution <res>` - Resolution: `1080p`, `720p`, `480p`, `square`, `vertical`
 
 ### `visible analyze prompt "<query>"`
 
@@ -124,6 +132,9 @@ visible analyze prompt "explain the search feature" --no-post
 - `<query>` - Natural language prompt describing what to analyze
 - `-v, --verbose` - Show detailed agent activity
 - `--no-post` - Skip posting artifact to Visible API
+- `--video [path]` - Generate video (optional: output directory)
+- `--video-format <format>` - Video format: `mp4` or `webm`
+- `--video-resolution <res>` - Resolution: `1080p`, `720p`, `480p`, `square`, `vertical`
 
 **How The Detective Agent works:**
 
@@ -139,6 +150,34 @@ visible analyze prompt "explain the search feature" --no-post
    - Data structures involved
    - Usage examples from the codebase
 
+## Video Generation
+
+Generate professional videos that showcase your features, explain changes, or create tutorials.
+
+```bash
+# Generate a video from feature analysis
+visible analyze prompt "how does checkout work" --video
+
+# Generate a video from git changes
+visible analyze diff --video
+
+# Customize resolution and format
+visible analyze pr --url https://github.com/org/repo/pull/123 \
+  --video ./videos \
+  --video-resolution 1080p \
+  --video-format mp4
+```
+
+**Resolution presets:** `1080p`, `720p`, `480p`, `square` (Instagram), `vertical` (TikTok/Stories)
+
+Videos include:
+- AI-generated UI mockups matching your app's design
+- Code highlights with syntax highlighting
+- Professional transitions and animations
+- Your color scheme and branding
+
+See [docs/VIDEO-GENERATION.md](docs/VIDEO-GENERATION.md) for the complete guide.
+
 ## Example Workflow
 
 ```bash
@@ -148,6 +187,7 @@ cd your-project
 # 2. Set up environment
 export OPENAI_API_KEY=sk-xxx
 export VISIBLE_API_BASE_URL=http://localhost:3000
+# API key is optional when using localhost
 export VISIBLE_API_KEY=my-key
 
 # 3. Explore a feature and create an artifact
@@ -157,6 +197,9 @@ visible analyze prompt "how do users create new projects"
 #    - Investigation results (entry points, data flow, key files)
 #    - Post the artifact to the Visible API
 #    - Return a URL to continue in the dashboard
+
+# 5. Generate a video (optional)
+visible analyze prompt "how do users create new projects" --video
 ```
 
 ## Artifact Output