PlanOpticon

planopticon / docs / getting-started / quickstart.md
Source Blame History 178 lines
f0106a3… leo 1 # Quick Start
f0106a3… leo 2
f0106a3… leo 3 ## Analyze a single video
f0106a3… leo 4
f0106a3… leo 5 ```bash
f0106a3… leo 6 planopticon analyze -i meeting.mp4 -o ./output
f0106a3… leo 7 ```
f0106a3… leo 8
f0106a3… leo 9 This runs the full pipeline:
f0106a3… leo 10
f0106a3… leo 11 1. Extracts video frames (smart sampling, change detection)
f0106a3… leo 12 2. Extracts and transcribes audio
f0106a3… leo 13 3. Detects and analyzes diagrams, charts, whiteboards
f0106a3… leo 14 4. Builds a knowledge graph of entities and relationships
f0106a3… leo 15 5. Extracts key points and action items
f0106a3… leo 16 6. Generates markdown, HTML, and PDF reports
f0106a3… leo 17 7. Outputs a `manifest.json` with everything
f0106a3… leo 18
f0106a3… leo 19 ## Processing depth
f0106a3… leo 20
f0106a3… leo 21 ```bash
f0106a3… leo 22 # Quick scan — transcription + key points only
f0106a3… leo 23 planopticon analyze -i video.mp4 -o ./out --depth basic
f0106a3… leo 24
f0106a3… leo 25 # Standard — includes diagram extraction (default)
f0106a3… leo 26 planopticon analyze -i video.mp4 -o ./out --depth standard
f0106a3… leo 27
f0106a3… leo 28 # Deep — more frames analyzed, richer extraction
f0106a3… leo 29 planopticon analyze -i video.mp4 -o ./out --depth comprehensive
f0106a3… leo 30 ```
f0106a3… leo 31
f0106a3… leo 32 ## Choose a provider
f0106a3… leo 33
f0106a3… leo 34 ```bash
f0106a3… leo 35 # Auto-detect best available (default)
f0106a3… leo 36 planopticon analyze -i video.mp4 -o ./out
f0106a3… leo 37
f0106a3… leo 38 # Force a specific provider
f0106a3… leo 39 planopticon analyze -i video.mp4 -o ./out --provider openai
f0106a3… leo 40
a0146a5… noreply 41 # Use Ollama for fully offline processing (no API keys needed)
a0146a5… noreply 42 planopticon analyze -i video.mp4 -o ./out --provider ollama
a0146a5… noreply 43
f0106a3… leo 44 # Override specific models
f0106a3… leo 45 planopticon analyze -i video.mp4 -o ./out \
f0106a3… leo 46 --vision-model gpt-4o \
f0106a3… leo 47 --chat-model claude-sonnet-4-5-20250929
f0106a3… leo 48 ```
f0106a3… leo 49
f0106a3… leo 50 ## Batch processing
f0106a3… leo 51
f0106a3… leo 52 ```bash
f0106a3… leo 53 # Process all videos in a folder
f0106a3… leo 54 planopticon batch -i ./recordings -o ./output
f0106a3… leo 55
f0106a3… leo 56 # Custom file patterns
f0106a3… leo 57 planopticon batch -i ./recordings -o ./output --pattern "*.mp4,*.mov"
f0106a3… leo 58
f0106a3… leo 59 # With a title for the batch report
f0106a3… leo 60 planopticon batch -i ./recordings -o ./output --title "Q4 Sprint Reviews"
f0106a3… leo 61 ```
f0106a3… leo 62
f0106a3… leo 63 Batch mode produces per-video outputs plus:
f0106a3… leo 64
f0106a3… leo 65 - Merged knowledge graph across all videos
f0106a3… leo 66 - Batch summary with aggregated action items
f0106a3… leo 67 - Cross-referenced entities
0981a08… noreply 68
0981a08… noreply 69 ## Ingest documents
0981a08… noreply 70
0981a08… noreply 71 Build a knowledge graph from documents, notes, or any text content:
0981a08… noreply 72
0981a08… noreply 73 ```bash
0981a08… noreply 74 # Ingest a single file
0981a08… noreply 75 planopticon ingest ./meeting-notes.md --output ./kb
0981a08… noreply 76
0981a08… noreply 77 # Ingest a directory recursively
0981a08… noreply 78 planopticon ingest ./docs/ --output ./kb --recursive
0981a08… noreply 79
0981a08… noreply 80 # Ingest from a URL
0981a08… noreply 81 planopticon ingest "https://www.youtube.com/watch?v=example" --output ./kb
0981a08… noreply 82 ```
0981a08… noreply 83
0981a08… noreply 84 ## Companion REPL
0981a08… noreply 85
0981a08… noreply 86 Chat with your knowledge base interactively:
0981a08… noreply 87
0981a08… noreply 88 ```bash
0981a08… noreply 89 # Start the companion
0981a08… noreply 90 planopticon companion --kb ./kb
0981a08… noreply 91
0981a08… noreply 92 # Use a specific provider
0981a08… noreply 93 planopticon companion --kb ./kb --provider anthropic
0981a08… noreply 94 ```
0981a08… noreply 95
0981a08… noreply 96 The companion understands your knowledge graph and can answer questions, find connections, and summarize topics conversationally.
0981a08… noreply 97
0981a08… noreply 98 ## Planning agent
0981a08… noreply 99
0981a08… noreply 100 Run the planning agent for adaptive, goal-directed analysis:
0981a08… noreply 101
0981a08… noreply 102 ```bash
0981a08… noreply 103 # Interactive mode — the agent asks before each action
0981a08… noreply 104 planopticon agent --kb ./kb --interactive
0981a08… noreply 105
0981a08… noreply 106 # Non-interactive with export
0981a08… noreply 107 planopticon agent --kb ./kb --export ./plan.md
0981a08… noreply 108 ```
0981a08… noreply 109
0981a08… noreply 110 ## Query the knowledge graph
0981a08… noreply 111
0981a08… noreply 112 Query your knowledge graph directly without an AI provider:
0981a08… noreply 113
0981a08… noreply 114 ```bash
0981a08… noreply 115 # Show graph stats (entity/relationship counts)
0981a08… noreply 116 planopticon query stats
0981a08… noreply 117
0981a08… noreply 118 # List entities by type
0981a08… noreply 119 planopticon query "entities --type technology"
0981a08… noreply 120
0981a08… noreply 121 # Find neighbors of an entity
0981a08… noreply 122 planopticon query "neighbors Alice"
0981a08… noreply 123
0981a08… noreply 124 # Natural language query (requires API key)
0981a08… noreply 125 planopticon query "What technologies were discussed?"
0981a08… noreply 126
0981a08… noreply 127 # Interactive REPL
0981a08… noreply 128 planopticon query -I
0981a08… noreply 129 ```
0981a08… noreply 130
0981a08… noreply 131 ## Export
0981a08… noreply 132
0981a08… noreply 133 Export your knowledge base to various formats:
0981a08… noreply 134
0981a08… noreply 135 ```bash
0981a08… noreply 136 # Export to Markdown files
0981a08… noreply 137 planopticon export markdown --input ./kb --output ./docs
0981a08… noreply 138
0981a08… noreply 139 # Export to an Obsidian vault
0981a08… noreply 140 planopticon export obsidian --input ./kb --output ~/Obsidian/PlanOpticon
0981a08… noreply 141
0981a08… noreply 142 # Export to Notion
0981a08… noreply 143 planopticon export notion --input ./kb --parent-page abc123
0981a08… noreply 144
0981a08… noreply 145 # Export as exchange format (portable JSON)
0981a08… noreply 146 planopticon export exchange --input ./kb --output ./export.json
0981a08… noreply 147 ```
f0106a3… leo 148
f0106a3… leo 149 ## Discover available models
f0106a3… leo 150
f0106a3… leo 151 ```bash
f0106a3… leo 152 planopticon list-models
f0106a3… leo 153 ```
f0106a3… leo 154
f0106a3… leo 155 Shows all models from configured providers with their capabilities (vision, chat, transcription).
f0106a3… leo 156
f0106a3… leo 157 ## Output structure
f0106a3… leo 158
f0106a3… leo 159 After processing, your output directory looks like:
f0106a3… leo 160
f0106a3… leo 161 ```
f0106a3… leo 162 output/
f0106a3… leo 163 ├── manifest.json # Single source of truth
f0106a3… leo 164 ├── transcript/
f0106a3… leo 165 │ ├── transcript.json # Full transcript with segments
f0106a3… leo 166 │ ├── transcript.txt # Plain text
f0106a3… leo 167 │ └── transcript.srt # Subtitles
f0106a3… leo 168 ├── frames/ # Extracted video frames
f0106a3… leo 169 ├── diagrams/ # Detected diagrams + mermaid/SVG/PNG
f0106a3… leo 170 ├── captures/ # Screengrab fallbacks
f0106a3… leo 171 └── results/
f0106a3… leo 172 ├── analysis.md # Markdown report
f0106a3… leo 173 ├── analysis.html # HTML report
f0106a3… leo 174 ├── analysis.pdf # PDF report
f0106a3… leo 175 ├── knowledge_graph.json
f0106a3… leo 176 ├── key_points.json
f0106a3… leo 177 └── action_items.json
f0106a3… leo 178 ```

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button