@knowledgesdk/cli 0.1.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/LICENSE +21 -0
- package/README.md +263 -0
- package/dist/commands/classify.d.ts +3 -0
- package/dist/commands/classify.d.ts.map +1 -0
- package/dist/commands/classify.js +45 -0
- package/dist/commands/classify.js.map +1 -0
- package/dist/commands/config.d.ts +3 -0
- package/dist/commands/config.d.ts.map +1 -0
- package/dist/commands/config.js +63 -0
- package/dist/commands/config.js.map +1 -0
- package/dist/commands/extract.d.ts +3 -0
- package/dist/commands/extract.d.ts.map +1 -0
- package/dist/commands/extract.js +136 -0
- package/dist/commands/extract.js.map +1 -0
- package/dist/commands/jobs.d.ts +3 -0
- package/dist/commands/jobs.d.ts.map +1 -0
- package/dist/commands/jobs.js +121 -0
- package/dist/commands/jobs.js.map +1 -0
- package/dist/commands/scrape.d.ts +3 -0
- package/dist/commands/scrape.d.ts.map +1 -0
- package/dist/commands/scrape.js +48 -0
- package/dist/commands/scrape.js.map +1 -0
- package/dist/commands/screenshot.d.ts +3 -0
- package/dist/commands/screenshot.d.ts.map +1 -0
- package/dist/commands/screenshot.js +58 -0
- package/dist/commands/screenshot.js.map +1 -0
- package/dist/commands/search.d.ts +3 -0
- package/dist/commands/search.d.ts.map +1 -0
- package/dist/commands/search.js +51 -0
- package/dist/commands/search.js.map +1 -0
- package/dist/commands/sitemap.d.ts +3 -0
- package/dist/commands/sitemap.d.ts.map +1 -0
- package/dist/commands/sitemap.js +45 -0
- package/dist/commands/sitemap.js.map +1 -0
- package/dist/commands/webhooks.d.ts +3 -0
- package/dist/commands/webhooks.d.ts.map +1 -0
- package/dist/commands/webhooks.js +118 -0
- package/dist/commands/webhooks.js.map +1 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +68 -0
- package/dist/index.js.map +1 -0
- package/dist/lib/api.d.ts +71 -0
- package/dist/lib/api.d.ts.map +1 -0
- package/dist/lib/api.js +212 -0
- package/dist/lib/api.js.map +1 -0
- package/dist/lib/config.d.ts +23 -0
- package/dist/lib/config.d.ts.map +1 -0
- package/dist/lib/config.js +59 -0
- package/dist/lib/config.js.map +1 -0
- package/dist/lib/output.d.ts +73 -0
- package/dist/lib/output.d.ts.map +1 -0
- package/dist/lib/output.js +149 -0
- package/dist/lib/output.js.map +1 -0
- package/dist/types.d.ts +127 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +3 -0
- package/dist/types.js.map +1 -0
- package/package.json +43 -0
package/dist/types.d.ts
ADDED
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
export interface CLIConfig {
|
|
2
|
+
apiKey?: string;
|
|
3
|
+
baseUrl?: string;
|
|
4
|
+
}
|
|
5
|
+
export interface ApiError {
|
|
6
|
+
error: string;
|
|
7
|
+
message?: string;
|
|
8
|
+
statusCode?: number;
|
|
9
|
+
}
|
|
10
|
+
export interface ExtractOptions {
|
|
11
|
+
async?: boolean;
|
|
12
|
+
callbackUrl?: string;
|
|
13
|
+
maxPages?: number;
|
|
14
|
+
output?: string;
|
|
15
|
+
}
|
|
16
|
+
export interface ExtractionJob {
|
|
17
|
+
jobId: string;
|
|
18
|
+
status: JobStatus;
|
|
19
|
+
url: string;
|
|
20
|
+
createdAt: string;
|
|
21
|
+
completedAt?: string;
|
|
22
|
+
result?: ExtractionResult;
|
|
23
|
+
}
|
|
24
|
+
export interface ExtractionResult {
|
|
25
|
+
url: string;
|
|
26
|
+
pages: PageResult[];
|
|
27
|
+
summary?: string;
|
|
28
|
+
totalPages: number;
|
|
29
|
+
metadata?: Record<string, unknown>;
|
|
30
|
+
}
|
|
31
|
+
export interface PageResult {
|
|
32
|
+
url: string;
|
|
33
|
+
title?: string;
|
|
34
|
+
content?: string;
|
|
35
|
+
markdown?: string;
|
|
36
|
+
metadata?: Record<string, unknown>;
|
|
37
|
+
}
|
|
38
|
+
export interface ScrapeOptions {
|
|
39
|
+
output?: string;
|
|
40
|
+
}
|
|
41
|
+
export interface ScrapeResult {
|
|
42
|
+
url: string;
|
|
43
|
+
markdown: string;
|
|
44
|
+
title?: string;
|
|
45
|
+
metadata?: Record<string, unknown>;
|
|
46
|
+
}
|
|
47
|
+
export interface ClassifyOptions {
|
|
48
|
+
json?: boolean;
|
|
49
|
+
}
|
|
50
|
+
export interface ClassifyResult {
|
|
51
|
+
url: string;
|
|
52
|
+
category: string;
|
|
53
|
+
subcategory?: string;
|
|
54
|
+
confidence: number;
|
|
55
|
+
tags?: string[];
|
|
56
|
+
description?: string;
|
|
57
|
+
metadata?: Record<string, unknown>;
|
|
58
|
+
}
|
|
59
|
+
export interface SitemapResult {
|
|
60
|
+
url: string;
|
|
61
|
+
pages: SitemapPage[];
|
|
62
|
+
totalPages: number;
|
|
63
|
+
}
|
|
64
|
+
export interface SitemapPage {
|
|
65
|
+
url: string;
|
|
66
|
+
lastModified?: string;
|
|
67
|
+
changeFrequency?: string;
|
|
68
|
+
priority?: number;
|
|
69
|
+
}
|
|
70
|
+
export interface ScreenshotOptions {
|
|
71
|
+
output?: string;
|
|
72
|
+
}
|
|
73
|
+
export interface ScreenshotResult {
|
|
74
|
+
url: string;
|
|
75
|
+
imageBase64?: string;
|
|
76
|
+
imageUrl?: string;
|
|
77
|
+
width?: number;
|
|
78
|
+
height?: number;
|
|
79
|
+
}
|
|
80
|
+
export interface SearchOptions {
|
|
81
|
+
limit?: number;
|
|
82
|
+
json?: boolean;
|
|
83
|
+
}
|
|
84
|
+
export interface SearchResult {
|
|
85
|
+
query: string;
|
|
86
|
+
results: SearchItem[];
|
|
87
|
+
total: number;
|
|
88
|
+
}
|
|
89
|
+
export interface SearchItem {
|
|
90
|
+
id: string;
|
|
91
|
+
url: string;
|
|
92
|
+
title?: string;
|
|
93
|
+
snippet?: string;
|
|
94
|
+
score?: number;
|
|
95
|
+
metadata?: Record<string, unknown>;
|
|
96
|
+
}
|
|
97
|
+
export type WebhookEvent = 'EXTRACTION_COMPLETED' | 'EXTRACTION_FAILED' | 'PAGE_SCRAPED' | 'JOB_STARTED' | 'JOB_FAILED';
|
|
98
|
+
export interface Webhook {
|
|
99
|
+
id: string;
|
|
100
|
+
url: string;
|
|
101
|
+
events: WebhookEvent[];
|
|
102
|
+
active: boolean;
|
|
103
|
+
createdAt: string;
|
|
104
|
+
updatedAt?: string;
|
|
105
|
+
}
|
|
106
|
+
export interface WebhookListResult {
|
|
107
|
+
webhooks: Webhook[];
|
|
108
|
+
total: number;
|
|
109
|
+
}
|
|
110
|
+
export interface CreateWebhookOptions {
|
|
111
|
+
url: string;
|
|
112
|
+
events: string;
|
|
113
|
+
}
|
|
114
|
+
export type JobStatus = 'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED';
|
|
115
|
+
export interface Job {
|
|
116
|
+
jobId: string;
|
|
117
|
+
status: JobStatus;
|
|
118
|
+
type?: string;
|
|
119
|
+
url?: string;
|
|
120
|
+
createdAt: string;
|
|
121
|
+
updatedAt?: string;
|
|
122
|
+
completedAt?: string;
|
|
123
|
+
error?: string;
|
|
124
|
+
result?: unknown;
|
|
125
|
+
progress?: number;
|
|
126
|
+
}
|
|
127
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,SAAS;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAID,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAID,MAAM,WAAW,cAAc;IAC7B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,SAAS,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,gBAAgB,CAAC;CAC3B;AAED,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAID,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAID,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAID,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAID,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAID,MAAM,WAAW,aAAa;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAID,MAAM,MAAM,YAAY,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,cAAc,GACd,aAAa,GACb,YAAY,CAAC;AAEjB,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,YAAY,EAAE,CAAC;IACvB,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;CAChB;AAID,MAAM,MAAM,SAAS,GACjB,SAAS,GACT,SAAS,GACT,WAAW,GACX,QAAQ,GACR,WAAW,CAAC;AAEhB,MAAM,WAAW,GAAG;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,SAAS,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}
|
package/dist/types.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,gFAAgF"}
|
package/package.json
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@knowledgesdk/cli",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "CLI tool for KnowledgeSDK - extract, scrape, classify, search and manage knowledge from websites",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "./dist/index.js",
|
|
7
|
+
"bin": {
|
|
8
|
+
"knowledgesdk": "./dist/index.js"
|
|
9
|
+
},
|
|
10
|
+
"scripts": {
|
|
11
|
+
"build": "tsc",
|
|
12
|
+
"dev": "tsc --watch",
|
|
13
|
+
"start": "node ./dist/index.js",
|
|
14
|
+
"prepublishOnly": "npm run build"
|
|
15
|
+
},
|
|
16
|
+
"keywords": [
|
|
17
|
+
"knowledgesdk",
|
|
18
|
+
"cli",
|
|
19
|
+
"knowledge",
|
|
20
|
+
"extract",
|
|
21
|
+
"scrape",
|
|
22
|
+
"ai"
|
|
23
|
+
],
|
|
24
|
+
"author": "KnowledgeSDK",
|
|
25
|
+
"license": "MIT",
|
|
26
|
+
"dependencies": {
|
|
27
|
+
"@microsoft/fetch-event-source": "^2.0.1",
|
|
28
|
+
"chalk": "^5.3.0",
|
|
29
|
+
"commander": "^12.1.0",
|
|
30
|
+
"ora": "^8.0.1"
|
|
31
|
+
},
|
|
32
|
+
"devDependencies": {
|
|
33
|
+
"@types/node": "^20.14.0",
|
|
34
|
+
"typescript": "^5.4.0"
|
|
35
|
+
},
|
|
36
|
+
"engines": {
|
|
37
|
+
"node": ">=18.0.0"
|
|
38
|
+
},
|
|
39
|
+
"files": [
|
|
40
|
+
"dist",
|
|
41
|
+
"README.md"
|
|
42
|
+
]
|
|
43
|
+
}
|