PlanOpticon

planopticon / guide / companion / index.html
Source Rendered
Blame History Raw 2663 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/guide/companion/">
16
17
18
<link rel="prev" href="../knowledge-graphs/">
19
20
21
<link rel="next" href="../planning-agent/">
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>Interactive Companion - 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="#interactive-companion-repl" 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
Interactive Companion
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
<li class="md-tabs__item">
254
<a href="../../getting-started/installation/" class="md-tabs__link">
255
256
257
258
Getting Started
259
260
</a>
261
</li>
262
263
264
265
266
267
268
269
270
271
272
273
274
275
<li class="md-tabs__item md-tabs__item--active">
276
<a href="../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
<li class="md-nav__item md-nav__item--nested">
492
493
494
495
496
497
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
498
499
500
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
501
502
503
504
<span class="md-ellipsis">
505
506
507
Getting Started
508
509
510
511
</span>
512
513
514
515
<span class="md-nav__icon md-icon"></span>
516
</label>
517
518
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
519
<label class="md-nav__title" for="__nav_2">
520
<span class="md-nav__icon md-icon"></span>
521
522
523
Getting Started
524
525
526
</label>
527
<ul class="md-nav__list" data-md-scrollfix>
528
529
530
531
532
533
534
535
<li class="md-nav__item">
536
<a href="../../getting-started/installation/" class="md-nav__link">
537
538
539
540
<span class="md-ellipsis">
541
542
543
Installation
544
545
546
547
</span>
548
549
550
551
</a>
552
</li>
553
554
555
556
557
558
559
560
561
562
563
<li class="md-nav__item">
564
<a href="../../getting-started/quickstart/" class="md-nav__link">
565
566
567
568
<span class="md-ellipsis">
569
570
571
Quick Start
572
573
574
575
</span>
576
577
578
579
</a>
580
</li>
581
582
583
584
585
586
587
588
589
590
591
<li class="md-nav__item">
592
<a href="../../getting-started/configuration/" class="md-nav__link">
593
594
595
596
<span class="md-ellipsis">
597
598
599
Configuration
600
601
602
603
</span>
604
605
606
607
</a>
608
</li>
609
610
611
612
613
</ul>
614
</nav>
615
616
</li>
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
642
643
644
645
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
646
647
648
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
649
650
651
652
<span class="md-ellipsis">
653
654
655
User Guide
656
657
658
659
</span>
660
661
662
663
<span class="md-nav__icon md-icon"></span>
664
</label>
665
666
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
667
<label class="md-nav__title" for="__nav_3">
668
<span class="md-nav__icon md-icon"></span>
669
670
671
User Guide
672
673
674
</label>
675
<ul class="md-nav__list" data-md-scrollfix>
676
677
678
679
680
681
682
683
<li class="md-nav__item">
684
<a href="../single-video/" class="md-nav__link">
685
686
687
688
<span class="md-ellipsis">
689
690
691
Single Video Analysis
692
693
694
695
</span>
696
697
698
699
</a>
700
</li>
701
702
703
704
705
706
707
708
709
710
711
<li class="md-nav__item">
712
<a href="../batch/" class="md-nav__link">
713
714
715
716
<span class="md-ellipsis">
717
718
719
Batch Processing
720
721
722
723
</span>
724
725
726
727
</a>
728
</li>
729
730
731
732
733
734
735
736
737
738
739
<li class="md-nav__item">
740
<a href="../document-ingestion/" class="md-nav__link">
741
742
743
744
<span class="md-ellipsis">
745
746
747
Document Ingestion
748
749
750
751
</span>
752
753
754
755
</a>
756
</li>
757
758
759
760
761
762
763
764
765
766
767
<li class="md-nav__item">
768
<a href="../cloud-sources/" class="md-nav__link">
769
770
771
772
<span class="md-ellipsis">
773
774
775
Cloud Sources
776
777
778
779
</span>
780
781
782
783
</a>
784
</li>
785
786
787
788
789
790
791
792
793
794
795
<li class="md-nav__item">
796
<a href="../knowledge-graphs/" class="md-nav__link">
797
798
799
800
<span class="md-ellipsis">
801
802
803
Knowledge Graphs
804
805
806
807
</span>
808
809
810
811
</a>
812
</li>
813
814
815
816
817
818
819
820
821
822
823
824
825
<li class="md-nav__item md-nav__item--active">
826
827
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
828
829
830
831
832
833
<label class="md-nav__link md-nav__link--active" for="__toc">
834
835
836
837
<span class="md-ellipsis">
838
839
840
Interactive Companion
841
842
843
844
</span>
845
846
847
848
<span class="md-nav__icon md-icon"></span>
849
</label>
850
851
<a href="./" class="md-nav__link md-nav__link--active">
852
853
854
855
<span class="md-ellipsis">
856
857
858
Interactive Companion
859
860
861
862
</span>
863
864
865
866
</a>
867
868
869
870
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
871
872
873
874
875
876
877
<label class="md-nav__title" for="__toc">
878
<span class="md-nav__icon md-icon"></span>
879
Table of contents
880
</label>
881
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
882
883
<li class="md-nav__item">
884
<a href="#launching-the-companion" class="md-nav__link">
885
<span class="md-ellipsis">
886
887
Launching the Companion
888
889
</span>
890
</a>
891
892
<nav class="md-nav" aria-label="Launching the Companion">
893
<ul class="md-nav__list">
894
895
<li class="md-nav__item">
896
<a href="#as-a-subcommand" class="md-nav__link">
897
<span class="md-ellipsis">
898
899
As a subcommand
900
901
</span>
902
</a>
903
904
</li>
905
906
<li class="md-nav__item">
907
<a href="#with-the-chat-c-flag" class="md-nav__link">
908
<span class="md-ellipsis">
909
910
With the --chat / -C flag
911
912
</span>
913
</a>
914
915
</li>
916
917
<li class="md-nav__item">
918
<a href="#with-options" class="md-nav__link">
919
<span class="md-ellipsis">
920
921
With options
922
923
</span>
924
</a>
925
926
</li>
927
928
</ul>
929
</nav>
930
931
</li>
932
933
<li class="md-nav__item">
934
<a href="#auto-discovery" class="md-nav__link">
935
<span class="md-ellipsis">
936
937
Auto-discovery
938
939
</span>
940
</a>
941
942
</li>
943
944
<li class="md-nav__item">
945
<a href="#slash-commands" class="md-nav__link">
946
<span class="md-ellipsis">
947
948
Slash Commands
949
950
</span>
951
</a>
952
953
<nav class="md-nav" aria-label="Slash Commands">
954
<ul class="md-nav__list">
955
956
<li class="md-nav__item">
957
<a href="#help" class="md-nav__link">
958
<span class="md-ellipsis">
959
960
/help
961
962
</span>
963
</a>
964
965
</li>
966
967
<li class="md-nav__item">
968
<a href="#status" class="md-nav__link">
969
<span class="md-ellipsis">
970
971
/status
972
973
</span>
974
</a>
975
976
</li>
977
978
<li class="md-nav__item">
979
<a href="#skills" class="md-nav__link">
980
<span class="md-ellipsis">
981
982
/skills
983
984
</span>
985
</a>
986
987
</li>
988
989
<li class="md-nav__item">
990
<a href="#entities-type-type" class="md-nav__link">
991
<span class="md-ellipsis">
992
993
/entities [--type TYPE]
994
995
</span>
996
</a>
997
998
</li>
999
1000
<li class="md-nav__item">
1001
<a href="#search-term" class="md-nav__link">
1002
<span class="md-ellipsis">
1003
1004
/search TERM
1005
1006
</span>
1007
</a>
1008
1009
</li>
1010
1011
<li class="md-nav__item">
1012
<a href="#neighbors-entity" class="md-nav__link">
1013
<span class="md-ellipsis">
1014
1015
/neighbors ENTITY
1016
1017
</span>
1018
</a>
1019
1020
</li>
1021
1022
<li class="md-nav__item">
1023
<a href="#export-format" class="md-nav__link">
1024
<span class="md-ellipsis">
1025
1026
/export FORMAT
1027
1028
</span>
1029
</a>
1030
1031
</li>
1032
1033
<li class="md-nav__item">
1034
<a href="#analyze-path" class="md-nav__link">
1035
<span class="md-ellipsis">
1036
1037
/analyze PATH
1038
1039
</span>
1040
</a>
1041
1042
</li>
1043
1044
<li class="md-nav__item">
1045
<a href="#ingest-path" class="md-nav__link">
1046
<span class="md-ellipsis">
1047
1048
/ingest PATH
1049
1050
</span>
1051
</a>
1052
1053
</li>
1054
1055
<li class="md-nav__item">
1056
<a href="#auth-service" class="md-nav__link">
1057
<span class="md-ellipsis">
1058
1059
/auth [SERVICE]
1060
1061
</span>
1062
</a>
1063
1064
</li>
1065
1066
<li class="md-nav__item">
1067
<a href="#provider-name" class="md-nav__link">
1068
<span class="md-ellipsis">
1069
1070
/provider [NAME]
1071
1072
</span>
1073
</a>
1074
1075
</li>
1076
1077
<li class="md-nav__item">
1078
<a href="#model-name" class="md-nav__link">
1079
<span class="md-ellipsis">
1080
1081
/model [NAME]
1082
1083
</span>
1084
</a>
1085
1086
</li>
1087
1088
<li class="md-nav__item">
1089
<a href="#run-skill" class="md-nav__link">
1090
<span class="md-ellipsis">
1091
1092
/run SKILL
1093
1094
</span>
1095
</a>
1096
1097
</li>
1098
1099
<li class="md-nav__item">
1100
<a href="#plan" class="md-nav__link">
1101
<span class="md-ellipsis">
1102
1103
/plan
1104
1105
</span>
1106
</a>
1107
1108
</li>
1109
1110
<li class="md-nav__item">
1111
<a href="#prd" class="md-nav__link">
1112
<span class="md-ellipsis">
1113
1114
/prd
1115
1116
</span>
1117
</a>
1118
1119
</li>
1120
1121
<li class="md-nav__item">
1122
<a href="#tasks" class="md-nav__link">
1123
<span class="md-ellipsis">
1124
1125
/tasks
1126
1127
</span>
1128
</a>
1129
1130
</li>
1131
1132
<li class="md-nav__item">
1133
<a href="#quit-and-exit" class="md-nav__link">
1134
<span class="md-ellipsis">
1135
1136
/quit and /exit
1137
1138
</span>
1139
</a>
1140
1141
</li>
1142
1143
</ul>
1144
</nav>
1145
1146
</li>
1147
1148
<li class="md-nav__item">
1149
<a href="#exiting-the-companion" class="md-nav__link">
1150
<span class="md-ellipsis">
1151
1152
Exiting the Companion
1153
1154
</span>
1155
</a>
1156
1157
</li>
1158
1159
<li class="md-nav__item">
1160
<a href="#chat-mode" class="md-nav__link">
1161
<span class="md-ellipsis">
1162
1163
Chat Mode
1164
1165
</span>
1166
</a>
1167
1168
</li>
1169
1170
<li class="md-nav__item">
1171
<a href="#runtime-provider-and-model-switching" class="md-nav__link">
1172
<span class="md-ellipsis">
1173
1174
Runtime Provider and Model Switching
1175
1176
</span>
1177
</a>
1178
1179
</li>
1180
1181
<li class="md-nav__item">
1182
<a href="#example-session" class="md-nav__link">
1183
<span class="md-ellipsis">
1184
1185
Example Session
1186
1187
</span>
1188
</a>
1189
1190
</li>
1191
1192
</ul>
1193
1194
</nav>
1195
1196
</li>
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
<li class="md-nav__item">
1208
<a href="../planning-agent/" class="md-nav__link">
1209
1210
1211
1212
<span class="md-ellipsis">
1213
1214
1215
Planning Agent
1216
1217
1218
1219
</span>
1220
1221
1222
1223
</a>
1224
</li>
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
<li class="md-nav__item">
1236
<a href="../authentication/" class="md-nav__link">
1237
1238
1239
1240
<span class="md-ellipsis">
1241
1242
1243
Authentication
1244
1245
1246
1247
</span>
1248
1249
1250
1251
</a>
1252
</li>
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
<li class="md-nav__item">
1264
<a href="../export/" class="md-nav__link">
1265
1266
1267
1268
<span class="md-ellipsis">
1269
1270
1271
Export & Documents
1272
1273
1274
1275
</span>
1276
1277
1278
1279
</a>
1280
</li>
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
<li class="md-nav__item">
1292
<a href="../output-formats/" class="md-nav__link">
1293
1294
1295
1296
<span class="md-ellipsis">
1297
1298
1299
Output Formats
1300
1301
1302
1303
</span>
1304
1305
1306
1307
</a>
1308
</li>
1309
1310
1311
1312
1313
</ul>
1314
</nav>
1315
1316
</li>
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
<li class="md-nav__item">
1327
<a href="../../use-cases/" class="md-nav__link">
1328
1329
1330
1331
<span class="md-ellipsis">
1332
1333
1334
Use Cases
1335
1336
1337
1338
</span>
1339
1340
1341
1342
</a>
1343
</li>
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
<li class="md-nav__item">
1354
<a href="../../cli-reference/" class="md-nav__link">
1355
1356
1357
1358
<span class="md-ellipsis">
1359
1360
1361
CLI Reference
1362
1363
1364
1365
</span>
1366
1367
1368
1369
</a>
1370
</li>
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
<li class="md-nav__item md-nav__item--nested">
1391
1392
1393
1394
1395
1396
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
1397
1398
1399
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
1400
1401
1402
1403
<span class="md-ellipsis">
1404
1405
1406
Architecture
1407
1408
1409
1410
</span>
1411
1412
1413
1414
<span class="md-nav__icon md-icon"></span>
1415
</label>
1416
1417
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
1418
<label class="md-nav__title" for="__nav_6">
1419
<span class="md-nav__icon md-icon"></span>
1420
1421
1422
Architecture
1423
1424
1425
</label>
1426
<ul class="md-nav__list" data-md-scrollfix>
1427
1428
1429
1430
1431
1432
1433
1434
<li class="md-nav__item">
1435
<a href="../../architecture/overview/" class="md-nav__link">
1436
1437
1438
1439
<span class="md-ellipsis">
1440
1441
1442
Overview
1443
1444
1445
1446
</span>
1447
1448
1449
1450
</a>
1451
</li>
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
<li class="md-nav__item">
1463
<a href="../../architecture/providers/" class="md-nav__link">
1464
1465
1466
1467
<span class="md-ellipsis">
1468
1469
1470
Provider System
1471
1472
1473
1474
</span>
1475
1476
1477
1478
</a>
1479
</li>
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
<li class="md-nav__item">
1491
<a href="../../architecture/pipeline/" class="md-nav__link">
1492
1493
1494
1495
<span class="md-ellipsis">
1496
1497
1498
Processing Pipeline
1499
1500
1501
1502
</span>
1503
1504
1505
1506
</a>
1507
</li>
1508
1509
1510
1511
1512
</ul>
1513
</nav>
1514
1515
</li>
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
<li class="md-nav__item md-nav__item--nested">
1536
1537
1538
1539
1540
1541
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
1542
1543
1544
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
1545
1546
1547
1548
<span class="md-ellipsis">
1549
1550
1551
API Reference
1552
1553
1554
1555
</span>
1556
1557
1558
1559
<span class="md-nav__icon md-icon"></span>
1560
</label>
1561
1562
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
1563
<label class="md-nav__title" for="__nav_7">
1564
<span class="md-nav__icon md-icon"></span>
1565
1566
1567
API Reference
1568
1569
1570
</label>
1571
<ul class="md-nav__list" data-md-scrollfix>
1572
1573
1574
1575
1576
1577
1578
1579
<li class="md-nav__item">
1580
<a href="../../api/models/" class="md-nav__link">
1581
1582
1583
1584
<span class="md-ellipsis">
1585
1586
1587
Models
1588
1589
1590
1591
</span>
1592
1593
1594
1595
</a>
1596
</li>
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
<li class="md-nav__item">
1608
<a href="../../api/providers/" class="md-nav__link">
1609
1610
1611
1612
<span class="md-ellipsis">
1613
1614
1615
Providers
1616
1617
1618
1619
</span>
1620
1621
1622
1623
</a>
1624
</li>
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
<li class="md-nav__item">
1636
<a href="../../api/analyzers/" class="md-nav__link">
1637
1638
1639
1640
<span class="md-ellipsis">
1641
1642
1643
Analyzers
1644
1645
1646
1647
</span>
1648
1649
1650
1651
</a>
1652
</li>
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
<li class="md-nav__item">
1664
<a href="../../api/agent/" class="md-nav__link">
1665
1666
1667
1668
<span class="md-ellipsis">
1669
1670
1671
Agent & Skills
1672
1673
1674
1675
</span>
1676
1677
1678
1679
</a>
1680
</li>
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
<li class="md-nav__item">
1692
<a href="../../api/sources/" class="md-nav__link">
1693
1694
1695
1696
<span class="md-ellipsis">
1697
1698
1699
Sources
1700
1701
1702
1703
</span>
1704
1705
1706
1707
</a>
1708
</li>
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
<li class="md-nav__item">
1720
<a href="../../api/auth/" class="md-nav__link">
1721
1722
1723
1724
<span class="md-ellipsis">
1725
1726
1727
Authentication
1728
1729
1730
1731
</span>
1732
1733
1734
1735
</a>
1736
</li>
1737
1738
1739
1740
1741
</ul>
1742
</nav>
1743
1744
</li>
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
<li class="md-nav__item">
1755
<a href="../../faq/" class="md-nav__link">
1756
1757
1758
1759
<span class="md-ellipsis">
1760
1761
1762
FAQ & Troubleshooting
1763
1764
1765
1766
</span>
1767
1768
1769
1770
</a>
1771
</li>
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
<li class="md-nav__item">
1782
<a href="../../contributing/" class="md-nav__link">
1783
1784
1785
1786
<span class="md-ellipsis">
1787
1788
1789
Contributing
1790
1791
1792
1793
</span>
1794
1795
1796
1797
</a>
1798
</li>
1799
1800
1801
1802
</ul>
1803
</nav>
1804
</div>
1805
</div>
1806
</div>
1807
1808
1809
1810
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1811
<div class="md-sidebar__scrollwrap">
1812
<div class="md-sidebar__inner">
1813
1814
1815
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1816
1817
1818
1819
1820
1821
1822
<label class="md-nav__title" for="__toc">
1823
<span class="md-nav__icon md-icon"></span>
1824
Table of contents
1825
</label>
1826
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1827
1828
<li class="md-nav__item">
1829
<a href="#launching-the-companion" class="md-nav__link">
1830
<span class="md-ellipsis">
1831
1832
Launching the Companion
1833
1834
</span>
1835
</a>
1836
1837
<nav class="md-nav" aria-label="Launching the Companion">
1838
<ul class="md-nav__list">
1839
1840
<li class="md-nav__item">
1841
<a href="#as-a-subcommand" class="md-nav__link">
1842
<span class="md-ellipsis">
1843
1844
As a subcommand
1845
1846
</span>
1847
</a>
1848
1849
</li>
1850
1851
<li class="md-nav__item">
1852
<a href="#with-the-chat-c-flag" class="md-nav__link">
1853
<span class="md-ellipsis">
1854
1855
With the --chat / -C flag
1856
1857
</span>
1858
</a>
1859
1860
</li>
1861
1862
<li class="md-nav__item">
1863
<a href="#with-options" class="md-nav__link">
1864
<span class="md-ellipsis">
1865
1866
With options
1867
1868
</span>
1869
</a>
1870
1871
</li>
1872
1873
</ul>
1874
</nav>
1875
1876
</li>
1877
1878
<li class="md-nav__item">
1879
<a href="#auto-discovery" class="md-nav__link">
1880
<span class="md-ellipsis">
1881
1882
Auto-discovery
1883
1884
</span>
1885
</a>
1886
1887
</li>
1888
1889
<li class="md-nav__item">
1890
<a href="#slash-commands" class="md-nav__link">
1891
<span class="md-ellipsis">
1892
1893
Slash Commands
1894
1895
</span>
1896
</a>
1897
1898
<nav class="md-nav" aria-label="Slash Commands">
1899
<ul class="md-nav__list">
1900
1901
<li class="md-nav__item">
1902
<a href="#help" class="md-nav__link">
1903
<span class="md-ellipsis">
1904
1905
/help
1906
1907
</span>
1908
</a>
1909
1910
</li>
1911
1912
<li class="md-nav__item">
1913
<a href="#status" class="md-nav__link">
1914
<span class="md-ellipsis">
1915
1916
/status
1917
1918
</span>
1919
</a>
1920
1921
</li>
1922
1923
<li class="md-nav__item">
1924
<a href="#skills" class="md-nav__link">
1925
<span class="md-ellipsis">
1926
1927
/skills
1928
1929
</span>
1930
</a>
1931
1932
</li>
1933
1934
<li class="md-nav__item">
1935
<a href="#entities-type-type" class="md-nav__link">
1936
<span class="md-ellipsis">
1937
1938
/entities [--type TYPE]
1939
1940
</span>
1941
</a>
1942
1943
</li>
1944
1945
<li class="md-nav__item">
1946
<a href="#search-term" class="md-nav__link">
1947
<span class="md-ellipsis">
1948
1949
/search TERM
1950
1951
</span>
1952
</a>
1953
1954
</li>
1955
1956
<li class="md-nav__item">
1957
<a href="#neighbors-entity" class="md-nav__link">
1958
<span class="md-ellipsis">
1959
1960
/neighbors ENTITY
1961
1962
</span>
1963
</a>
1964
1965
</li>
1966
1967
<li class="md-nav__item">
1968
<a href="#export-format" class="md-nav__link">
1969
<span class="md-ellipsis">
1970
1971
/export FORMAT
1972
1973
</span>
1974
</a>
1975
1976
</li>
1977
1978
<li class="md-nav__item">
1979
<a href="#analyze-path" class="md-nav__link">
1980
<span class="md-ellipsis">
1981
1982
/analyze PATH
1983
1984
</span>
1985
</a>
1986
1987
</li>
1988
1989
<li class="md-nav__item">
1990
<a href="#ingest-path" class="md-nav__link">
1991
<span class="md-ellipsis">
1992
1993
/ingest PATH
1994
1995
</span>
1996
</a>
1997
1998
</li>
1999
2000
<li class="md-nav__item">
2001
<a href="#auth-service" class="md-nav__link">
2002
<span class="md-ellipsis">
2003
2004
/auth [SERVICE]
2005
2006
</span>
2007
</a>
2008
2009
</li>
2010
2011
<li class="md-nav__item">
2012
<a href="#provider-name" class="md-nav__link">
2013
<span class="md-ellipsis">
2014
2015
/provider [NAME]
2016
2017
</span>
2018
</a>
2019
2020
</li>
2021
2022
<li class="md-nav__item">
2023
<a href="#model-name" class="md-nav__link">
2024
<span class="md-ellipsis">
2025
2026
/model [NAME]
2027
2028
</span>
2029
</a>
2030
2031
</li>
2032
2033
<li class="md-nav__item">
2034
<a href="#run-skill" class="md-nav__link">
2035
<span class="md-ellipsis">
2036
2037
/run SKILL
2038
2039
</span>
2040
</a>
2041
2042
</li>
2043
2044
<li class="md-nav__item">
2045
<a href="#plan" class="md-nav__link">
2046
<span class="md-ellipsis">
2047
2048
/plan
2049
2050
</span>
2051
</a>
2052
2053
</li>
2054
2055
<li class="md-nav__item">
2056
<a href="#prd" class="md-nav__link">
2057
<span class="md-ellipsis">
2058
2059
/prd
2060
2061
</span>
2062
</a>
2063
2064
</li>
2065
2066
<li class="md-nav__item">
2067
<a href="#tasks" class="md-nav__link">
2068
<span class="md-ellipsis">
2069
2070
/tasks
2071
2072
</span>
2073
</a>
2074
2075
</li>
2076
2077
<li class="md-nav__item">
2078
<a href="#quit-and-exit" class="md-nav__link">
2079
<span class="md-ellipsis">
2080
2081
/quit and /exit
2082
2083
</span>
2084
</a>
2085
2086
</li>
2087
2088
</ul>
2089
</nav>
2090
2091
</li>
2092
2093
<li class="md-nav__item">
2094
<a href="#exiting-the-companion" class="md-nav__link">
2095
<span class="md-ellipsis">
2096
2097
Exiting the Companion
2098
2099
</span>
2100
</a>
2101
2102
</li>
2103
2104
<li class="md-nav__item">
2105
<a href="#chat-mode" class="md-nav__link">
2106
<span class="md-ellipsis">
2107
2108
Chat Mode
2109
2110
</span>
2111
</a>
2112
2113
</li>
2114
2115
<li class="md-nav__item">
2116
<a href="#runtime-provider-and-model-switching" class="md-nav__link">
2117
<span class="md-ellipsis">
2118
2119
Runtime Provider and Model Switching
2120
2121
</span>
2122
</a>
2123
2124
</li>
2125
2126
<li class="md-nav__item">
2127
<a href="#example-session" class="md-nav__link">
2128
<span class="md-ellipsis">
2129
2130
Example Session
2131
2132
</span>
2133
</a>
2134
2135
</li>
2136
2137
</ul>
2138
2139
</nav>
2140
</div>
2141
</div>
2142
</div>
2143
2144
2145
2146
<div class="md-content" data-md-component="content">
2147
2148
<article class="md-content__inner md-typeset">
2149
2150
2151
2152
2153
2154
2155
2156
2157
<h1 id="interactive-companion-repl">Interactive Companion REPL<a class="headerlink" href="#interactive-companion-repl" title="Permanent link">&para;</a></h1>
2158
<p>The PlanOpticon Companion is an interactive Read-Eval-Print Loop (REPL) that provides a conversational interface to PlanOpticon's full feature set. It combines workspace awareness, knowledge graph querying, LLM-powered chat, and planning agent skills into a single session.</p>
2159
<p>Use the Companion when you want to explore a knowledge graph interactively, ask natural-language questions about extracted content, generate planning artifacts on the fly, or switch between providers and models without restarting.</p>
2160
<hr />
2161
<h2 id="launching-the-companion">Launching the Companion<a class="headerlink" href="#launching-the-companion" title="Permanent link">&para;</a></h2>
2162
<p>There are three equivalent ways to start the Companion.</p>
2163
<h3 id="as-a-subcommand">As a subcommand<a class="headerlink" href="#as-a-subcommand" title="Permanent link">&para;</a></h3>
2164
<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>companion
2165
</code></pre></div>
2166
<h3 id="with-the-chat-c-flag">With the <code>--chat</code> / <code>-C</code> flag<a class="headerlink" href="#with-the-chat-c-flag" title="Permanent link">&para;</a></h3>
2167
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>planopticon<span class="w"> </span>--chat
2168
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>planopticon<span class="w"> </span>-C
2169
</code></pre></div>
2170
<p>These flags launch the Companion directly from the top-level CLI, without invoking a subcommand.</p>
2171
<h3 id="with-options">With options<a class="headerlink" href="#with-options" title="Permanent link">&para;</a></h3>
2172
<p>The <code>companion</code> subcommand accepts options for specifying knowledge base paths, LLM provider, and model:</p>
2173
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="c1"># Point at a specific knowledge base</span>
2174
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>planopticon<span class="w"> </span>companion<span class="w"> </span>--kb<span class="w"> </span>./results
2175
<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a>
2176
<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a><span class="c1"># Use a specific provider</span>
2177
<a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a>planopticon<span class="w"> </span>companion<span class="w"> </span>-p<span class="w"> </span>anthropic
2178
<a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a>
2179
<a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a><span class="c1"># Use a specific model</span>
2180
<a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a>planopticon<span class="w"> </span>companion<span class="w"> </span>--chat-model<span class="w"> </span>gpt-4o
2181
<a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a>
2182
<a id="__codelineno-2-10" name="__codelineno-2-10" href="#__codelineno-2-10"></a><span class="c1"># Combine options</span>
2183
<a id="__codelineno-2-11" name="__codelineno-2-11" href="#__codelineno-2-11"></a>planopticon<span class="w"> </span>companion<span class="w"> </span>--kb<span class="w"> </span>./results<span class="w"> </span>-p<span class="w"> </span>openai<span class="w"> </span>--chat-model<span class="w"> </span>gpt-4o
2184
</code></pre></div>
2185
<table>
2186
<thead>
2187
<tr>
2188
<th>Option</th>
2189
<th>Description</th>
2190
</tr>
2191
</thead>
2192
<tbody>
2193
<tr>
2194
<td><code>--kb PATH</code></td>
2195
<td>Path to a knowledge graph file or directory (repeatable)</td>
2196
</tr>
2197
<tr>
2198
<td><code>-p, --provider NAME</code></td>
2199
<td>LLM provider: <code>auto</code>, <code>openai</code>, <code>anthropic</code>, <code>gemini</code>, <code>ollama</code>, <code>azure</code>, <code>together</code>, <code>fireworks</code>, <code>cerebras</code>, <code>xai</code></td>
2200
</tr>
2201
<tr>
2202
<td><code>--chat-model NAME</code></td>
2203
<td>Override the default chat model for the selected provider</td>
2204
</tr>
2205
</tbody>
2206
</table>
2207
<hr />
2208
<h2 id="auto-discovery">Auto-discovery<a class="headerlink" href="#auto-discovery" title="Permanent link">&para;</a></h2>
2209
<p>On startup, the Companion automatically scans the workspace for relevant files:</p>
2210
<p><strong>Knowledge graphs.</strong> The Companion uses <code>find_nearest_graph()</code> to locate the closest <code>knowledge_graph.db</code> or <code>knowledge_graph.json</code> file. It searches the current directory, common output subdirectories (<code>results/</code>, <code>output/</code>, <code>knowledge-base/</code>), recursively downward (up to 4 levels), and upward through parent directories. SQLite <code>.db</code> files are preferred over <code>.json</code> files.</p>
2211
<p><strong>Videos.</strong> The current directory is scanned for files with <code>.mp4</code>, <code>.mkv</code>, and <code>.webm</code> extensions.</p>
2212
<p><strong>Documents.</strong> The current directory is scanned for files with <code>.md</code>, <code>.pdf</code>, and <code>.docx</code> extensions.</p>
2213
<p><strong>LLM provider.</strong> If <code>--provider</code> is set to <code>auto</code> (the default), the Companion attempts to initialise a provider using any available API key in the environment (<code>OPENAI_API_KEY</code>, <code>ANTHROPIC_API_KEY</code>, <code>GEMINI_API_KEY</code>, etc.).</p>
2214
<p>All discovered context is displayed in the welcome banner:</p>
2215
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a> PlanOpticon Companion
2216
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a> Interactive planning REPL
2217
<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a>
2218
<a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a> Knowledge graph: knowledge_graph.db (42 entities, 87 relationships)
2219
<a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-5"></a> Videos: meeting-2024-01-15.mp4, sprint-review.mp4
2220
<a id="__codelineno-3-6" name="__codelineno-3-6" href="#__codelineno-3-6"></a> Docs: requirements.md, architecture.pdf
2221
<a id="__codelineno-3-7" name="__codelineno-3-7" href="#__codelineno-3-7"></a> LLM provider: openai (model: gpt-4o)
2222
<a id="__codelineno-3-8" name="__codelineno-3-8" href="#__codelineno-3-8"></a>
2223
<a id="__codelineno-3-9" name="__codelineno-3-9" href="#__codelineno-3-9"></a> Type /help for commands, or ask a question.
2224
</code></pre></div>
2225
<p>If no knowledge graph is found, the banner shows "No knowledge graph loaded." Commands that require a KG will return an appropriate message rather than failing silently.</p>
2226
<hr />
2227
<h2 id="slash-commands">Slash Commands<a class="headerlink" href="#slash-commands" title="Permanent link">&para;</a></h2>
2228
<p>The Companion supports 18 slash commands. Type <code>/help</code> at the prompt to see the full list.</p>
2229
<h3 id="help">/help<a class="headerlink" href="#help" title="Permanent link">&para;</a></h3>
2230
<p>Display all available commands with brief descriptions.</p>
2231
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>planopticon&gt; /help
2232
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>Available commands:
2233
<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a> /help Show this help
2234
<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a> /status Workspace status
2235
<a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a> /skills List available skills
2236
<a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a> /entities [--type T] List KG entities
2237
<a id="__codelineno-4-7" name="__codelineno-4-7" href="#__codelineno-4-7"></a> /search TERM Search entities by name
2238
<a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a> /neighbors ENTITY Show entity relationships
2239
<a id="__codelineno-4-9" name="__codelineno-4-9" href="#__codelineno-4-9"></a> /export FORMAT Export KG (markdown, obsidian, notion, csv)
2240
<a id="__codelineno-4-10" name="__codelineno-4-10" href="#__codelineno-4-10"></a> /analyze PATH Analyze a video/doc
2241
<a id="__codelineno-4-11" name="__codelineno-4-11" href="#__codelineno-4-11"></a> /ingest PATH Ingest a file into the KG
2242
<a id="__codelineno-4-12" name="__codelineno-4-12" href="#__codelineno-4-12"></a> /auth SERVICE Authenticate with a cloud service
2243
<a id="__codelineno-4-13" name="__codelineno-4-13" href="#__codelineno-4-13"></a> /provider [NAME] List or switch LLM provider
2244
<a id="__codelineno-4-14" name="__codelineno-4-14" href="#__codelineno-4-14"></a> /model [NAME] Show or switch chat model
2245
<a id="__codelineno-4-15" name="__codelineno-4-15" href="#__codelineno-4-15"></a> /run SKILL Run a skill by name
2246
<a id="__codelineno-4-16" name="__codelineno-4-16" href="#__codelineno-4-16"></a> /plan Run project_plan skill
2247
<a id="__codelineno-4-17" name="__codelineno-4-17" href="#__codelineno-4-17"></a> /prd Run PRD skill
2248
<a id="__codelineno-4-18" name="__codelineno-4-18" href="#__codelineno-4-18"></a> /tasks Run task_breakdown skill
2249
<a id="__codelineno-4-19" name="__codelineno-4-19" href="#__codelineno-4-19"></a> /quit, /exit Exit companion
2250
<a id="__codelineno-4-20" name="__codelineno-4-20" href="#__codelineno-4-20"></a>
2251
<a id="__codelineno-4-21" name="__codelineno-4-21" href="#__codelineno-4-21"></a>Any other input is sent to the chat agent (requires LLM).
2252
</code></pre></div>
2253
<h3 id="status">/status<a class="headerlink" href="#status" title="Permanent link">&para;</a></h3>
2254
<p>Show a summary of the current workspace state: loaded knowledge graph (with entity and relationship counts, broken down by entity type), number of discovered videos and documents, and whether an LLM provider is active.</p>
2255
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>planopticon&gt; /status
2256
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a>Workspace status:
2257
<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a> KG: /home/user/project/results/knowledge_graph.db (42 entities, 87 relationships)
2258
<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a> technology: 15
2259
<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a> person: 12
2260
<a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a> concept: 10
2261
<a id="__codelineno-5-7" name="__codelineno-5-7" href="#__codelineno-5-7"></a> organization: 5
2262
<a id="__codelineno-5-8" name="__codelineno-5-8" href="#__codelineno-5-8"></a> Videos: 2 found
2263
<a id="__codelineno-5-9" name="__codelineno-5-9" href="#__codelineno-5-9"></a> Docs: 3 found
2264
<a id="__codelineno-5-10" name="__codelineno-5-10" href="#__codelineno-5-10"></a> Provider: active
2265
</code></pre></div>
2266
<h3 id="skills">/skills<a class="headerlink" href="#skills" title="Permanent link">&para;</a></h3>
2267
<p>List all registered planning agent skills with their names and descriptions. These are the skills that can be invoked via <code>/run</code>.</p>
2268
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>planopticon&gt; /skills
2269
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a>Available skills:
2270
<a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a> project_plan: Generate a structured project plan from knowledge graph
2271
<a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a> prd: Generate a product requirements document (PRD) / feature spec
2272
<a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a> roadmap: Generate a product/project roadmap
2273
<a id="__codelineno-6-6" name="__codelineno-6-6" href="#__codelineno-6-6"></a> task_breakdown: Break down goals into tasks with dependencies
2274
<a id="__codelineno-6-7" name="__codelineno-6-7" href="#__codelineno-6-7"></a> github_issues: Generate GitHub issues from task breakdown
2275
<a id="__codelineno-6-8" name="__codelineno-6-8" href="#__codelineno-6-8"></a> requirements_chat: Interactive requirements gathering via guided questions
2276
<a id="__codelineno-6-9" name="__codelineno-6-9" href="#__codelineno-6-9"></a> doc_generator: Generate technical documentation, ADRs, or meeting notes
2277
<a id="__codelineno-6-10" name="__codelineno-6-10" href="#__codelineno-6-10"></a> artifact_export: Export artifacts in agent-ready formats
2278
<a id="__codelineno-6-11" name="__codelineno-6-11" href="#__codelineno-6-11"></a> cli_adapter: Push artifacts to external tools via their CLIs
2279
<a id="__codelineno-6-12" name="__codelineno-6-12" href="#__codelineno-6-12"></a> notes_export: Export knowledge graph as structured notes (Obsidian, Notion)
2280
<a id="__codelineno-6-13" name="__codelineno-6-13" href="#__codelineno-6-13"></a> wiki_generator: Generate a GitHub wiki from knowledge graph and artifacts
2281
</code></pre></div>
2282
<h3 id="entities-type-type">/entities [--type TYPE]<a class="headerlink" href="#entities-type-type" title="Permanent link">&para;</a></h3>
2283
<p>List entities from the loaded knowledge graph. Optionally filter by entity type.</p>
2284
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>planopticon&gt; /entities
2285
<a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a>Found 42 entities
2286
<a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a> [technology] Python -- General-purpose programming language
2287
<a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a> [person] Alice -- Lead engineer on the project
2288
<a id="__codelineno-7-5" name="__codelineno-7-5" href="#__codelineno-7-5"></a> [concept] Microservices -- Architectural pattern discussed
2289
<a id="__codelineno-7-6" name="__codelineno-7-6" href="#__codelineno-7-6"></a> ...
2290
<a id="__codelineno-7-7" name="__codelineno-7-7" href="#__codelineno-7-7"></a>
2291
<a id="__codelineno-7-8" name="__codelineno-7-8" href="#__codelineno-7-8"></a>planopticon&gt; /entities --type person
2292
<a id="__codelineno-7-9" name="__codelineno-7-9" href="#__codelineno-7-9"></a>Found 12 entities
2293
<a id="__codelineno-7-10" name="__codelineno-7-10" href="#__codelineno-7-10"></a> [person] Alice -- Lead engineer on the project
2294
<a id="__codelineno-7-11" name="__codelineno-7-11" href="#__codelineno-7-11"></a> [person] Bob -- Product manager
2295
<a id="__codelineno-7-12" name="__codelineno-7-12" href="#__codelineno-7-12"></a> ...
2296
</code></pre></div>
2297
<div class="admonition note">
2298
<p class="admonition-title">Note</p>
2299
<p>This command requires a loaded knowledge graph. If none is loaded, it returns "No knowledge graph loaded."</p>
2300
</div>
2301
<h3 id="search-term">/search TERM<a class="headerlink" href="#search-term" title="Permanent link">&para;</a></h3>
2302
<p>Search entities by name substring (case-insensitive).</p>
2303
<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>planopticon&gt; /search python
2304
<a id="__codelineno-8-2" name="__codelineno-8-2" href="#__codelineno-8-2"></a>Found 3 entities
2305
<a id="__codelineno-8-3" name="__codelineno-8-3" href="#__codelineno-8-3"></a> [technology] Python -- General-purpose programming language
2306
<a id="__codelineno-8-4" name="__codelineno-8-4" href="#__codelineno-8-4"></a> [technology] Python Flask -- Web framework for Python
2307
<a id="__codelineno-8-5" name="__codelineno-8-5" href="#__codelineno-8-5"></a> [concept] Python packaging -- Discussion of pip and packaging tools
2308
</code></pre></div>
2309
<h3 id="neighbors-entity">/neighbors ENTITY<a class="headerlink" href="#neighbors-entity" title="Permanent link">&para;</a></h3>
2310
<p>Show all entities and relationships connected to a given entity. This performs a breadth-first traversal (depth 1) from the named entity.</p>
2311
<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>planopticon&gt; /neighbors Alice
2312
<a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a>Found 4 entities and 5 relationships
2313
<a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a> [person] Alice -- Lead engineer on the project
2314
<a id="__codelineno-9-4" name="__codelineno-9-4" href="#__codelineno-9-4"></a> [technology] Python -- General-purpose programming language
2315
<a id="__codelineno-9-5" name="__codelineno-9-5" href="#__codelineno-9-5"></a> [organization] Acme Corp -- Employer
2316
<a id="__codelineno-9-6" name="__codelineno-9-6" href="#__codelineno-9-6"></a> [concept] Authentication -- Auth system design
2317
<a id="__codelineno-9-7" name="__codelineno-9-7" href="#__codelineno-9-7"></a> Alice --[works_with]--&gt; Python
2318
<a id="__codelineno-9-8" name="__codelineno-9-8" href="#__codelineno-9-8"></a> Alice --[employed_by]--&gt; Acme Corp
2319
<a id="__codelineno-9-9" name="__codelineno-9-9" href="#__codelineno-9-9"></a> Alice --[proposed]--&gt; Authentication
2320
<a id="__codelineno-9-10" name="__codelineno-9-10" href="#__codelineno-9-10"></a> Bob --[collaborates_with]--&gt; Alice
2321
<a id="__codelineno-9-11" name="__codelineno-9-11" href="#__codelineno-9-11"></a> Authentication --[discussed_by]--&gt; Alice
2322
</code></pre></div>
2323
<h3 id="export-format">/export FORMAT<a class="headerlink" href="#export-format" title="Permanent link">&para;</a></h3>
2324
<p>Request an export of the knowledge graph. Supported formats: <code>markdown</code>, <code>obsidian</code>, <code>notion</code>, <code>csv</code>. This command prints the equivalent CLI command to run.</p>
2325
<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a>planopticon&gt; /export obsidian
2326
<a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a>Export &#39;obsidian&#39; requested. Use the CLI command:
2327
<a id="__codelineno-10-3" name="__codelineno-10-3" href="#__codelineno-10-3"></a> planopticon export obsidian /home/user/project/results/knowledge_graph.db
2328
</code></pre></div>
2329
<h3 id="analyze-path">/analyze PATH<a class="headerlink" href="#analyze-path" title="Permanent link">&para;</a></h3>
2330
<p>Request analysis of a video or document file. Validates the file exists and prints the equivalent CLI command.</p>
2331
<div class="highlight"><pre><span></span><code><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a>planopticon&gt; /analyze meeting.mp4
2332
<a id="__codelineno-11-2" name="__codelineno-11-2" href="#__codelineno-11-2"></a>Analyze requested for meeting.mp4. Use the CLI:
2333
<a id="__codelineno-11-3" name="__codelineno-11-3" href="#__codelineno-11-3"></a> planopticon analyze -i /home/user/project/meeting.mp4
2334
</code></pre></div>
2335
<h3 id="ingest-path">/ingest PATH<a class="headerlink" href="#ingest-path" title="Permanent link">&para;</a></h3>
2336
<p>Request ingestion of a file into the knowledge graph. Validates the file exists and prints the equivalent CLI command.</p>
2337
<div class="highlight"><pre><span></span><code><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a>planopticon&gt; /ingest notes.md
2338
<a id="__codelineno-12-2" name="__codelineno-12-2" href="#__codelineno-12-2"></a>Ingest requested for notes.md. Use the CLI:
2339
<a id="__codelineno-12-3" name="__codelineno-12-3" href="#__codelineno-12-3"></a> planopticon ingest /home/user/project/notes.md
2340
</code></pre></div>
2341
<h3 id="auth-service">/auth [SERVICE]<a class="headerlink" href="#auth-service" title="Permanent link">&para;</a></h3>
2342
<p>Authenticate with a cloud service. When called without arguments, lists all available services. When called with a service name, triggers the authentication flow.</p>
2343
<div class="highlight"><pre><span></span><code><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a>planopticon&gt; /auth
2344
<a id="__codelineno-13-2" name="__codelineno-13-2" href="#__codelineno-13-2"></a>Usage: /auth SERVICE
2345
<a id="__codelineno-13-3" name="__codelineno-13-3" href="#__codelineno-13-3"></a>Available: dropbox, github, google, microsoft, notion, zoom
2346
<a id="__codelineno-13-4" name="__codelineno-13-4" href="#__codelineno-13-4"></a>
2347
<a id="__codelineno-13-5" name="__codelineno-13-5" href="#__codelineno-13-5"></a>planopticon&gt; /auth zoom
2348
<a id="__codelineno-13-6" name="__codelineno-13-6" href="#__codelineno-13-6"></a>Zoom authenticated (oauth)
2349
</code></pre></div>
2350
<h3 id="provider-name">/provider [NAME]<a class="headerlink" href="#provider-name" title="Permanent link">&para;</a></h3>
2351
<p>List available LLM providers and their status, or switch to a different provider.</p>
2352
<p>When called without arguments (or with <code>list</code>), shows all known providers with their availability status:</p>
2353
<ul>
2354
<li><strong>ready</strong> -- API key found in environment</li>
2355
<li><strong>local</strong> -- runs locally (Ollama)</li>
2356
<li><strong>no key</strong> -- no API key configured</li>
2357
</ul>
2358
<p>The currently active provider is marked.</p>
2359
<div class="highlight"><pre><span></span><code><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a>planopticon&gt; /provider
2360
<a id="__codelineno-14-2" name="__codelineno-14-2" href="#__codelineno-14-2"></a>Available providers:
2361
<a id="__codelineno-14-3" name="__codelineno-14-3" href="#__codelineno-14-3"></a> openai: ready (active)
2362
<a id="__codelineno-14-4" name="__codelineno-14-4" href="#__codelineno-14-4"></a> anthropic: ready
2363
<a id="__codelineno-14-5" name="__codelineno-14-5" href="#__codelineno-14-5"></a> gemini: no key
2364
<a id="__codelineno-14-6" name="__codelineno-14-6" href="#__codelineno-14-6"></a> ollama: local
2365
<a id="__codelineno-14-7" name="__codelineno-14-7" href="#__codelineno-14-7"></a> azure: no key
2366
<a id="__codelineno-14-8" name="__codelineno-14-8" href="#__codelineno-14-8"></a> together: no key
2367
<a id="__codelineno-14-9" name="__codelineno-14-9" href="#__codelineno-14-9"></a> fireworks: no key
2368
<a id="__codelineno-14-10" name="__codelineno-14-10" href="#__codelineno-14-10"></a> cerebras: no key
2369
<a id="__codelineno-14-11" name="__codelineno-14-11" href="#__codelineno-14-11"></a> xai: no key
2370
<a id="__codelineno-14-12" name="__codelineno-14-12" href="#__codelineno-14-12"></a>
2371
<a id="__codelineno-14-13" name="__codelineno-14-13" href="#__codelineno-14-13"></a>Current: openai
2372
</code></pre></div>
2373
<p>To switch providers at runtime:</p>
2374
<div class="highlight"><pre><span></span><code><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a>planopticon&gt; /provider anthropic
2375
<a id="__codelineno-15-2" name="__codelineno-15-2" href="#__codelineno-15-2"></a>Switched to provider: anthropic
2376
</code></pre></div>
2377
<p>Switching the provider reinitialises the provider manager and the planning agent. The chat model is reset to the provider's default. If initialisation fails, an error message is shown.</p>
2378
<h3 id="model-name">/model [NAME]<a class="headerlink" href="#model-name" title="Permanent link">&para;</a></h3>
2379
<p>Show the current chat model, or switch to a different one.</p>
2380
<div class="highlight"><pre><span></span><code><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a>planopticon&gt; /model
2381
<a id="__codelineno-16-2" name="__codelineno-16-2" href="#__codelineno-16-2"></a>Current model: default
2382
<a id="__codelineno-16-3" name="__codelineno-16-3" href="#__codelineno-16-3"></a>Usage: /model MODEL_NAME
2383
<a id="__codelineno-16-4" name="__codelineno-16-4" href="#__codelineno-16-4"></a>
2384
<a id="__codelineno-16-5" name="__codelineno-16-5" href="#__codelineno-16-5"></a>planopticon&gt; /model claude-sonnet-4-20250514
2385
<a id="__codelineno-16-6" name="__codelineno-16-6" href="#__codelineno-16-6"></a>Switched to model: claude-sonnet-4-20250514
2386
</code></pre></div>
2387
<p>Switching the model reinitialises both the provider manager and the planning agent.</p>
2388
<h3 id="run-skill">/run SKILL<a class="headerlink" href="#run-skill" title="Permanent link">&para;</a></h3>
2389
<p>Run any registered skill by name. The skill receives the current agent context (knowledge graph, query engine, provider, and any previously generated artifacts) and returns an artifact.</p>
2390
<div class="highlight"><pre><span></span><code><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a>planopticon&gt; /run roadmap
2391
<a id="__codelineno-17-2" name="__codelineno-17-2" href="#__codelineno-17-2"></a>--- Roadmap (roadmap) ---
2392
<a id="__codelineno-17-3" name="__codelineno-17-3" href="#__codelineno-17-3"></a># Roadmap
2393
<a id="__codelineno-17-4" name="__codelineno-17-4" href="#__codelineno-17-4"></a>
2394
<a id="__codelineno-17-5" name="__codelineno-17-5" href="#__codelineno-17-5"></a>## Vision &amp; Strategy
2395
<a id="__codelineno-17-6" name="__codelineno-17-6" href="#__codelineno-17-6"></a>...
2396
</code></pre></div>
2397
<p>If the skill cannot execute (missing KG or provider), an error message is returned. Use <code>/skills</code> to see all available skill names.</p>
2398
<h3 id="plan">/plan<a class="headerlink" href="#plan" title="Permanent link">&para;</a></h3>
2399
<p>Shortcut for <code>/run project_plan</code>. Generates a structured project plan from the loaded knowledge graph.</p>
2400
<div class="highlight"><pre><span></span><code><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a>planopticon&gt; /plan
2401
<a id="__codelineno-18-2" name="__codelineno-18-2" href="#__codelineno-18-2"></a>--- Project Plan (project_plan) ---
2402
<a id="__codelineno-18-3" name="__codelineno-18-3" href="#__codelineno-18-3"></a># Project Plan
2403
<a id="__codelineno-18-4" name="__codelineno-18-4" href="#__codelineno-18-4"></a>
2404
<a id="__codelineno-18-5" name="__codelineno-18-5" href="#__codelineno-18-5"></a>## Executive Summary
2405
<a id="__codelineno-18-6" name="__codelineno-18-6" href="#__codelineno-18-6"></a>...
2406
</code></pre></div>
2407
<h3 id="prd">/prd<a class="headerlink" href="#prd" title="Permanent link">&para;</a></h3>
2408
<p>Shortcut for <code>/run prd</code>. Generates a product requirements document.</p>
2409
<div class="highlight"><pre><span></span><code><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a>planopticon&gt; /prd
2410
<a id="__codelineno-19-2" name="__codelineno-19-2" href="#__codelineno-19-2"></a>--- Product Requirements Document (prd) ---
2411
<a id="__codelineno-19-3" name="__codelineno-19-3" href="#__codelineno-19-3"></a># Product Requirements Document
2412
<a id="__codelineno-19-4" name="__codelineno-19-4" href="#__codelineno-19-4"></a>
2413
<a id="__codelineno-19-5" name="__codelineno-19-5" href="#__codelineno-19-5"></a>## Problem Statement
2414
<a id="__codelineno-19-6" name="__codelineno-19-6" href="#__codelineno-19-6"></a>...
2415
</code></pre></div>
2416
<h3 id="tasks">/tasks<a class="headerlink" href="#tasks" title="Permanent link">&para;</a></h3>
2417
<p>Shortcut for <code>/run task_breakdown</code>. Breaks goals and features into tasks with dependencies, priorities, and effort estimates. The output is JSON.</p>
2418
<div class="highlight"><pre><span></span><code><a id="__codelineno-20-1" name="__codelineno-20-1" href="#__codelineno-20-1"></a>planopticon&gt; /tasks
2419
<a id="__codelineno-20-2" name="__codelineno-20-2" href="#__codelineno-20-2"></a>--- Task Breakdown (task_list) ---
2420
<a id="__codelineno-20-3" name="__codelineno-20-3" href="#__codelineno-20-3"></a>[
2421
<a id="__codelineno-20-4" name="__codelineno-20-4" href="#__codelineno-20-4"></a> {
2422
<a id="__codelineno-20-5" name="__codelineno-20-5" href="#__codelineno-20-5"></a> &quot;id&quot;: &quot;T1&quot;,
2423
<a id="__codelineno-20-6" name="__codelineno-20-6" href="#__codelineno-20-6"></a> &quot;title&quot;: &quot;Set up authentication service&quot;,
2424
<a id="__codelineno-20-7" name="__codelineno-20-7" href="#__codelineno-20-7"></a> &quot;description&quot;: &quot;Implement OAuth2 flow with JWT tokens&quot;,
2425
<a id="__codelineno-20-8" name="__codelineno-20-8" href="#__codelineno-20-8"></a> &quot;depends_on&quot;: [],
2426
<a id="__codelineno-20-9" name="__codelineno-20-9" href="#__codelineno-20-9"></a> &quot;priority&quot;: &quot;high&quot;,
2427
<a id="__codelineno-20-10" name="__codelineno-20-10" href="#__codelineno-20-10"></a> &quot;estimate&quot;: &quot;1w&quot;,
2428
<a id="__codelineno-20-11" name="__codelineno-20-11" href="#__codelineno-20-11"></a> &quot;assignee_role&quot;: &quot;backend engineer&quot;
2429
<a id="__codelineno-20-12" name="__codelineno-20-12" href="#__codelineno-20-12"></a> },
2430
<a id="__codelineno-20-13" name="__codelineno-20-13" href="#__codelineno-20-13"></a> ...
2431
<a id="__codelineno-20-14" name="__codelineno-20-14" href="#__codelineno-20-14"></a>]
2432
</code></pre></div>
2433
<h3 id="quit-and-exit">/quit and /exit<a class="headerlink" href="#quit-and-exit" title="Permanent link">&para;</a></h3>
2434
<p>Exit the Companion REPL.</p>
2435
<div class="highlight"><pre><span></span><code><a id="__codelineno-21-1" name="__codelineno-21-1" href="#__codelineno-21-1"></a>planopticon&gt; /quit
2436
<a id="__codelineno-21-2" name="__codelineno-21-2" href="#__codelineno-21-2"></a>Bye.
2437
</code></pre></div>
2438
<hr />
2439
<h2 id="exiting-the-companion">Exiting the Companion<a class="headerlink" href="#exiting-the-companion" title="Permanent link">&para;</a></h2>
2440
<p>In addition to <code>/quit</code> and <code>/exit</code>, you can exit by:</p>
2441
<ul>
2442
<li>Typing <code>quit</code>, <code>exit</code>, <code>bye</code>, or <code>q</code> as bare words (without the <code>/</code> prefix)</li>
2443
<li>Pressing <code>Ctrl+C</code> or <code>Ctrl+D</code></li>
2444
</ul>
2445
<p>All of these end the session with a "Bye." message.</p>
2446
<hr />
2447
<h2 id="chat-mode">Chat Mode<a class="headerlink" href="#chat-mode" title="Permanent link">&para;</a></h2>
2448
<p>Any input that does not start with <code>/</code> and is not a bare exit word is sent to the chat agent as a natural-language message. This requires a configured LLM provider.</p>
2449
<div class="highlight"><pre><span></span><code><a id="__codelineno-22-1" name="__codelineno-22-1" href="#__codelineno-22-1"></a>planopticon&gt; What technologies were discussed in the meeting?
2450
<a id="__codelineno-22-2" name="__codelineno-22-2" href="#__codelineno-22-2"></a>Based on the knowledge graph, the following technologies were discussed:
2451
<a id="__codelineno-22-3" name="__codelineno-22-3" href="#__codelineno-22-3"></a>
2452
<a id="__codelineno-22-4" name="__codelineno-22-4" href="#__codelineno-22-4"></a>1. **Python** -- mentioned in the context of backend development
2453
<a id="__codelineno-22-5" name="__codelineno-22-5" href="#__codelineno-22-5"></a>2. **React** -- proposed for the frontend redesign
2454
<a id="__codelineno-22-6" name="__codelineno-22-6" href="#__codelineno-22-6"></a>3. **PostgreSQL** -- discussed as the primary database
2455
<a id="__codelineno-22-7" name="__codelineno-22-7" href="#__codelineno-22-7"></a>...
2456
</code></pre></div>
2457
<p>The chat agent maintains conversation history across the session. It has full awareness of:</p>
2458
<ul>
2459
<li>The loaded knowledge graph (entity and relationship counts, types)</li>
2460
<li>Any artifacts generated during the session (via <code>/plan</code>, <code>/prd</code>, <code>/tasks</code>, <code>/run</code>)</li>
2461
<li>All available slash commands (which it may suggest when relevant)</li>
2462
<li>The full PlanOpticon CLI command set</li>
2463
</ul>
2464
<p>If no LLM provider is configured, chat mode returns an error with instructions:</p>
2465
<div class="highlight"><pre><span></span><code><a id="__codelineno-23-1" name="__codelineno-23-1" href="#__codelineno-23-1"></a>planopticon&gt; What was discussed?
2466
<a id="__codelineno-23-2" name="__codelineno-23-2" href="#__codelineno-23-2"></a>Chat requires an LLM provider. Set one of:
2467
<a id="__codelineno-23-3" name="__codelineno-23-3" href="#__codelineno-23-3"></a> OPENAI_API_KEY
2468
<a id="__codelineno-23-4" name="__codelineno-23-4" href="#__codelineno-23-4"></a> ANTHROPIC_API_KEY
2469
<a id="__codelineno-23-5" name="__codelineno-23-5" href="#__codelineno-23-5"></a> GEMINI_API_KEY
2470
<a id="__codelineno-23-6" name="__codelineno-23-6" href="#__codelineno-23-6"></a>Or pass --provider / --chat-model.
2471
</code></pre></div>
2472
<hr />
2473
<h2 id="runtime-provider-and-model-switching">Runtime Provider and Model Switching<a class="headerlink" href="#runtime-provider-and-model-switching" title="Permanent link">&para;</a></h2>
2474
<p>One of the Companion's key features is the ability to switch LLM providers and models without restarting the session. This is useful for:</p>
2475
<ul>
2476
<li>Comparing outputs across different models</li>
2477
<li>Falling back to a local model (Ollama) when API keys expire</li>
2478
<li>Using a cheaper model for exploratory queries and a more capable one for artifact generation</li>
2479
</ul>
2480
<p>When you switch providers or models via <code>/provider</code> or <code>/model</code>, the Companion:</p>
2481
<ol>
2482
<li>Updates the internal provider name and/or model name</li>
2483
<li>Reinitialises the <code>ProviderManager</code></li>
2484
<li>Reinitialises the <code>PlanningAgent</code> with a fresh <code>AgentContext</code> that retains the loaded knowledge graph and query engine</li>
2485
</ol>
2486
<p>Conversation history is preserved across provider switches.</p>
2487
<hr />
2488
<h2 id="example-session">Example Session<a class="headerlink" href="#example-session" title="Permanent link">&para;</a></h2>
2489
<p>The following walkthrough shows a typical Companion session, from launch through exploration to artifact generation.</p>
2490
<div class="highlight"><pre><span></span><code><a id="__codelineno-24-1" name="__codelineno-24-1" href="#__codelineno-24-1"></a>$<span class="w"> </span>planopticon<span class="w"> </span>companion<span class="w"> </span>--kb<span class="w"> </span>./results
2491
</code></pre></div>
2492
<div class="highlight"><pre><span></span><code><a id="__codelineno-25-1" name="__codelineno-25-1" href="#__codelineno-25-1"></a> PlanOpticon Companion
2493
<a id="__codelineno-25-2" name="__codelineno-25-2" href="#__codelineno-25-2"></a> Interactive planning REPL
2494
<a id="__codelineno-25-3" name="__codelineno-25-3" href="#__codelineno-25-3"></a>
2495
<a id="__codelineno-25-4" name="__codelineno-25-4" href="#__codelineno-25-4"></a> Knowledge graph: knowledge_graph.db (58 entities, 124 relationships)
2496
<a id="__codelineno-25-5" name="__codelineno-25-5" href="#__codelineno-25-5"></a> Videos: sprint-review-2024-03.mp4
2497
<a id="__codelineno-25-6" name="__codelineno-25-6" href="#__codelineno-25-6"></a> Docs: architecture.md, requirements.pdf
2498
<a id="__codelineno-25-7" name="__codelineno-25-7" href="#__codelineno-25-7"></a> LLM provider: openai (model: default)
2499
<a id="__codelineno-25-8" name="__codelineno-25-8" href="#__codelineno-25-8"></a>
2500
<a id="__codelineno-25-9" name="__codelineno-25-9" href="#__codelineno-25-9"></a> Type /help for commands, or ask a question.
2501
<a id="__codelineno-25-10" name="__codelineno-25-10" href="#__codelineno-25-10"></a>
2502
<a id="__codelineno-25-11" name="__codelineno-25-11" href="#__codelineno-25-11"></a>planopticon&gt; /status
2503
<a id="__codelineno-25-12" name="__codelineno-25-12" href="#__codelineno-25-12"></a>Workspace status:
2504
<a id="__codelineno-25-13" name="__codelineno-25-13" href="#__codelineno-25-13"></a> KG: /home/user/project/results/knowledge_graph.db (58 entities, 124 relationships)
2505
<a id="__codelineno-25-14" name="__codelineno-25-14" href="#__codelineno-25-14"></a> technology: 20
2506
<a id="__codelineno-25-15" name="__codelineno-25-15" href="#__codelineno-25-15"></a> person: 15
2507
<a id="__codelineno-25-16" name="__codelineno-25-16" href="#__codelineno-25-16"></a> concept: 13
2508
<a id="__codelineno-25-17" name="__codelineno-25-17" href="#__codelineno-25-17"></a> organization: 8
2509
<a id="__codelineno-25-18" name="__codelineno-25-18" href="#__codelineno-25-18"></a> time: 2
2510
<a id="__codelineno-25-19" name="__codelineno-25-19" href="#__codelineno-25-19"></a> Videos: 1 found
2511
<a id="__codelineno-25-20" name="__codelineno-25-20" href="#__codelineno-25-20"></a> Docs: 2 found
2512
<a id="__codelineno-25-21" name="__codelineno-25-21" href="#__codelineno-25-21"></a> Provider: active
2513
<a id="__codelineno-25-22" name="__codelineno-25-22" href="#__codelineno-25-22"></a>
2514
<a id="__codelineno-25-23" name="__codelineno-25-23" href="#__codelineno-25-23"></a>planopticon&gt; /entities --type person
2515
<a id="__codelineno-25-24" name="__codelineno-25-24" href="#__codelineno-25-24"></a>Found 15 entities
2516
<a id="__codelineno-25-25" name="__codelineno-25-25" href="#__codelineno-25-25"></a> [person] Alice -- Lead architect
2517
<a id="__codelineno-25-26" name="__codelineno-25-26" href="#__codelineno-25-26"></a> [person] Bob -- Product manager
2518
<a id="__codelineno-25-27" name="__codelineno-25-27" href="#__codelineno-25-27"></a> [person] Carol -- Frontend lead
2519
<a id="__codelineno-25-28" name="__codelineno-25-28" href="#__codelineno-25-28"></a> ...
2520
<a id="__codelineno-25-29" name="__codelineno-25-29" href="#__codelineno-25-29"></a>
2521
<a id="__codelineno-25-30" name="__codelineno-25-30" href="#__codelineno-25-30"></a>planopticon&gt; /neighbors Alice
2522
<a id="__codelineno-25-31" name="__codelineno-25-31" href="#__codelineno-25-31"></a>Found 6 entities and 8 relationships
2523
<a id="__codelineno-25-32" name="__codelineno-25-32" href="#__codelineno-25-32"></a> [person] Alice -- Lead architect
2524
<a id="__codelineno-25-33" name="__codelineno-25-33" href="#__codelineno-25-33"></a> [technology] Kubernetes -- Container orchestration platform
2525
<a id="__codelineno-25-34" name="__codelineno-25-34" href="#__codelineno-25-34"></a> [concept] Microservices -- Proposed architecture pattern
2526
<a id="__codelineno-25-35" name="__codelineno-25-35" href="#__codelineno-25-35"></a> ...
2527
<a id="__codelineno-25-36" name="__codelineno-25-36" href="#__codelineno-25-36"></a> Alice --[proposed]--&gt; Microservices
2528
<a id="__codelineno-25-37" name="__codelineno-25-37" href="#__codelineno-25-37"></a> Alice --[expert_in]--&gt; Kubernetes
2529
<a id="__codelineno-25-38" name="__codelineno-25-38" href="#__codelineno-25-38"></a> ...
2530
<a id="__codelineno-25-39" name="__codelineno-25-39" href="#__codelineno-25-39"></a>
2531
<a id="__codelineno-25-40" name="__codelineno-25-40" href="#__codelineno-25-40"></a>planopticon&gt; What were the main decisions made in the sprint review?
2532
<a id="__codelineno-25-41" name="__codelineno-25-41" href="#__codelineno-25-41"></a>Based on the knowledge graph, the sprint review covered several key decisions:
2533
<a id="__codelineno-25-42" name="__codelineno-25-42" href="#__codelineno-25-42"></a>
2534
<a id="__codelineno-25-43" name="__codelineno-25-43" href="#__codelineno-25-43"></a>1. **Adopt microservices architecture** -- Alice proposed and the team agreed
2535
<a id="__codelineno-25-44" name="__codelineno-25-44" href="#__codelineno-25-44"></a> to move from the monolith to a microservices pattern.
2536
<a id="__codelineno-25-45" name="__codelineno-25-45" href="#__codelineno-25-45"></a>2. **Use Kubernetes for orchestration** -- Selected over Docker Swarm.
2537
<a id="__codelineno-25-46" name="__codelineno-25-46" href="#__codelineno-25-46"></a>3. **Prioritize authentication module** -- Bob identified this as the highest
2538
<a id="__codelineno-25-47" name="__codelineno-25-47" href="#__codelineno-25-47"></a> priority for the next sprint.
2539
<a id="__codelineno-25-48" name="__codelineno-25-48" href="#__codelineno-25-48"></a>
2540
<a id="__codelineno-25-49" name="__codelineno-25-49" href="#__codelineno-25-49"></a>planopticon&gt; /provider anthropic
2541
<a id="__codelineno-25-50" name="__codelineno-25-50" href="#__codelineno-25-50"></a>Switched to provider: anthropic
2542
<a id="__codelineno-25-51" name="__codelineno-25-51" href="#__codelineno-25-51"></a>
2543
<a id="__codelineno-25-52" name="__codelineno-25-52" href="#__codelineno-25-52"></a>planopticon&gt; /model claude-sonnet-4-20250514
2544
<a id="__codelineno-25-53" name="__codelineno-25-53" href="#__codelineno-25-53"></a>Switched to model: claude-sonnet-4-20250514
2545
<a id="__codelineno-25-54" name="__codelineno-25-54" href="#__codelineno-25-54"></a>
2546
<a id="__codelineno-25-55" name="__codelineno-25-55" href="#__codelineno-25-55"></a>planopticon&gt; /plan
2547
<a id="__codelineno-25-56" name="__codelineno-25-56" href="#__codelineno-25-56"></a>--- Project Plan (project_plan) ---
2548
<a id="__codelineno-25-57" name="__codelineno-25-57" href="#__codelineno-25-57"></a># Project Plan
2549
<a id="__codelineno-25-58" name="__codelineno-25-58" href="#__codelineno-25-58"></a>
2550
<a id="__codelineno-25-59" name="__codelineno-25-59" href="#__codelineno-25-59"></a>## Executive Summary
2551
<a id="__codelineno-25-60" name="__codelineno-25-60" href="#__codelineno-25-60"></a>This project plan outlines the migration from a monolithic architecture
2552
<a id="__codelineno-25-61" name="__codelineno-25-61" href="#__codelineno-25-61"></a>to a microservices-based system, as discussed in the sprint review...
2553
<a id="__codelineno-25-62" name="__codelineno-25-62" href="#__codelineno-25-62"></a>
2554
<a id="__codelineno-25-63" name="__codelineno-25-63" href="#__codelineno-25-63"></a>## Goals &amp; Objectives
2555
<a id="__codelineno-25-64" name="__codelineno-25-64" href="#__codelineno-25-64"></a>...
2556
<a id="__codelineno-25-65" name="__codelineno-25-65" href="#__codelineno-25-65"></a>
2557
<a id="__codelineno-25-66" name="__codelineno-25-66" href="#__codelineno-25-66"></a>planopticon&gt; /tasks
2558
<a id="__codelineno-25-67" name="__codelineno-25-67" href="#__codelineno-25-67"></a>--- Task Breakdown (task_list) ---
2559
<a id="__codelineno-25-68" name="__codelineno-25-68" href="#__codelineno-25-68"></a>[
2560
<a id="__codelineno-25-69" name="__codelineno-25-69" href="#__codelineno-25-69"></a> {
2561
<a id="__codelineno-25-70" name="__codelineno-25-70" href="#__codelineno-25-70"></a> &quot;id&quot;: &quot;T1&quot;,
2562
<a id="__codelineno-25-71" name="__codelineno-25-71" href="#__codelineno-25-71"></a> &quot;title&quot;: &quot;Design service boundaries&quot;,
2563
<a id="__codelineno-25-72" name="__codelineno-25-72" href="#__codelineno-25-72"></a> &quot;description&quot;: &quot;Define microservice boundaries based on domain analysis&quot;,
2564
<a id="__codelineno-25-73" name="__codelineno-25-73" href="#__codelineno-25-73"></a> &quot;depends_on&quot;: [],
2565
<a id="__codelineno-25-74" name="__codelineno-25-74" href="#__codelineno-25-74"></a> &quot;priority&quot;: &quot;high&quot;,
2566
<a id="__codelineno-25-75" name="__codelineno-25-75" href="#__codelineno-25-75"></a> &quot;estimate&quot;: &quot;3d&quot;,
2567
<a id="__codelineno-25-76" name="__codelineno-25-76" href="#__codelineno-25-76"></a> &quot;assignee_role&quot;: &quot;architect&quot;
2568
<a id="__codelineno-25-77" name="__codelineno-25-77" href="#__codelineno-25-77"></a> },
2569
<a id="__codelineno-25-78" name="__codelineno-25-78" href="#__codelineno-25-78"></a> ...
2570
<a id="__codelineno-25-79" name="__codelineno-25-79" href="#__codelineno-25-79"></a>]
2571
<a id="__codelineno-25-80" name="__codelineno-25-80" href="#__codelineno-25-80"></a>
2572
<a id="__codelineno-25-81" name="__codelineno-25-81" href="#__codelineno-25-81"></a>planopticon&gt; /export obsidian
2573
<a id="__codelineno-25-82" name="__codelineno-25-82" href="#__codelineno-25-82"></a>Export &#39;obsidian&#39; requested. Use the CLI command:
2574
<a id="__codelineno-25-83" name="__codelineno-25-83" href="#__codelineno-25-83"></a> planopticon export obsidian /home/user/project/results/knowledge_graph.db
2575
<a id="__codelineno-25-84" name="__codelineno-25-84" href="#__codelineno-25-84"></a>
2576
<a id="__codelineno-25-85" name="__codelineno-25-85" href="#__codelineno-25-85"></a>planopticon&gt; quit
2577
<a id="__codelineno-25-86" name="__codelineno-25-86" href="#__codelineno-25-86"></a>Bye.
2578
</code></pre></div>
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
</article>
2593
</div>
2594
2595
2596
<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>
2597
2598
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
2599
</div>
2600
2601
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
2602
2603
<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>
2604
Back to top
2605
</button>
2606
2607
</main>
2608
2609
<footer class="md-footer">
2610
2611
<div class="md-footer-meta md-typeset">
2612
<div class="md-footer-meta__inner md-grid">
2613
<div class="md-copyright">
2614
2615
<div class="md-copyright__highlight">
2616
Copyright &copy; 2026 CONFLICT LLC
2617
</div>
2618
2619
2620
Made with
2621
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2622
Material for MkDocs
2623
</a>
2624
2625
</div>
2626
2627
2628
<div class="md-social">
2629
2630
2631
2632
2633
2634
2635
2636
2637
<a href="https://github.com/ConflictHQ/PlanOpticon" target="_blank" rel="noopener" title="github.com" class="md-social__link">
2638
<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>
2639
</a>
2640
2641
</div>
2642
2643
</div>
2644
</div>
2645
</footer>
2646
2647
</div>
2648
<div class="md-dialog" data-md-component="dialog">
2649
<div class="md-dialog__inner md-typeset"></div>
2650
</div>
2651
2652
2653
2654
2655
2656
<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>
2657
2658
2659
<script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
2660
2661
2662
</body>
2663
</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