PlanOpticon

planopticon / getting-started / quickstart / index.html
Source Rendered
Blame History Raw 2002 lines
1
2
<!doctype html>
3
<html lang="en" class="no-js">
4
<head>
5
6
<meta charset="utf-8">
7
<meta name="viewport" content="width=device-width,initial-scale=1">
8
9
<meta name="description" content="AI-powered video analysis and knowledge extraction">
10
11
12
<meta name="author" content="CONFLICT LLC">
13
14
15
<link rel="canonical" href="https://planopticon.dev/getting-started/quickstart/">
16
17
18
<link rel="prev" href="../installation/">
19
20
21
<link rel="next" href="../configuration/">
22
23
24
25
26
27
<link rel="icon" href="../../assets/images/favicon.png">
28
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.4">
29
30
31
32
<title>Quick Start - PlanOpticon</title>
33
34
35
36
<link rel="stylesheet" href="../../assets/stylesheets/main.484c7ddc.min.css">
37
38
39
<link rel="stylesheet" href="../../assets/stylesheets/palette.ab4e12ef.min.css">
40
41
42
43
44
45
46
47
48
49
50
51
52
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
53
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
54
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
55
56
57
58
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
59
60
<link rel="stylesheet" href="../../assets/css/custom.css">
61
62
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
63
64
65
66
67
68
</head>
69
70
71
72
73
74
75
76
77
78
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="custom" data-md-color-accent="custom">
79
80
81
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
82
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
83
<label class="md-overlay" for="__drawer"></label>
84
<div data-md-component="skip">
85
86
87
<a href="#quick-start" class="md-skip">
88
Skip to content
89
</a>
90
91
</div>
92
<div data-md-component="announce">
93
94
</div>
95
96
97
98
99
<header class="md-header" data-md-component="header">
100
<nav class="md-header__inner md-grid" aria-label="Header">
101
<a href="../.." title="PlanOpticon" class="md-header__button md-logo" aria-label="PlanOpticon" data-md-component="logo">
102
103
<img src="../../assets/images/conflict-logo.svg" alt="logo">
104
105
</a>
106
<label class="md-header__button md-icon" for="__drawer">
107
108
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
109
</label>
110
<div class="md-header__title" data-md-component="header-title">
111
<div class="md-header__ellipsis">
112
<div class="md-header__topic">
113
<span class="md-ellipsis">
114
PlanOpticon
115
</span>
116
</div>
117
<div class="md-header__topic" data-md-component="header-topic">
118
<span class="md-ellipsis">
119
120
Quick Start
121
122
</span>
123
</div>
124
</div>
125
</div>
126
127
128
<form class="md-header__option" data-md-component="palette">
129
130
131
132
133
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_0">
134
135
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
136
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
137
</label>
138
139
140
141
142
143
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
144
145
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_0" hidden>
146
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
147
</label>
148
149
150
</form>
151
152
153
154
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
155
156
157
158
159
160
<label class="md-header__button md-icon" for="__search">
161
162
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
163
</label>
164
<div class="md-search" data-md-component="search" role="dialog">
165
<label class="md-search__overlay" for="__search"></label>
166
<div class="md-search__inner" role="search">
167
<form class="md-search__form" name="search">
168
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
169
<label class="md-search__icon md-icon" for="__search">
170
171
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
172
173
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
174
</label>
175
<nav class="md-search__options" aria-label="Search">
176
177
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
178
179
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
180
</button>
181
</nav>
182
183
<div class="md-search__suggest" data-md-component="search-suggest"></div>
184
185
</form>
186
<div class="md-search__output">
187
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
188
<div class="md-search-result" data-md-component="search-result">
189
<div class="md-search-result__meta">
190
Initializing search
191
</div>
192
<ol class="md-search-result__list" role="presentation"></ol>
193
</div>
194
</div>
195
</div>
196
</div>
197
</div>
198
199
200
201
<div class="md-header__source">
202
<a href="https://github.com/ConflictHQ/PlanOpticon" title="Go to repository" class="md-source" data-md-component="source">
203
<div class="md-source__icon md-icon">
204
205
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
206
</div>
207
<div class="md-source__repository">
208
ConflictHQ/PlanOpticon
209
</div>
210
</a>
211
</div>
212
213
</nav>
214
215
</header>
216
217
<div class="md-container" data-md-component="container">
218
219
220
221
222
223
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
224
<div class="md-grid">
225
<ul class="md-tabs__list">
226
227
228
229
230
231
232
<li class="md-tabs__item">
233
<a href="../.." class="md-tabs__link">
234
235
236
237
238
239
Home
240
241
</a>
242
</li>
243
244
245
246
247
248
249
250
251
252
253
254
255
<li class="md-tabs__item md-tabs__item--active">
256
<a href="../installation/" class="md-tabs__link">
257
258
259
260
Getting Started
261
262
</a>
263
</li>
264
265
266
267
268
269
270
271
272
273
274
275
<li class="md-tabs__item">
276
<a href="../../guide/single-video/" class="md-tabs__link">
277
278
279
280
User Guide
281
282
</a>
283
</li>
284
285
286
287
288
289
290
291
292
293
<li class="md-tabs__item">
294
<a href="../../use-cases/" class="md-tabs__link">
295
296
297
298
299
300
Use Cases
301
302
</a>
303
</li>
304
305
306
307
308
309
310
311
312
<li class="md-tabs__item">
313
<a href="../../cli-reference/" class="md-tabs__link">
314
315
316
317
318
319
CLI Reference
320
321
</a>
322
</li>
323
324
325
326
327
328
329
330
331
332
333
<li class="md-tabs__item">
334
<a href="../../architecture/overview/" class="md-tabs__link">
335
336
337
338
Architecture
339
340
</a>
341
</li>
342
343
344
345
346
347
348
349
350
351
352
353
<li class="md-tabs__item">
354
<a href="../../api/models/" class="md-tabs__link">
355
356
357
358
API Reference
359
360
</a>
361
</li>
362
363
364
365
366
367
368
369
370
371
<li class="md-tabs__item">
372
<a href="../../faq/" class="md-tabs__link">
373
374
375
376
377
378
FAQ & Troubleshooting
379
380
</a>
381
</li>
382
383
384
385
386
387
388
389
390
<li class="md-tabs__item">
391
<a href="../../contributing/" class="md-tabs__link">
392
393
394
395
396
397
Contributing
398
399
</a>
400
</li>
401
402
403
404
</ul>
405
</div>
406
</nav>
407
408
409
410
<main class="md-main" data-md-component="main">
411
<div class="md-main__inner md-grid">
412
413
414
415
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
416
<div class="md-sidebar__scrollwrap">
417
<div class="md-sidebar__inner">
418
419
420
421
422
423
424
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
425
<label class="md-nav__title" for="__drawer">
426
<a href="../.." title="PlanOpticon" class="md-nav__button md-logo" aria-label="PlanOpticon" data-md-component="logo">
427
428
<img src="../../assets/images/conflict-logo.svg" alt="logo">
429
430
</a>
431
PlanOpticon
432
</label>
433
434
<div class="md-nav__source">
435
<a href="https://github.com/ConflictHQ/PlanOpticon" title="Go to repository" class="md-source" data-md-component="source">
436
<div class="md-source__icon md-icon">
437
438
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
439
</div>
440
<div class="md-source__repository">
441
ConflictHQ/PlanOpticon
442
</div>
443
</a>
444
</div>
445
446
<ul class="md-nav__list" data-md-scrollfix>
447
448
449
450
451
452
453
454
<li class="md-nav__item">
455
<a href="../.." class="md-nav__link">
456
457
458
459
<span class="md-ellipsis">
460
461
462
Home
463
464
465
466
</span>
467
468
469
470
</a>
471
</li>
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
497
498
499
500
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
501
502
503
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
504
505
506
507
<span class="md-ellipsis">
508
509
510
Getting Started
511
512
513
514
</span>
515
516
517
518
<span class="md-nav__icon md-icon"></span>
519
</label>
520
521
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
522
<label class="md-nav__title" for="__nav_2">
523
<span class="md-nav__icon md-icon"></span>
524
525
526
Getting Started
527
528
529
</label>
530
<ul class="md-nav__list" data-md-scrollfix>
531
532
533
534
535
536
537
538
<li class="md-nav__item">
539
<a href="../installation/" class="md-nav__link">
540
541
542
543
<span class="md-ellipsis">
544
545
546
Installation
547
548
549
550
</span>
551
552
553
554
</a>
555
</li>
556
557
558
559
560
561
562
563
564
565
566
567
568
<li class="md-nav__item md-nav__item--active">
569
570
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
571
572
573
574
575
576
<label class="md-nav__link md-nav__link--active" for="__toc">
577
578
579
580
<span class="md-ellipsis">
581
582
583
Quick Start
584
585
586
587
</span>
588
589
590
591
<span class="md-nav__icon md-icon"></span>
592
</label>
593
594
<a href="./" class="md-nav__link md-nav__link--active">
595
596
597
598
<span class="md-ellipsis">
599
600
601
Quick Start
602
603
604
605
</span>
606
607
608
609
</a>
610
611
612
613
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
614
615
616
617
618
619
620
<label class="md-nav__title" for="__toc">
621
<span class="md-nav__icon md-icon"></span>
622
Table of contents
623
</label>
624
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
625
626
<li class="md-nav__item">
627
<a href="#analyze-a-single-video" class="md-nav__link">
628
<span class="md-ellipsis">
629
630
Analyze a single video
631
632
</span>
633
</a>
634
635
</li>
636
637
<li class="md-nav__item">
638
<a href="#processing-depth" class="md-nav__link">
639
<span class="md-ellipsis">
640
641
Processing depth
642
643
</span>
644
</a>
645
646
</li>
647
648
<li class="md-nav__item">
649
<a href="#choose-a-provider" class="md-nav__link">
650
<span class="md-ellipsis">
651
652
Choose a provider
653
654
</span>
655
</a>
656
657
</li>
658
659
<li class="md-nav__item">
660
<a href="#batch-processing" class="md-nav__link">
661
<span class="md-ellipsis">
662
663
Batch processing
664
665
</span>
666
</a>
667
668
</li>
669
670
<li class="md-nav__item">
671
<a href="#ingest-documents" class="md-nav__link">
672
<span class="md-ellipsis">
673
674
Ingest documents
675
676
</span>
677
</a>
678
679
</li>
680
681
<li class="md-nav__item">
682
<a href="#companion-repl" class="md-nav__link">
683
<span class="md-ellipsis">
684
685
Companion REPL
686
687
</span>
688
</a>
689
690
</li>
691
692
<li class="md-nav__item">
693
<a href="#planning-agent" class="md-nav__link">
694
<span class="md-ellipsis">
695
696
Planning agent
697
698
</span>
699
</a>
700
701
</li>
702
703
<li class="md-nav__item">
704
<a href="#query-the-knowledge-graph" class="md-nav__link">
705
<span class="md-ellipsis">
706
707
Query the knowledge graph
708
709
</span>
710
</a>
711
712
</li>
713
714
<li class="md-nav__item">
715
<a href="#export" class="md-nav__link">
716
<span class="md-ellipsis">
717
718
Export
719
720
</span>
721
</a>
722
723
</li>
724
725
<li class="md-nav__item">
726
<a href="#discover-available-models" class="md-nav__link">
727
<span class="md-ellipsis">
728
729
Discover available models
730
731
</span>
732
</a>
733
734
</li>
735
736
<li class="md-nav__item">
737
<a href="#output-structure" class="md-nav__link">
738
<span class="md-ellipsis">
739
740
Output structure
741
742
</span>
743
</a>
744
745
</li>
746
747
</ul>
748
749
</nav>
750
751
</li>
752
753
754
755
756
757
758
759
760
761
762
<li class="md-nav__item">
763
<a href="../configuration/" class="md-nav__link">
764
765
766
767
<span class="md-ellipsis">
768
769
770
Configuration
771
772
773
774
</span>
775
776
777
778
</a>
779
</li>
780
781
782
783
784
</ul>
785
</nav>
786
787
</li>
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
<li class="md-nav__item md-nav__item--nested">
808
809
810
811
812
813
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
814
815
816
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
817
818
819
820
<span class="md-ellipsis">
821
822
823
User Guide
824
825
826
827
</span>
828
829
830
831
<span class="md-nav__icon md-icon"></span>
832
</label>
833
834
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
835
<label class="md-nav__title" for="__nav_3">
836
<span class="md-nav__icon md-icon"></span>
837
838
839
User Guide
840
841
842
</label>
843
<ul class="md-nav__list" data-md-scrollfix>
844
845
846
847
848
849
850
851
<li class="md-nav__item">
852
<a href="../../guide/single-video/" class="md-nav__link">
853
854
855
856
<span class="md-ellipsis">
857
858
859
Single Video Analysis
860
861
862
863
</span>
864
865
866
867
</a>
868
</li>
869
870
871
872
873
874
875
876
877
878
879
<li class="md-nav__item">
880
<a href="../../guide/batch/" class="md-nav__link">
881
882
883
884
<span class="md-ellipsis">
885
886
887
Batch Processing
888
889
890
891
</span>
892
893
894
895
</a>
896
</li>
897
898
899
900
901
902
903
904
905
906
907
<li class="md-nav__item">
908
<a href="../../guide/document-ingestion/" class="md-nav__link">
909
910
911
912
<span class="md-ellipsis">
913
914
915
Document Ingestion
916
917
918
919
</span>
920
921
922
923
</a>
924
</li>
925
926
927
928
929
930
931
932
933
934
935
<li class="md-nav__item">
936
<a href="../../guide/cloud-sources/" class="md-nav__link">
937
938
939
940
<span class="md-ellipsis">
941
942
943
Cloud Sources
944
945
946
947
</span>
948
949
950
951
</a>
952
</li>
953
954
955
956
957
958
959
960
961
962
963
<li class="md-nav__item">
964
<a href="../../guide/knowledge-graphs/" class="md-nav__link">
965
966
967
968
<span class="md-ellipsis">
969
970
971
Knowledge Graphs
972
973
974
975
</span>
976
977
978
979
</a>
980
</li>
981
982
983
984
985
986
987
988
989
990
991
<li class="md-nav__item">
992
<a href="../../guide/companion/" class="md-nav__link">
993
994
995
996
<span class="md-ellipsis">
997
998
999
Interactive Companion
1000
1001
1002
1003
</span>
1004
1005
1006
1007
</a>
1008
</li>
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
<li class="md-nav__item">
1020
<a href="../../guide/planning-agent/" class="md-nav__link">
1021
1022
1023
1024
<span class="md-ellipsis">
1025
1026
1027
Planning Agent
1028
1029
1030
1031
</span>
1032
1033
1034
1035
</a>
1036
</li>
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
<li class="md-nav__item">
1048
<a href="../../guide/authentication/" class="md-nav__link">
1049
1050
1051
1052
<span class="md-ellipsis">
1053
1054
1055
Authentication
1056
1057
1058
1059
</span>
1060
1061
1062
1063
</a>
1064
</li>
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
<li class="md-nav__item">
1076
<a href="../../guide/export/" class="md-nav__link">
1077
1078
1079
1080
<span class="md-ellipsis">
1081
1082
1083
Export & Documents
1084
1085
1086
1087
</span>
1088
1089
1090
1091
</a>
1092
</li>
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
<li class="md-nav__item">
1104
<a href="../../guide/output-formats/" class="md-nav__link">
1105
1106
1107
1108
<span class="md-ellipsis">
1109
1110
1111
Output Formats
1112
1113
1114
1115
</span>
1116
1117
1118
1119
</a>
1120
</li>
1121
1122
1123
1124
1125
</ul>
1126
</nav>
1127
1128
</li>
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
<li class="md-nav__item">
1139
<a href="../../use-cases/" class="md-nav__link">
1140
1141
1142
1143
<span class="md-ellipsis">
1144
1145
1146
Use Cases
1147
1148
1149
1150
</span>
1151
1152
1153
1154
</a>
1155
</li>
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
<li class="md-nav__item">
1166
<a href="../../cli-reference/" class="md-nav__link">
1167
1168
1169
1170
<span class="md-ellipsis">
1171
1172
1173
CLI Reference
1174
1175
1176
1177
</span>
1178
1179
1180
1181
</a>
1182
</li>
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
<li class="md-nav__item md-nav__item--nested">
1203
1204
1205
1206
1207
1208
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
1209
1210
1211
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
1212
1213
1214
1215
<span class="md-ellipsis">
1216
1217
1218
Architecture
1219
1220
1221
1222
</span>
1223
1224
1225
1226
<span class="md-nav__icon md-icon"></span>
1227
</label>
1228
1229
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
1230
<label class="md-nav__title" for="__nav_6">
1231
<span class="md-nav__icon md-icon"></span>
1232
1233
1234
Architecture
1235
1236
1237
</label>
1238
<ul class="md-nav__list" data-md-scrollfix>
1239
1240
1241
1242
1243
1244
1245
1246
<li class="md-nav__item">
1247
<a href="../../architecture/overview/" class="md-nav__link">
1248
1249
1250
1251
<span class="md-ellipsis">
1252
1253
1254
Overview
1255
1256
1257
1258
</span>
1259
1260
1261
1262
</a>
1263
</li>
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
<li class="md-nav__item">
1275
<a href="../../architecture/providers/" class="md-nav__link">
1276
1277
1278
1279
<span class="md-ellipsis">
1280
1281
1282
Provider System
1283
1284
1285
1286
</span>
1287
1288
1289
1290
</a>
1291
</li>
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
<li class="md-nav__item">
1303
<a href="../../architecture/pipeline/" class="md-nav__link">
1304
1305
1306
1307
<span class="md-ellipsis">
1308
1309
1310
Processing Pipeline
1311
1312
1313
1314
</span>
1315
1316
1317
1318
</a>
1319
</li>
1320
1321
1322
1323
1324
</ul>
1325
</nav>
1326
1327
</li>
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
<li class="md-nav__item md-nav__item--nested">
1348
1349
1350
1351
1352
1353
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
1354
1355
1356
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
1357
1358
1359
1360
<span class="md-ellipsis">
1361
1362
1363
API Reference
1364
1365
1366
1367
</span>
1368
1369
1370
1371
<span class="md-nav__icon md-icon"></span>
1372
</label>
1373
1374
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
1375
<label class="md-nav__title" for="__nav_7">
1376
<span class="md-nav__icon md-icon"></span>
1377
1378
1379
API Reference
1380
1381
1382
</label>
1383
<ul class="md-nav__list" data-md-scrollfix>
1384
1385
1386
1387
1388
1389
1390
1391
<li class="md-nav__item">
1392
<a href="../../api/models/" class="md-nav__link">
1393
1394
1395
1396
<span class="md-ellipsis">
1397
1398
1399
Models
1400
1401
1402
1403
</span>
1404
1405
1406
1407
</a>
1408
</li>
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
<li class="md-nav__item">
1420
<a href="../../api/providers/" class="md-nav__link">
1421
1422
1423
1424
<span class="md-ellipsis">
1425
1426
1427
Providers
1428
1429
1430
1431
</span>
1432
1433
1434
1435
</a>
1436
</li>
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
<li class="md-nav__item">
1448
<a href="../../api/analyzers/" class="md-nav__link">
1449
1450
1451
1452
<span class="md-ellipsis">
1453
1454
1455
Analyzers
1456
1457
1458
1459
</span>
1460
1461
1462
1463
</a>
1464
</li>
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
<li class="md-nav__item">
1476
<a href="../../api/agent/" class="md-nav__link">
1477
1478
1479
1480
<span class="md-ellipsis">
1481
1482
1483
Agent & Skills
1484
1485
1486
1487
</span>
1488
1489
1490
1491
</a>
1492
</li>
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
<li class="md-nav__item">
1504
<a href="../../api/sources/" class="md-nav__link">
1505
1506
1507
1508
<span class="md-ellipsis">
1509
1510
1511
Sources
1512
1513
1514
1515
</span>
1516
1517
1518
1519
</a>
1520
</li>
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
<li class="md-nav__item">
1532
<a href="../../api/auth/" class="md-nav__link">
1533
1534
1535
1536
<span class="md-ellipsis">
1537
1538
1539
Authentication
1540
1541
1542
1543
</span>
1544
1545
1546
1547
</a>
1548
</li>
1549
1550
1551
1552
1553
</ul>
1554
</nav>
1555
1556
</li>
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
<li class="md-nav__item">
1567
<a href="../../faq/" class="md-nav__link">
1568
1569
1570
1571
<span class="md-ellipsis">
1572
1573
1574
FAQ & Troubleshooting
1575
1576
1577
1578
</span>
1579
1580
1581
1582
</a>
1583
</li>
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
<li class="md-nav__item">
1594
<a href="../../contributing/" class="md-nav__link">
1595
1596
1597
1598
<span class="md-ellipsis">
1599
1600
1601
Contributing
1602
1603
1604
1605
</span>
1606
1607
1608
1609
</a>
1610
</li>
1611
1612
1613
1614
</ul>
1615
</nav>
1616
</div>
1617
</div>
1618
</div>
1619
1620
1621
1622
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1623
<div class="md-sidebar__scrollwrap">
1624
<div class="md-sidebar__inner">
1625
1626
1627
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1628
1629
1630
1631
1632
1633
1634
<label class="md-nav__title" for="__toc">
1635
<span class="md-nav__icon md-icon"></span>
1636
Table of contents
1637
</label>
1638
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1639
1640
<li class="md-nav__item">
1641
<a href="#analyze-a-single-video" class="md-nav__link">
1642
<span class="md-ellipsis">
1643
1644
Analyze a single video
1645
1646
</span>
1647
</a>
1648
1649
</li>
1650
1651
<li class="md-nav__item">
1652
<a href="#processing-depth" class="md-nav__link">
1653
<span class="md-ellipsis">
1654
1655
Processing depth
1656
1657
</span>
1658
</a>
1659
1660
</li>
1661
1662
<li class="md-nav__item">
1663
<a href="#choose-a-provider" class="md-nav__link">
1664
<span class="md-ellipsis">
1665
1666
Choose a provider
1667
1668
</span>
1669
</a>
1670
1671
</li>
1672
1673
<li class="md-nav__item">
1674
<a href="#batch-processing" class="md-nav__link">
1675
<span class="md-ellipsis">
1676
1677
Batch processing
1678
1679
</span>
1680
</a>
1681
1682
</li>
1683
1684
<li class="md-nav__item">
1685
<a href="#ingest-documents" class="md-nav__link">
1686
<span class="md-ellipsis">
1687
1688
Ingest documents
1689
1690
</span>
1691
</a>
1692
1693
</li>
1694
1695
<li class="md-nav__item">
1696
<a href="#companion-repl" class="md-nav__link">
1697
<span class="md-ellipsis">
1698
1699
Companion REPL
1700
1701
</span>
1702
</a>
1703
1704
</li>
1705
1706
<li class="md-nav__item">
1707
<a href="#planning-agent" class="md-nav__link">
1708
<span class="md-ellipsis">
1709
1710
Planning agent
1711
1712
</span>
1713
</a>
1714
1715
</li>
1716
1717
<li class="md-nav__item">
1718
<a href="#query-the-knowledge-graph" class="md-nav__link">
1719
<span class="md-ellipsis">
1720
1721
Query the knowledge graph
1722
1723
</span>
1724
</a>
1725
1726
</li>
1727
1728
<li class="md-nav__item">
1729
<a href="#export" class="md-nav__link">
1730
<span class="md-ellipsis">
1731
1732
Export
1733
1734
</span>
1735
</a>
1736
1737
</li>
1738
1739
<li class="md-nav__item">
1740
<a href="#discover-available-models" class="md-nav__link">
1741
<span class="md-ellipsis">
1742
1743
Discover available models
1744
1745
</span>
1746
</a>
1747
1748
</li>
1749
1750
<li class="md-nav__item">
1751
<a href="#output-structure" class="md-nav__link">
1752
<span class="md-ellipsis">
1753
1754
Output structure
1755
1756
</span>
1757
</a>
1758
1759
</li>
1760
1761
</ul>
1762
1763
</nav>
1764
</div>
1765
</div>
1766
</div>
1767
1768
1769
1770
<div class="md-content" data-md-component="content">
1771
1772
<article class="md-content__inner md-typeset">
1773
1774
1775
1776
1777
1778
1779
1780
1781
<h1 id="quick-start">Quick Start<a class="headerlink" href="#quick-start" title="Permanent link">&para;</a></h1>
1782
<h2 id="analyze-a-single-video">Analyze a single video<a class="headerlink" href="#analyze-a-single-video" title="Permanent link">&para;</a></h2>
1783
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>planopticon<span class="w"> </span>analyze<span class="w"> </span>-i<span class="w"> </span>meeting.mp4<span class="w"> </span>-o<span class="w"> </span>./output
1784
</code></pre></div>
1785
<p>This runs the full pipeline:</p>
1786
<ol>
1787
<li>Extracts video frames (smart sampling, change detection)</li>
1788
<li>Extracts and transcribes audio</li>
1789
<li>Detects and analyzes diagrams, charts, whiteboards</li>
1790
<li>Builds a knowledge graph of entities and relationships</li>
1791
<li>Extracts key points and action items</li>
1792
<li>Generates markdown, HTML, and PDF reports</li>
1793
<li>Outputs a <code>manifest.json</code> with everything</li>
1794
</ol>
1795
<h2 id="processing-depth">Processing depth<a class="headerlink" href="#processing-depth" title="Permanent link">&para;</a></h2>
1796
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="c1"># Quick scan — transcription + key points only</span>
1797
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>planopticon<span class="w"> </span>analyze<span class="w"> </span>-i<span class="w"> </span>video.mp4<span class="w"> </span>-o<span class="w"> </span>./out<span class="w"> </span>--depth<span class="w"> </span>basic
1798
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>
1799
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="c1"># Standard — includes diagram extraction (default)</span>
1800
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a>planopticon<span class="w"> </span>analyze<span class="w"> </span>-i<span class="w"> </span>video.mp4<span class="w"> </span>-o<span class="w"> </span>./out<span class="w"> </span>--depth<span class="w"> </span>standard
1801
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a>
1802
<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="c1"># Deep — more frames analyzed, richer extraction</span>
1803
<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a>planopticon<span class="w"> </span>analyze<span class="w"> </span>-i<span class="w"> </span>video.mp4<span class="w"> </span>-o<span class="w"> </span>./out<span class="w"> </span>--depth<span class="w"> </span>comprehensive
1804
</code></pre></div>
1805
<h2 id="choose-a-provider">Choose a provider<a class="headerlink" href="#choose-a-provider" title="Permanent link">&para;</a></h2>
1806
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="c1"># Auto-detect best available (default)</span>
1807
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>planopticon<span class="w"> </span>analyze<span class="w"> </span>-i<span class="w"> </span>video.mp4<span class="w"> </span>-o<span class="w"> </span>./out
1808
<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a>
1809
<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a><span class="c1"># Force a specific provider</span>
1810
<a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a>planopticon<span class="w"> </span>analyze<span class="w"> </span>-i<span class="w"> </span>video.mp4<span class="w"> </span>-o<span class="w"> </span>./out<span class="w"> </span>--provider<span class="w"> </span>openai
1811
<a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a>
1812
<a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a><span class="c1"># Use Ollama for fully offline processing (no API keys needed)</span>
1813
<a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a>planopticon<span class="w"> </span>analyze<span class="w"> </span>-i<span class="w"> </span>video.mp4<span class="w"> </span>-o<span class="w"> </span>./out<span class="w"> </span>--provider<span class="w"> </span>ollama
1814
<a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a>
1815
<a id="__codelineno-2-10" name="__codelineno-2-10" href="#__codelineno-2-10"></a><span class="c1"># Override specific models</span>
1816
<a id="__codelineno-2-11" name="__codelineno-2-11" href="#__codelineno-2-11"></a>planopticon<span class="w"> </span>analyze<span class="w"> </span>-i<span class="w"> </span>video.mp4<span class="w"> </span>-o<span class="w"> </span>./out<span class="w"> </span><span class="se">\</span>
1817
<a id="__codelineno-2-12" name="__codelineno-2-12" href="#__codelineno-2-12"></a><span class="w"> </span>--vision-model<span class="w"> </span>gpt-4o<span class="w"> </span><span class="se">\</span>
1818
<a id="__codelineno-2-13" name="__codelineno-2-13" href="#__codelineno-2-13"></a><span class="w"> </span>--chat-model<span class="w"> </span>claude-sonnet-4-5-20250929
1819
</code></pre></div>
1820
<h2 id="batch-processing">Batch processing<a class="headerlink" href="#batch-processing" title="Permanent link">&para;</a></h2>
1821
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="c1"># Process all videos in a folder</span>
1822
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a>planopticon<span class="w"> </span>batch<span class="w"> </span>-i<span class="w"> </span>./recordings<span class="w"> </span>-o<span class="w"> </span>./output
1823
<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a>
1824
<a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a><span class="c1"># Custom file patterns</span>
1825
<a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-5"></a>planopticon<span class="w"> </span>batch<span class="w"> </span>-i<span class="w"> </span>./recordings<span class="w"> </span>-o<span class="w"> </span>./output<span class="w"> </span>--pattern<span class="w"> </span><span class="s2">&quot;*.mp4,*.mov&quot;</span>
1826
<a id="__codelineno-3-6" name="__codelineno-3-6" href="#__codelineno-3-6"></a>
1827
<a id="__codelineno-3-7" name="__codelineno-3-7" href="#__codelineno-3-7"></a><span class="c1"># With a title for the batch report</span>
1828
<a id="__codelineno-3-8" name="__codelineno-3-8" href="#__codelineno-3-8"></a>planopticon<span class="w"> </span>batch<span class="w"> </span>-i<span class="w"> </span>./recordings<span class="w"> </span>-o<span class="w"> </span>./output<span class="w"> </span>--title<span class="w"> </span><span class="s2">&quot;Q4 Sprint Reviews&quot;</span>
1829
</code></pre></div>
1830
<p>Batch mode produces per-video outputs plus:</p>
1831
<ul>
1832
<li>Merged knowledge graph across all videos</li>
1833
<li>Batch summary with aggregated action items</li>
1834
<li>Cross-referenced entities</li>
1835
</ul>
1836
<h2 id="ingest-documents">Ingest documents<a class="headerlink" href="#ingest-documents" title="Permanent link">&para;</a></h2>
1837
<p>Build a knowledge graph from documents, notes, or any text content:</p>
1838
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="c1"># Ingest a single file</span>
1839
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>planopticon<span class="w"> </span>ingest<span class="w"> </span>./meeting-notes.md<span class="w"> </span>--output<span class="w"> </span>./kb
1840
<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a>
1841
<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a><span class="c1"># Ingest a directory recursively</span>
1842
<a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a>planopticon<span class="w"> </span>ingest<span class="w"> </span>./docs/<span class="w"> </span>--output<span class="w"> </span>./kb<span class="w"> </span>--recursive
1843
<a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a>
1844
<a id="__codelineno-4-7" name="__codelineno-4-7" href="#__codelineno-4-7"></a><span class="c1"># Ingest from a URL</span>
1845
<a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a>planopticon<span class="w"> </span>ingest<span class="w"> </span><span class="s2">&quot;https://www.youtube.com/watch?v=example&quot;</span><span class="w"> </span>--output<span class="w"> </span>./kb
1846
</code></pre></div>
1847
<h2 id="companion-repl">Companion REPL<a class="headerlink" href="#companion-repl" title="Permanent link">&para;</a></h2>
1848
<p>Chat with your knowledge base interactively:</p>
1849
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="c1"># Start the companion</span>
1850
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a>planopticon<span class="w"> </span>companion<span class="w"> </span>--kb<span class="w"> </span>./kb
1851
<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a>
1852
<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a><span class="c1"># Use a specific provider</span>
1853
<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a>planopticon<span class="w"> </span>companion<span class="w"> </span>--kb<span class="w"> </span>./kb<span class="w"> </span>--provider<span class="w"> </span>anthropic
1854
</code></pre></div>
1855
<p>The companion understands your knowledge graph and can answer questions, find connections, and summarize topics conversationally.</p>
1856
<h2 id="planning-agent">Planning agent<a class="headerlink" href="#planning-agent" title="Permanent link">&para;</a></h2>
1857
<p>Run the planning agent for adaptive, goal-directed analysis:</p>
1858
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="c1"># Interactive mode — the agent asks before each action</span>
1859
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a>planopticon<span class="w"> </span>agent<span class="w"> </span>--kb<span class="w"> </span>./kb<span class="w"> </span>--interactive
1860
<a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a>
1861
<a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a><span class="c1"># Non-interactive with export</span>
1862
<a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a>planopticon<span class="w"> </span>agent<span class="w"> </span>--kb<span class="w"> </span>./kb<span class="w"> </span>--export<span class="w"> </span>./plan.md
1863
</code></pre></div>
1864
<h2 id="query-the-knowledge-graph">Query the knowledge graph<a class="headerlink" href="#query-the-knowledge-graph" title="Permanent link">&para;</a></h2>
1865
<p>Query your knowledge graph directly without an AI provider:</p>
1866
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="c1"># Show graph stats (entity/relationship counts)</span>
1867
<a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a>planopticon<span class="w"> </span>query<span class="w"> </span>stats
1868
<a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a>
1869
<a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a><span class="c1"># List entities by type</span>
1870
<a id="__codelineno-7-5" name="__codelineno-7-5" href="#__codelineno-7-5"></a>planopticon<span class="w"> </span>query<span class="w"> </span><span class="s2">&quot;entities --type technology&quot;</span>
1871
<a id="__codelineno-7-6" name="__codelineno-7-6" href="#__codelineno-7-6"></a>
1872
<a id="__codelineno-7-7" name="__codelineno-7-7" href="#__codelineno-7-7"></a><span class="c1"># Find neighbors of an entity</span>
1873
<a id="__codelineno-7-8" name="__codelineno-7-8" href="#__codelineno-7-8"></a>planopticon<span class="w"> </span>query<span class="w"> </span><span class="s2">&quot;neighbors Alice&quot;</span>
1874
<a id="__codelineno-7-9" name="__codelineno-7-9" href="#__codelineno-7-9"></a>
1875
<a id="__codelineno-7-10" name="__codelineno-7-10" href="#__codelineno-7-10"></a><span class="c1"># Natural language query (requires API key)</span>
1876
<a id="__codelineno-7-11" name="__codelineno-7-11" href="#__codelineno-7-11"></a>planopticon<span class="w"> </span>query<span class="w"> </span><span class="s2">&quot;What technologies were discussed?&quot;</span>
1877
<a id="__codelineno-7-12" name="__codelineno-7-12" href="#__codelineno-7-12"></a>
1878
<a id="__codelineno-7-13" name="__codelineno-7-13" href="#__codelineno-7-13"></a><span class="c1"># Interactive REPL</span>
1879
<a id="__codelineno-7-14" name="__codelineno-7-14" href="#__codelineno-7-14"></a>planopticon<span class="w"> </span>query<span class="w"> </span>-I
1880
</code></pre></div>
1881
<h2 id="export">Export<a class="headerlink" href="#export" title="Permanent link">&para;</a></h2>
1882
<p>Export your knowledge base to various formats:</p>
1883
<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a><span class="c1"># Export to Markdown files</span>
1884
<a id="__codelineno-8-2" name="__codelineno-8-2" href="#__codelineno-8-2"></a>planopticon<span class="w"> </span><span class="nb">export</span><span class="w"> </span>markdown<span class="w"> </span>--input<span class="w"> </span>./kb<span class="w"> </span>--output<span class="w"> </span>./docs
1885
<a id="__codelineno-8-3" name="__codelineno-8-3" href="#__codelineno-8-3"></a>
1886
<a id="__codelineno-8-4" name="__codelineno-8-4" href="#__codelineno-8-4"></a><span class="c1"># Export to an Obsidian vault</span>
1887
<a id="__codelineno-8-5" name="__codelineno-8-5" href="#__codelineno-8-5"></a>planopticon<span class="w"> </span><span class="nb">export</span><span class="w"> </span>obsidian<span class="w"> </span>--input<span class="w"> </span>./kb<span class="w"> </span>--output<span class="w"> </span>~/Obsidian/PlanOpticon
1888
<a id="__codelineno-8-6" name="__codelineno-8-6" href="#__codelineno-8-6"></a>
1889
<a id="__codelineno-8-7" name="__codelineno-8-7" href="#__codelineno-8-7"></a><span class="c1"># Export to Notion</span>
1890
<a id="__codelineno-8-8" name="__codelineno-8-8" href="#__codelineno-8-8"></a>planopticon<span class="w"> </span><span class="nb">export</span><span class="w"> </span>notion<span class="w"> </span>--input<span class="w"> </span>./kb<span class="w"> </span>--parent-page<span class="w"> </span>abc123
1891
<a id="__codelineno-8-9" name="__codelineno-8-9" href="#__codelineno-8-9"></a>
1892
<a id="__codelineno-8-10" name="__codelineno-8-10" href="#__codelineno-8-10"></a><span class="c1"># Export as exchange format (portable JSON)</span>
1893
<a id="__codelineno-8-11" name="__codelineno-8-11" href="#__codelineno-8-11"></a>planopticon<span class="w"> </span><span class="nb">export</span><span class="w"> </span>exchange<span class="w"> </span>--input<span class="w"> </span>./kb<span class="w"> </span>--output<span class="w"> </span>./export.json
1894
</code></pre></div>
1895
<h2 id="discover-available-models">Discover available models<a class="headerlink" href="#discover-available-models" title="Permanent link">&para;</a></h2>
1896
<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>planopticon<span class="w"> </span>list-models
1897
</code></pre></div>
1898
<p>Shows all models from configured providers with their capabilities (vision, chat, transcription).</p>
1899
<h2 id="output-structure">Output structure<a class="headerlink" href="#output-structure" title="Permanent link">&para;</a></h2>
1900
<p>After processing, your output directory looks like:</p>
1901
<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a>output/
1902
<a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a>├── manifest.json # Single source of truth
1903
<a id="__codelineno-10-3" name="__codelineno-10-3" href="#__codelineno-10-3"></a>├── transcript/
1904
<a id="__codelineno-10-4" name="__codelineno-10-4" href="#__codelineno-10-4"></a>│ ├── transcript.json # Full transcript with segments
1905
<a id="__codelineno-10-5" name="__codelineno-10-5" href="#__codelineno-10-5"></a>│ ├── transcript.txt # Plain text
1906
<a id="__codelineno-10-6" name="__codelineno-10-6" href="#__codelineno-10-6"></a>│ └── transcript.srt # Subtitles
1907
<a id="__codelineno-10-7" name="__codelineno-10-7" href="#__codelineno-10-7"></a>├── frames/ # Extracted video frames
1908
<a id="__codelineno-10-8" name="__codelineno-10-8" href="#__codelineno-10-8"></a>├── diagrams/ # Detected diagrams + mermaid/SVG/PNG
1909
<a id="__codelineno-10-9" name="__codelineno-10-9" href="#__codelineno-10-9"></a>├── captures/ # Screengrab fallbacks
1910
<a id="__codelineno-10-10" name="__codelineno-10-10" href="#__codelineno-10-10"></a>└── results/
1911
<a id="__codelineno-10-11" name="__codelineno-10-11" href="#__codelineno-10-11"></a> ├── analysis.md # Markdown report
1912
<a id="__codelineno-10-12" name="__codelineno-10-12" href="#__codelineno-10-12"></a> ├── analysis.html # HTML report
1913
<a id="__codelineno-10-13" name="__codelineno-10-13" href="#__codelineno-10-13"></a> ├── analysis.pdf # PDF report
1914
<a id="__codelineno-10-14" name="__codelineno-10-14" href="#__codelineno-10-14"></a> ├── knowledge_graph.json
1915
<a id="__codelineno-10-15" name="__codelineno-10-15" href="#__codelineno-10-15"></a> ├── key_points.json
1916
<a id="__codelineno-10-16" name="__codelineno-10-16" href="#__codelineno-10-16"></a> └── action_items.json
1917
</code></pre></div>
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
</article>
1932
</div>
1933
1934
1935
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
1936
1937
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
1938
</div>
1939
1940
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
1941
1942
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
1943
Back to top
1944
</button>
1945
1946
</main>
1947
1948
<footer class="md-footer">
1949
1950
<div class="md-footer-meta md-typeset">
1951
<div class="md-footer-meta__inner md-grid">
1952
<div class="md-copyright">
1953
1954
<div class="md-copyright__highlight">
1955
Copyright &copy; 2026 CONFLICT LLC
1956
</div>
1957
1958
1959
Made with
1960
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1961
Material for MkDocs
1962
</a>
1963
1964
</div>
1965
1966
1967
<div class="md-social">
1968
1969
1970
1971
1972
1973
1974
1975
1976
<a href="https://github.com/ConflictHQ/PlanOpticon" target="_blank" rel="noopener" title="github.com" class="md-social__link">
1977
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
1978
</a>
1979
1980
</div>
1981
1982
</div>
1983
</div>
1984
</footer>
1985
1986
</div>
1987
<div class="md-dialog" data-md-component="dialog">
1988
<div class="md-dialog__inner md-typeset"></div>
1989
</div>
1990
1991
1992
1993
1994
1995
<script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.instant", "navigation.tabs", "navigation.sections", "navigation.expand", "navigation.top", "search.suggest", "search.highlight", "content.code.copy", "content.tabs.link", "header.autohide"], "search": "../../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
1996
1997
1998
<script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
1999
2000
2001
</body>
2002
</html>

Keyboard Shortcuts

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