@bussolabs/closeyourit-cli 0.20.0 → 0.21.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -0
- package/dist/base.d.ts +11 -0
- package/dist/base.js +15 -0
- package/dist/commands/kb/book/add-page.d.ts +18 -0
- package/dist/commands/kb/book/add-page.js +55 -0
- package/dist/commands/kb/book/list.d.ts +12 -0
- package/dist/commands/kb/book/list.js +33 -0
- package/dist/commands/kb/book/show.d.ts +9 -0
- package/dist/commands/kb/book/show.js +22 -0
- package/dist/commands/kb/publish.d.ts +15 -0
- package/dist/commands/kb/publish.js +106 -0
- package/dist/errors/error-codes.d.ts +3 -0
- package/dist/errors/error-codes.js +5 -0
- package/dist/lib/knowledge.d.ts +24 -0
- package/dist/lib/knowledge.js +68 -0
- package/oclif.manifest.json +2984 -2739
- package/opencli.json +192 -1
- package/package.json +4 -1
package/opencli.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"opencli": "0.1",
|
|
4
4
|
"info": {
|
|
5
5
|
"title": "closeyourit",
|
|
6
|
-
"version": "0.
|
|
6
|
+
"version": "0.21.0",
|
|
7
7
|
"description": "CLI for CloseYourIt — manage org, errors, tokens and tickets with your user token",
|
|
8
8
|
"license": {
|
|
9
9
|
"name": "MIT",
|
|
@@ -2463,6 +2463,121 @@
|
|
|
2463
2463
|
"closeyourit kb ask \"what is our retry/backoff policy?\" --json"
|
|
2464
2464
|
]
|
|
2465
2465
|
},
|
|
2466
|
+
{
|
|
2467
|
+
"name": "book",
|
|
2468
|
+
"description": "Knowledge books: ordered collections of pages (summary, add a page)",
|
|
2469
|
+
"commands": [
|
|
2470
|
+
{
|
|
2471
|
+
"name": "add-page",
|
|
2472
|
+
"description": "Add a knowledge page to a book, optionally at a given position in the summary",
|
|
2473
|
+
"options": [
|
|
2474
|
+
{
|
|
2475
|
+
"name": "--page",
|
|
2476
|
+
"description": "Id of the knowledge page to add (an id, not a page number; alias: --page-id)",
|
|
2477
|
+
"required": true,
|
|
2478
|
+
"arguments": [
|
|
2479
|
+
{
|
|
2480
|
+
"name": "PAGE",
|
|
2481
|
+
"required": true
|
|
2482
|
+
}
|
|
2483
|
+
]
|
|
2484
|
+
},
|
|
2485
|
+
{
|
|
2486
|
+
"name": "--position",
|
|
2487
|
+
"description": "Where to put it in the summary (0 = top; omit to append at the end)",
|
|
2488
|
+
"arguments": [
|
|
2489
|
+
{
|
|
2490
|
+
"name": "POSITION",
|
|
2491
|
+
"required": true
|
|
2492
|
+
}
|
|
2493
|
+
]
|
|
2494
|
+
}
|
|
2495
|
+
],
|
|
2496
|
+
"arguments": [
|
|
2497
|
+
{
|
|
2498
|
+
"name": "ID",
|
|
2499
|
+
"required": true,
|
|
2500
|
+
"description": "Knowledge book id"
|
|
2501
|
+
}
|
|
2502
|
+
],
|
|
2503
|
+
"examples": [
|
|
2504
|
+
"closeyourit kb book add-page <book-id> --page <page-id>",
|
|
2505
|
+
"closeyourit kb book add-page <book-id> --page <page-id> --position 0",
|
|
2506
|
+
"closeyourit kb book add-page <book-id> --page <page-id> --json"
|
|
2507
|
+
]
|
|
2508
|
+
},
|
|
2509
|
+
{
|
|
2510
|
+
"name": "list",
|
|
2511
|
+
"description": "List knowledge books (ordered collections of pages) across the projects you can see",
|
|
2512
|
+
"options": [
|
|
2513
|
+
{
|
|
2514
|
+
"name": "--project",
|
|
2515
|
+
"aliases": [
|
|
2516
|
+
"-p"
|
|
2517
|
+
],
|
|
2518
|
+
"description": "Filter by project (key or UUID)",
|
|
2519
|
+
"arguments": [
|
|
2520
|
+
{
|
|
2521
|
+
"name": "PROJECT",
|
|
2522
|
+
"required": true
|
|
2523
|
+
}
|
|
2524
|
+
]
|
|
2525
|
+
},
|
|
2526
|
+
{
|
|
2527
|
+
"name": "--q",
|
|
2528
|
+
"description": "Filter by title (substring, case-insensitive)",
|
|
2529
|
+
"arguments": [
|
|
2530
|
+
{
|
|
2531
|
+
"name": "Q",
|
|
2532
|
+
"required": true
|
|
2533
|
+
}
|
|
2534
|
+
]
|
|
2535
|
+
},
|
|
2536
|
+
{
|
|
2537
|
+
"name": "--per",
|
|
2538
|
+
"description": "Page size",
|
|
2539
|
+
"arguments": [
|
|
2540
|
+
{
|
|
2541
|
+
"name": "PER",
|
|
2542
|
+
"required": true
|
|
2543
|
+
}
|
|
2544
|
+
]
|
|
2545
|
+
},
|
|
2546
|
+
{
|
|
2547
|
+
"name": "--page",
|
|
2548
|
+
"description": "Page number",
|
|
2549
|
+
"arguments": [
|
|
2550
|
+
{
|
|
2551
|
+
"name": "PAGE",
|
|
2552
|
+
"required": true
|
|
2553
|
+
}
|
|
2554
|
+
]
|
|
2555
|
+
}
|
|
2556
|
+
],
|
|
2557
|
+
"examples": [
|
|
2558
|
+
"closeyourit kb book list",
|
|
2559
|
+
"closeyourit kb book list --project acme-api",
|
|
2560
|
+
"closeyourit kb book list --q deploy --per 50",
|
|
2561
|
+
"closeyourit kb book list --json"
|
|
2562
|
+
]
|
|
2563
|
+
},
|
|
2564
|
+
{
|
|
2565
|
+
"name": "show",
|
|
2566
|
+
"description": "Show a knowledge book: its metadata, then the summary of the pages it collects",
|
|
2567
|
+
"arguments": [
|
|
2568
|
+
{
|
|
2569
|
+
"name": "ID",
|
|
2570
|
+
"required": true,
|
|
2571
|
+
"description": "Knowledge book id"
|
|
2572
|
+
}
|
|
2573
|
+
],
|
|
2574
|
+
"examples": [
|
|
2575
|
+
"closeyourit kb book show <book-id>",
|
|
2576
|
+
"closeyourit kb book show <book-id> --json"
|
|
2577
|
+
]
|
|
2578
|
+
}
|
|
2579
|
+
]
|
|
2580
|
+
},
|
|
2466
2581
|
{
|
|
2467
2582
|
"name": "consolidate",
|
|
2468
2583
|
"description": "Mark an accepted page as written to the versioned docs, recording its path",
|
|
@@ -2688,6 +2803,82 @@
|
|
|
2688
2803
|
"closeyourit kb list --awaiting-consolidation"
|
|
2689
2804
|
]
|
|
2690
2805
|
},
|
|
2806
|
+
{
|
|
2807
|
+
"name": "publish",
|
|
2808
|
+
"description": "Idempotently create or update a Knowledge page by publication key.\n\nExactly one of --body or --body-file is required.",
|
|
2809
|
+
"options": [
|
|
2810
|
+
{
|
|
2811
|
+
"name": "--project",
|
|
2812
|
+
"aliases": [
|
|
2813
|
+
"-p"
|
|
2814
|
+
],
|
|
2815
|
+
"description": "Project id (UUID) or key",
|
|
2816
|
+
"required": true,
|
|
2817
|
+
"arguments": [
|
|
2818
|
+
{
|
|
2819
|
+
"name": "PROJECT",
|
|
2820
|
+
"required": true
|
|
2821
|
+
}
|
|
2822
|
+
]
|
|
2823
|
+
},
|
|
2824
|
+
{
|
|
2825
|
+
"name": "--publication-key",
|
|
2826
|
+
"description": "Stable publication key (1-255 URL-safe characters)",
|
|
2827
|
+
"required": true,
|
|
2828
|
+
"arguments": [
|
|
2829
|
+
{
|
|
2830
|
+
"name": "PUBLICATION-KEY",
|
|
2831
|
+
"required": true
|
|
2832
|
+
}
|
|
2833
|
+
]
|
|
2834
|
+
},
|
|
2835
|
+
{
|
|
2836
|
+
"name": "--title",
|
|
2837
|
+
"description": "Page title (max 255 characters)",
|
|
2838
|
+
"required": true,
|
|
2839
|
+
"arguments": [
|
|
2840
|
+
{
|
|
2841
|
+
"name": "TITLE",
|
|
2842
|
+
"required": true
|
|
2843
|
+
}
|
|
2844
|
+
]
|
|
2845
|
+
},
|
|
2846
|
+
{
|
|
2847
|
+
"name": "--kind",
|
|
2848
|
+
"description": "Page kind: note|decision|guide (new page: note; existing: unchanged)",
|
|
2849
|
+
"arguments": [
|
|
2850
|
+
{
|
|
2851
|
+
"name": "KIND",
|
|
2852
|
+
"required": true
|
|
2853
|
+
}
|
|
2854
|
+
]
|
|
2855
|
+
},
|
|
2856
|
+
{
|
|
2857
|
+
"name": "--body",
|
|
2858
|
+
"description": "Page body (markdown, max 4000 characters); exactly one of --body or --body-file is required",
|
|
2859
|
+
"arguments": [
|
|
2860
|
+
{
|
|
2861
|
+
"name": "BODY",
|
|
2862
|
+
"required": true
|
|
2863
|
+
}
|
|
2864
|
+
]
|
|
2865
|
+
},
|
|
2866
|
+
{
|
|
2867
|
+
"name": "--body-file",
|
|
2868
|
+
"description": "Read the page body (markdown, max 4000 characters) from a local file; exactly one of --body or --body-file is required",
|
|
2869
|
+
"arguments": [
|
|
2870
|
+
{
|
|
2871
|
+
"name": "BODY-FILE",
|
|
2872
|
+
"required": true
|
|
2873
|
+
}
|
|
2874
|
+
]
|
|
2875
|
+
}
|
|
2876
|
+
],
|
|
2877
|
+
"examples": [
|
|
2878
|
+
"closeyourit kb publish --project CYCL --publication-key docs:release --title \"Release guide\" --body \"Steps…\"",
|
|
2879
|
+
"closeyourit kb publish -p CYCL --publication-key docs:release --title \"Release guide\" --kind guide --body-file ./release.md"
|
|
2880
|
+
]
|
|
2881
|
+
},
|
|
2691
2882
|
{
|
|
2692
2883
|
"name": "related",
|
|
2693
2884
|
"description": "List the pages to read next: the ones this page links to (and that link to it), plus close matches by meaning",
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@bussolabs/closeyourit-cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.21.0",
|
|
4
4
|
"description": "CLI for CloseYourIt — manage org, errors, tokens and tickets with your user token",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"access": "public"
|
|
@@ -79,6 +79,9 @@
|
|
|
79
79
|
"kb": {
|
|
80
80
|
"description": "Knowledge base: pages (notes/decisions/guides), semantic search and AI ask"
|
|
81
81
|
},
|
|
82
|
+
"kb:book": {
|
|
83
|
+
"description": "Knowledge books: ordered collections of pages (summary, add a page)"
|
|
84
|
+
},
|
|
82
85
|
"todos": {
|
|
83
86
|
"description": "Personal todo lists: items, sharing, completion"
|
|
84
87
|
},
|