|
1
|
# CLI Reference |
|
2
|
|
|
3
|
## Global options |
|
4
|
|
|
5
|
These options are available on all commands. |
|
6
|
|
|
7
|
| Option | Description | |
|
8
|
|--------|-------------| |
|
9
|
| `-v`, `--verbose` | Enable debug-level logging | |
|
10
|
| `-C`, `--chat` | Enable chat mode (interactive follow-up after command completes) | |
|
11
|
| `-I`, `--interactive` | Enable interactive REPL mode | |
|
12
|
| `--version` | Show version and exit | |
|
13
|
| `--help` | Show help and exit | |
|
14
|
|
|
15
|
--- |
|
16
|
|
|
17
|
## `planopticon analyze` |
|
18
|
|
|
19
|
Analyze a single video and extract structured knowledge. |
|
20
|
|
|
21
|
```bash |
|
22
|
planopticon analyze [OPTIONS] |
|
23
|
``` |
|
24
|
|
|
25
|
| Option | Type | Default | Description | |
|
26
|
|--------|------|---------|-------------| |
|
27
|
| `-i`, `--input` | PATH | *required* | Input video file path | |
|
28
|
| `-o`, `--output` | PATH | *required* | Output directory | |
|
29
|
| `--depth` | `basic\|standard\|comprehensive` | `standard` | Processing depth | |
|
30
|
| `--focus` | TEXT | all | Comma-separated focus areas | |
|
31
|
| `--use-gpu` | FLAG | off | Enable GPU acceleration | |
|
32
|
| `--sampling-rate` | FLOAT | 0.5 | Frame sampling rate (fps) | |
|
33
|
| `--change-threshold` | FLOAT | 0.15 | Visual change threshold | |
|
34
|
| `--periodic-capture` | FLOAT | 30.0 | Capture a frame every N seconds regardless of change (0 to disable) | |
|
35
|
| `--title` | TEXT | auto | Report title | |
|
36
|
| `-p`, `--provider` | `auto\|openai\|anthropic\|gemini\|ollama` | `auto` | API provider | |
|
37
|
| `--vision-model` | TEXT | auto | Override vision model | |
|
38
|
| `--chat-model` | TEXT | auto | Override chat model | |
|
39
|
|
|
40
|
--- |
|
41
|
|
|
42
|
## `planopticon batch` |
|
43
|
|
|
44
|
Process a folder of videos in batch. |
|
45
|
|
|
46
|
```bash |
|
47
|
planopticon batch [OPTIONS] |
|
48
|
``` |
|
49
|
|
|
50
|
| Option | Type | Default | Description | |
|
51
|
|--------|------|---------|-------------| |
|
52
|
| `-i`, `--input-dir` | PATH | *required* | Directory containing videos | |
|
53
|
| `-o`, `--output` | PATH | *required* | Output directory | |
|
54
|
| `--depth` | `basic\|standard\|comprehensive` | `standard` | Processing depth | |
|
55
|
| `--pattern` | TEXT | `*.mp4,*.mkv,*.avi,*.mov,*.webm` | File glob patterns | |
|
56
|
| `--title` | TEXT | `Batch Processing Results` | Batch title | |
|
57
|
| `-p`, `--provider` | `auto\|openai\|anthropic\|gemini\|ollama` | `auto` | API provider | |
|
58
|
| `--vision-model` | TEXT | auto | Override vision model | |
|
59
|
| `--chat-model` | TEXT | auto | Override chat model | |
|
60
|
| `--source` | `local\|gdrive\|dropbox` | `local` | Video source | |
|
61
|
| `--folder-id` | TEXT | none | Google Drive folder ID | |
|
62
|
| `--folder-path` | TEXT | none | Cloud folder path | |
|
63
|
| `--recursive/--no-recursive` | FLAG | recursive | Recurse into subfolders | |
|
64
|
|
|
65
|
--- |
|
66
|
|
|
67
|
## `planopticon list-models` |
|
68
|
|
|
69
|
Discover and display available models from all configured providers. |
|
70
|
|
|
71
|
```bash |
|
72
|
planopticon list-models |
|
73
|
``` |
|
74
|
|
|
75
|
No options. Queries each provider's API and displays models grouped by provider with capabilities. |
|
76
|
|
|
77
|
--- |
|
78
|
|
|
79
|
## `planopticon clear-cache` |
|
80
|
|
|
81
|
Clear API response cache. |
|
82
|
|
|
83
|
```bash |
|
84
|
planopticon clear-cache [OPTIONS] |
|
85
|
``` |
|
86
|
|
|
87
|
| Option | Type | Default | Description | |
|
88
|
|--------|------|---------|-------------| |
|
89
|
| `--cache-dir` | PATH | `$CACHE_DIR` | Path to cache directory | |
|
90
|
| `--older-than` | INT | all | Clear entries older than N seconds | |
|
91
|
| `--all` | FLAG | off | Clear all cache entries | |
|
92
|
|
|
93
|
--- |
|
94
|
|
|
95
|
## `planopticon agent-analyze` |
|
96
|
|
|
97
|
Agentic video analysis — adaptive, intelligent processing that adjusts depth and focus based on content. |
|
98
|
|
|
99
|
```bash |
|
100
|
planopticon agent-analyze [OPTIONS] |
|
101
|
``` |
|
102
|
|
|
103
|
| Option | Type | Default | Description | |
|
104
|
|--------|------|---------|-------------| |
|
105
|
| `-i`, `--input` | PATH | *required* | Input video file path | |
|
106
|
| `-o`, `--output` | PATH | *required* | Output directory | |
|
107
|
| `--depth` | `basic\|standard\|comprehensive` | `standard` | Initial processing depth (agent may adapt) | |
|
108
|
| `--title` | TEXT | auto | Report title | |
|
109
|
| `-p`, `--provider` | `auto\|openai\|anthropic\|gemini\|ollama` | `auto` | API provider | |
|
110
|
| `--vision-model` | TEXT | auto | Override vision model | |
|
111
|
| `--chat-model` | TEXT | auto | Override chat model | |
|
112
|
|
|
113
|
--- |
|
114
|
|
|
115
|
## `planopticon companion` |
|
116
|
|
|
117
|
Interactive knowledge base companion. Opens a REPL for conversational exploration of your knowledge base. |
|
118
|
|
|
119
|
```bash |
|
120
|
planopticon companion [OPTIONS] |
|
121
|
``` |
|
122
|
|
|
123
|
| Option | Type | Default | Description | |
|
124
|
|--------|------|---------|-------------| |
|
125
|
| `--kb` | PATH | auto-detect | Path to knowledge base directory | |
|
126
|
| `-p`, `--provider` | TEXT | `auto` | AI provider | |
|
127
|
| `--chat-model` | TEXT | auto | Override chat model | |
|
128
|
|
|
129
|
**Examples:** |
|
130
|
|
|
131
|
```bash |
|
132
|
# Start companion with auto-detected knowledge base |
|
133
|
planopticon companion |
|
134
|
|
|
135
|
# Point to a specific knowledge base |
|
136
|
planopticon companion --kb ./my-kb |
|
137
|
|
|
138
|
# Use a specific provider |
|
139
|
planopticon companion --kb ./kb --provider anthropic --chat-model claude-sonnet-4-20250514 |
|
140
|
``` |
|
141
|
|
|
142
|
--- |
|
143
|
|
|
144
|
## `planopticon agent` |
|
145
|
|
|
146
|
Planning agent with adaptive analysis. Runs an agentic loop that reasons about your knowledge base, plans actions, and executes them. |
|
147
|
|
|
148
|
```bash |
|
149
|
planopticon agent [OPTIONS] |
|
150
|
``` |
|
151
|
|
|
152
|
| Option | Type | Default | Description | |
|
153
|
|--------|------|---------|-------------| |
|
154
|
| `--kb` | PATH | auto-detect | Path to knowledge base directory | |
|
155
|
| `-I`, `--interactive` | FLAG | off | Interactive mode (ask before each action) | |
|
156
|
| `--export` | PATH | none | Export agent results to a file | |
|
157
|
| `-p`, `--provider` | TEXT | `auto` | AI provider | |
|
158
|
| `--chat-model` | TEXT | auto | Override chat model | |
|
159
|
|
|
160
|
**Examples:** |
|
161
|
|
|
162
|
```bash |
|
163
|
# Run the agent interactively |
|
164
|
planopticon agent --kb ./kb --interactive |
|
165
|
|
|
166
|
# Run agent and export results |
|
167
|
planopticon agent --kb ./kb --export ./plan.md |
|
168
|
|
|
169
|
# Use a specific model |
|
170
|
planopticon agent --kb ./kb --provider openai --chat-model gpt-4o |
|
171
|
``` |
|
172
|
|
|
173
|
--- |
|
174
|
|
|
175
|
## `planopticon query` |
|
176
|
|
|
177
|
Query the knowledge graph directly or with natural language. |
|
178
|
|
|
179
|
```bash |
|
180
|
planopticon query [OPTIONS] [QUERY] |
|
181
|
``` |
|
182
|
|
|
183
|
| Option | Type | Default | Description | |
|
184
|
|--------|------|---------|-------------| |
|
185
|
| `--db-path` | PATH | auto-detect | Path to knowledge graph database | |
|
186
|
| `--mode` | `direct\|agentic` | auto | Query mode (direct for structured, agentic for natural language) | |
|
187
|
| `--format` | `text\|json\|mermaid` | `text` | Output format | |
|
188
|
| `-I`, `--interactive` | FLAG | off | Interactive REPL mode | |
|
189
|
|
|
190
|
**Examples:** |
|
191
|
|
|
192
|
```bash |
|
193
|
# Show graph stats |
|
194
|
planopticon query stats |
|
195
|
|
|
196
|
# List entities by type |
|
197
|
planopticon query "entities --type technology" |
|
198
|
planopticon query "entities --type person" |
|
199
|
|
|
200
|
# Find neighbors of an entity |
|
201
|
planopticon query "neighbors Alice" |
|
202
|
|
|
203
|
# List relationships |
|
204
|
planopticon query "relationships --source Alice" |
|
205
|
|
|
206
|
# Natural language query (requires API key) |
|
207
|
planopticon query "What technologies were discussed?" |
|
208
|
|
|
209
|
# Output as Mermaid diagram |
|
210
|
planopticon query --format mermaid "neighbors ProjectX" |
|
211
|
|
|
212
|
# Output as JSON |
|
213
|
planopticon query --format json stats |
|
214
|
|
|
215
|
# Interactive REPL |
|
216
|
planopticon query -I |
|
217
|
``` |
|
218
|
|
|
219
|
--- |
|
220
|
|
|
221
|
## `planopticon ingest` |
|
222
|
|
|
223
|
Ingest documents and files into a knowledge graph. |
|
224
|
|
|
225
|
```bash |
|
226
|
planopticon ingest [OPTIONS] INPUT |
|
227
|
``` |
|
228
|
|
|
229
|
| Option | Type | Default | Description | |
|
230
|
|--------|------|---------|-------------| |
|
231
|
| `--output` | PATH | `./knowledge-base` | Output directory for the knowledge base | |
|
232
|
| `--db-path` | PATH | auto | Path to existing knowledge graph database to merge into | |
|
233
|
| `--recursive` | FLAG | off | Recursively process directories | |
|
234
|
| `-p`, `--provider` | TEXT | `auto` | AI provider | |
|
235
|
|
|
236
|
**Examples:** |
|
237
|
|
|
238
|
```bash |
|
239
|
# Ingest a single file |
|
240
|
planopticon ingest ./meeting-notes.md --output ./kb |
|
241
|
|
|
242
|
# Ingest a directory recursively |
|
243
|
planopticon ingest ./docs/ --output ./kb --recursive |
|
244
|
|
|
245
|
# Merge into an existing knowledge graph |
|
246
|
planopticon ingest ./new-notes/ --db-path ./kb/knowledge_graph.db --recursive |
|
247
|
``` |
|
248
|
|
|
249
|
--- |
|
250
|
|
|
251
|
## `planopticon auth` |
|
252
|
|
|
253
|
Authenticate with cloud services via OAuth or API keys. |
|
254
|
|
|
255
|
```bash |
|
256
|
planopticon auth SERVICE [OPTIONS] |
|
257
|
``` |
|
258
|
|
|
259
|
| Argument | Values | Description | |
|
260
|
|----------|--------|-------------| |
|
261
|
| `SERVICE` | `google\|dropbox\|zoom\|notion\|github\|microsoft` | Cloud service to authenticate with | |
|
262
|
|
|
263
|
| Option | Type | Default | Description | |
|
264
|
|--------|------|---------|-------------| |
|
265
|
| `--logout` | FLAG | off | Remove stored credentials for the service | |
|
266
|
|
|
267
|
**Examples:** |
|
268
|
|
|
269
|
```bash |
|
270
|
# Authenticate with Google (Drive, Meet, YouTube, etc.) |
|
271
|
planopticon auth google |
|
272
|
|
|
273
|
# Authenticate with Dropbox |
|
274
|
planopticon auth dropbox |
|
275
|
|
|
276
|
# Authenticate with Zoom (for recording access) |
|
277
|
planopticon auth zoom |
|
278
|
|
|
279
|
# Authenticate with Notion |
|
280
|
planopticon auth notion |
|
281
|
|
|
282
|
# Authenticate with GitHub |
|
283
|
planopticon auth github |
|
284
|
|
|
285
|
# Authenticate with Microsoft 365 (OneDrive, Teams, etc.) |
|
286
|
planopticon auth microsoft |
|
287
|
|
|
288
|
# Log out of a service |
|
289
|
planopticon auth google --logout |
|
290
|
``` |
|
291
|
|
|
292
|
--- |
|
293
|
|
|
294
|
## `planopticon gws` |
|
295
|
|
|
296
|
Google Workspace commands. List, fetch, and ingest content from Google Workspace (Drive, Docs, Sheets, Slides, Meet). |
|
297
|
|
|
298
|
### `planopticon gws list` |
|
299
|
|
|
300
|
List available files and recordings from Google Workspace. |
|
301
|
|
|
302
|
```bash |
|
303
|
planopticon gws list [OPTIONS] |
|
304
|
``` |
|
305
|
|
|
306
|
| Option | Type | Default | Description | |
|
307
|
|--------|------|---------|-------------| |
|
308
|
| `--type` | `drive\|docs\|sheets\|slides\|meet` | all | Filter by content type | |
|
309
|
| `--folder-id` | TEXT | none | Google Drive folder ID | |
|
310
|
| `--limit` | INT | 50 | Maximum results to return | |
|
311
|
|
|
312
|
### `planopticon gws fetch` |
|
313
|
|
|
314
|
Download content from Google Workspace. |
|
315
|
|
|
316
|
```bash |
|
317
|
planopticon gws fetch [OPTIONS] RESOURCE_ID |
|
318
|
``` |
|
319
|
|
|
320
|
| Option | Type | Default | Description | |
|
321
|
|--------|------|---------|-------------| |
|
322
|
| `--output` | PATH | `./downloads` | Output directory | |
|
323
|
| `--format` | TEXT | auto | Export format (pdf, docx, etc.) | |
|
324
|
|
|
325
|
### `planopticon gws ingest` |
|
326
|
|
|
327
|
Ingest Google Workspace content directly into a knowledge graph. |
|
328
|
|
|
329
|
```bash |
|
330
|
planopticon gws ingest [OPTIONS] |
|
331
|
``` |
|
332
|
|
|
333
|
| Option | Type | Default | Description | |
|
334
|
|--------|------|---------|-------------| |
|
335
|
| `--folder-id` | TEXT | none | Google Drive folder ID | |
|
336
|
| `--output` | PATH | `./knowledge-base` | Knowledge base output directory | |
|
337
|
| `--recursive` | FLAG | off | Recurse into subfolders | |
|
338
|
|
|
339
|
**Examples:** |
|
340
|
|
|
341
|
```bash |
|
342
|
# List all Google Workspace files |
|
343
|
planopticon gws list |
|
344
|
|
|
345
|
# List only Google Docs |
|
346
|
planopticon gws list --type docs |
|
347
|
|
|
348
|
# Fetch a specific file |
|
349
|
planopticon gws fetch abc123def --output ./downloads |
|
350
|
|
|
351
|
# Ingest an entire Drive folder into a knowledge base |
|
352
|
planopticon gws ingest --folder-id abc123 --output ./kb --recursive |
|
353
|
``` |
|
354
|
|
|
355
|
--- |
|
356
|
|
|
357
|
## `planopticon m365` |
|
358
|
|
|
359
|
Microsoft 365 commands. List, fetch, and ingest content from Microsoft 365 (OneDrive, SharePoint, Teams, Outlook). |
|
360
|
|
|
361
|
### `planopticon m365 list` |
|
362
|
|
|
363
|
List available files and recordings from Microsoft 365. |
|
364
|
|
|
365
|
```bash |
|
366
|
planopticon m365 list [OPTIONS] |
|
367
|
``` |
|
368
|
|
|
369
|
| Option | Type | Default | Description | |
|
370
|
|--------|------|---------|-------------| |
|
371
|
| `--type` | `onedrive\|sharepoint\|teams\|outlook` | all | Filter by content type | |
|
372
|
| `--site` | TEXT | none | SharePoint site name | |
|
373
|
| `--limit` | INT | 50 | Maximum results to return | |
|
374
|
|
|
375
|
### `planopticon m365 fetch` |
|
376
|
|
|
377
|
Download content from Microsoft 365. |
|
378
|
|
|
379
|
```bash |
|
380
|
planopticon m365 fetch [OPTIONS] RESOURCE_ID |
|
381
|
``` |
|
382
|
|
|
383
|
| Option | Type | Default | Description | |
|
384
|
|--------|------|---------|-------------| |
|
385
|
| `--output` | PATH | `./downloads` | Output directory | |
|
386
|
|
|
387
|
### `planopticon m365 ingest` |
|
388
|
|
|
389
|
Ingest Microsoft 365 content directly into a knowledge graph. |
|
390
|
|
|
391
|
```bash |
|
392
|
planopticon m365 ingest [OPTIONS] |
|
393
|
``` |
|
394
|
|
|
395
|
| Option | Type | Default | Description | |
|
396
|
|--------|------|---------|-------------| |
|
397
|
| `--site` | TEXT | none | SharePoint site name | |
|
398
|
| `--path` | TEXT | `/` | Folder path in OneDrive/SharePoint | |
|
399
|
| `--output` | PATH | `./knowledge-base` | Knowledge base output directory | |
|
400
|
| `--recursive` | FLAG | off | Recurse into subfolders | |
|
401
|
|
|
402
|
**Examples:** |
|
403
|
|
|
404
|
```bash |
|
405
|
# List all Microsoft 365 content |
|
406
|
planopticon m365 list |
|
407
|
|
|
408
|
# List only Teams recordings |
|
409
|
planopticon m365 list --type teams |
|
410
|
|
|
411
|
# Fetch a specific file |
|
412
|
planopticon m365 fetch item-id-123 --output ./downloads |
|
413
|
|
|
414
|
# Ingest SharePoint content |
|
415
|
planopticon m365 ingest --site "Engineering" --path "/Shared Documents" --output ./kb --recursive |
|
416
|
``` |
|
417
|
|
|
418
|
--- |
|
419
|
|
|
420
|
## `planopticon recordings` |
|
421
|
|
|
422
|
List meeting recordings from video conferencing platforms. |
|
423
|
|
|
424
|
### `planopticon recordings zoom-list` |
|
425
|
|
|
426
|
List Zoom cloud recordings. |
|
427
|
|
|
428
|
```bash |
|
429
|
planopticon recordings zoom-list [OPTIONS] |
|
430
|
``` |
|
431
|
|
|
432
|
| Option | Type | Default | Description | |
|
433
|
|--------|------|---------|-------------| |
|
434
|
| `--from` | DATE | 30 days ago | Start date (YYYY-MM-DD) | |
|
435
|
| `--to` | DATE | today | End date (YYYY-MM-DD) | |
|
436
|
| `--limit` | INT | 50 | Maximum results | |
|
437
|
|
|
438
|
### `planopticon recordings teams-list` |
|
439
|
|
|
440
|
List Microsoft Teams meeting recordings. |
|
441
|
|
|
442
|
```bash |
|
443
|
planopticon recordings teams-list [OPTIONS] |
|
444
|
``` |
|
445
|
|
|
446
|
| Option | Type | Default | Description | |
|
447
|
|--------|------|---------|-------------| |
|
448
|
| `--from` | DATE | 30 days ago | Start date (YYYY-MM-DD) | |
|
449
|
| `--to` | DATE | today | End date (YYYY-MM-DD) | |
|
450
|
| `--limit` | INT | 50 | Maximum results | |
|
451
|
|
|
452
|
### `planopticon recordings meet-list` |
|
453
|
|
|
454
|
List Google Meet recordings. |
|
455
|
|
|
456
|
```bash |
|
457
|
planopticon recordings meet-list [OPTIONS] |
|
458
|
``` |
|
459
|
|
|
460
|
| Option | Type | Default | Description | |
|
461
|
|--------|------|---------|-------------| |
|
462
|
| `--from` | DATE | 30 days ago | Start date (YYYY-MM-DD) | |
|
463
|
| `--to` | DATE | today | End date (YYYY-MM-DD) | |
|
464
|
| `--limit` | INT | 50 | Maximum results | |
|
465
|
|
|
466
|
**Examples:** |
|
467
|
|
|
468
|
```bash |
|
469
|
# List recent Zoom recordings |
|
470
|
planopticon recordings zoom-list |
|
471
|
|
|
472
|
# List Teams recordings from a specific date range |
|
473
|
planopticon recordings teams-list --from 2026-01-01 --to 2026-02-01 |
|
474
|
|
|
475
|
# List Google Meet recordings |
|
476
|
planopticon recordings meet-list --limit 10 |
|
477
|
``` |
|
478
|
|
|
479
|
--- |
|
480
|
|
|
481
|
## `planopticon export` |
|
482
|
|
|
483
|
Export knowledge base content to various formats. |
|
484
|
|
|
485
|
### `planopticon export markdown` |
|
486
|
|
|
487
|
Export knowledge base as Markdown files. |
|
488
|
|
|
489
|
```bash |
|
490
|
planopticon export markdown [OPTIONS] |
|
491
|
``` |
|
492
|
|
|
493
|
| Option | Type | Default | Description | |
|
494
|
|--------|------|---------|-------------| |
|
495
|
| `--input` | PATH | auto-detect | Knowledge base path | |
|
496
|
| `--output` | PATH | `./export` | Output directory | |
|
497
|
|
|
498
|
### `planopticon export obsidian` |
|
499
|
|
|
500
|
Export knowledge base as an Obsidian vault with wikilinks and graph metadata. |
|
501
|
|
|
502
|
```bash |
|
503
|
planopticon export obsidian [OPTIONS] |
|
504
|
``` |
|
505
|
|
|
506
|
| Option | Type | Default | Description | |
|
507
|
|--------|------|---------|-------------| |
|
508
|
| `--input` | PATH | auto-detect | Knowledge base path | |
|
509
|
| `--output` | PATH | `./obsidian-vault` | Output vault directory | |
|
510
|
|
|
511
|
### `planopticon export notion` |
|
512
|
|
|
513
|
Export knowledge base to Notion. |
|
514
|
|
|
515
|
```bash |
|
516
|
planopticon export notion [OPTIONS] |
|
517
|
``` |
|
518
|
|
|
519
|
| Option | Type | Default | Description | |
|
520
|
|--------|------|---------|-------------| |
|
521
|
| `--input` | PATH | auto-detect | Knowledge base path | |
|
522
|
| `--parent-page` | TEXT | none | Notion parent page ID | |
|
523
|
|
|
524
|
### `planopticon export exchange` |
|
525
|
|
|
526
|
Export knowledge base as PlanOpticon Exchange Format (JSON). |
|
527
|
|
|
528
|
```bash |
|
529
|
planopticon export exchange [OPTIONS] |
|
530
|
``` |
|
531
|
|
|
532
|
| Option | Type | Default | Description | |
|
533
|
|--------|------|---------|-------------| |
|
534
|
| `--input` | PATH | auto-detect | Knowledge base path | |
|
535
|
| `--output` | PATH | `./exchange.json` | Output file path | |
|
536
|
|
|
537
|
**Examples:** |
|
538
|
|
|
539
|
```bash |
|
540
|
# Export to Markdown |
|
541
|
planopticon export markdown --input ./kb --output ./docs |
|
542
|
|
|
543
|
# Export to Obsidian vault |
|
544
|
planopticon export obsidian --input ./kb --output ~/Obsidian/PlanOpticon |
|
545
|
|
|
546
|
# Export to Notion |
|
547
|
planopticon export notion --input ./kb --parent-page abc123 |
|
548
|
|
|
549
|
# Export as exchange format for interoperability |
|
550
|
planopticon export exchange --input ./kb --output ./export.json |
|
551
|
``` |
|
552
|
|
|
553
|
--- |
|
554
|
|
|
555
|
## `planopticon wiki` |
|
556
|
|
|
557
|
Generate and publish wiki documentation from your knowledge base. |
|
558
|
|
|
559
|
### `planopticon wiki generate` |
|
560
|
|
|
561
|
Generate a static wiki site from the knowledge base. |
|
562
|
|
|
563
|
```bash |
|
564
|
planopticon wiki generate [OPTIONS] |
|
565
|
``` |
|
566
|
|
|
567
|
| Option | Type | Default | Description | |
|
568
|
|--------|------|---------|-------------| |
|
569
|
| `--input` | PATH | auto-detect | Knowledge base path | |
|
570
|
| `--output` | PATH | `./wiki` | Output directory | |
|
571
|
|
|
572
|
### `planopticon wiki push` |
|
573
|
|
|
574
|
Push a generated wiki to a remote target (e.g., GitHub Wiki, Confluence). |
|
575
|
|
|
576
|
```bash |
|
577
|
planopticon wiki push [OPTIONS] |
|
578
|
``` |
|
579
|
|
|
580
|
| Option | Type | Default | Description | |
|
581
|
|--------|------|---------|-------------| |
|
582
|
| `--input` | PATH | `./wiki` | Wiki directory to push | |
|
583
|
| `--target` | TEXT | *required* | Push target (e.g., `github://org/repo`, `confluence://space`) | |
|
584
|
|
|
585
|
**Examples:** |
|
586
|
|
|
587
|
```bash |
|
588
|
# Generate a wiki from the knowledge base |
|
589
|
planopticon wiki generate --input ./kb --output ./wiki |
|
590
|
|
|
591
|
# Push wiki to GitHub |
|
592
|
planopticon wiki push --input ./wiki --target "github://ConflictHQ/project-wiki" |
|
593
|
``` |
|
594
|
|
|
595
|
--- |
|
596
|
|
|
597
|
## `planopticon kg` |
|
598
|
|
|
599
|
Knowledge graph management commands. |
|
600
|
|
|
601
|
### `planopticon kg convert` |
|
602
|
|
|
603
|
Convert a knowledge graph between formats. |
|
604
|
|
|
605
|
```bash |
|
606
|
planopticon kg convert [OPTIONS] |
|
607
|
``` |
|
608
|
|
|
609
|
| Option | Type | Default | Description | |
|
610
|
|--------|------|---------|-------------| |
|
611
|
| `--input` | PATH | *required* | Input knowledge graph file | |
|
612
|
| `--output` | PATH | *required* | Output file path | |
|
613
|
| `--format` | `json\|db\|graphml\|csv` | auto (from extension) | Target format | |
|
614
|
|
|
615
|
### `planopticon kg sync` |
|
616
|
|
|
617
|
Synchronize two knowledge graphs (merge new data). |
|
618
|
|
|
619
|
```bash |
|
620
|
planopticon kg sync [OPTIONS] |
|
621
|
``` |
|
622
|
|
|
623
|
| Option | Type | Default | Description | |
|
624
|
|--------|------|---------|-------------| |
|
625
|
| `--source` | PATH | *required* | Source knowledge graph | |
|
626
|
| `--target` | PATH | *required* | Target knowledge graph to merge into | |
|
627
|
|
|
628
|
### `planopticon kg inspect` |
|
629
|
|
|
630
|
Inspect a knowledge graph and display statistics. |
|
631
|
|
|
632
|
```bash |
|
633
|
planopticon kg inspect [OPTIONS] [PATH] |
|
634
|
``` |
|
635
|
|
|
636
|
| Option | Type | Default | Description | |
|
637
|
|--------|------|---------|-------------| |
|
638
|
| `PATH` | PATH | auto-detect | Knowledge graph file | |
|
639
|
|
|
640
|
### `planopticon kg classify` |
|
641
|
|
|
642
|
Classify and tag entities in a knowledge graph. |
|
643
|
|
|
644
|
```bash |
|
645
|
planopticon kg classify [OPTIONS] |
|
646
|
``` |
|
647
|
|
|
648
|
| Option | Type | Default | Description | |
|
649
|
|--------|------|---------|-------------| |
|
650
|
| `--db-path` | PATH | auto-detect | Knowledge graph database | |
|
651
|
| `-p`, `--provider` | TEXT | `auto` | AI provider for classification | |
|
652
|
|
|
653
|
### `planopticon kg from-exchange` |
|
654
|
|
|
655
|
Import a knowledge graph from PlanOpticon Exchange Format. |
|
656
|
|
|
657
|
```bash |
|
658
|
planopticon kg from-exchange [OPTIONS] INPUT |
|
659
|
``` |
|
660
|
|
|
661
|
| Option | Type | Default | Description | |
|
662
|
|--------|------|---------|-------------| |
|
663
|
| `INPUT` | PATH | *required* | Exchange format JSON file | |
|
664
|
| `--output` | PATH | `./knowledge-base` | Output knowledge base directory | |
|
665
|
|
|
666
|
**Examples:** |
|
667
|
|
|
668
|
```bash |
|
669
|
# Convert JSON knowledge graph to FalkorDB format |
|
670
|
planopticon kg convert --input ./kg.json --output ./kg.db |
|
671
|
|
|
672
|
# Merge two knowledge graphs |
|
673
|
planopticon kg sync --source ./new-kg.db --target ./main-kg.db |
|
674
|
|
|
675
|
# Inspect a knowledge graph |
|
676
|
planopticon kg inspect ./knowledge_graph.db |
|
677
|
|
|
678
|
# Classify entities with AI |
|
679
|
planopticon kg classify --db-path ./kg.db --provider anthropic |
|
680
|
|
|
681
|
# Import from exchange format |
|
682
|
planopticon kg from-exchange ./export.json --output ./kb |
|
683
|
``` |
|
684
|
|