@ratiu5/starlight-search-cli 0.0.1 → 0.0.3
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 +40 -29
- package/bin.d.ts +2 -0
- package/bin.js +155 -0
- package/bin.js.map +1 -0
- package/package.json +39 -6
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025-present RATIU5
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,45 +1,56 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Starlight Search CLI
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
CLI tool for searching Starlight documentation and fetching llms.txt content.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## Installation
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
```sh
|
|
8
|
+
npm install -g @ratiu5/starlight-search-cli
|
|
9
|
+
```
|
|
8
10
|
|
|
9
|
-
##
|
|
11
|
+
## Commands
|
|
10
12
|
|
|
11
|
-
|
|
12
|
-
1. Configure OIDC trusted publishing for the package name `@ratiu5/starlight-search-cli`
|
|
13
|
-
2. Enable secure, token-less publishing from CI/CD workflows
|
|
14
|
-
3. Establish provenance for packages published under this name
|
|
13
|
+
### search
|
|
15
14
|
|
|
16
|
-
|
|
15
|
+
Search documentation for a keyword.
|
|
17
16
|
|
|
18
|
-
|
|
17
|
+
```sh
|
|
18
|
+
sls search -d https://docs.example.com "buffers"
|
|
19
|
+
```
|
|
19
20
|
|
|
20
|
-
|
|
21
|
+
**Options:**
|
|
21
22
|
|
|
22
|
-
|
|
23
|
+
- `-d, --domain` - API domain (e.g. `http://localhost:4321`)
|
|
23
24
|
|
|
24
|
-
|
|
25
|
-
2. Configure the trusted publisher (e.g., GitHub Actions)
|
|
26
|
-
3. Specify the repository and workflow that should be allowed to publish
|
|
27
|
-
4. Use the configured workflow to publish your actual package
|
|
25
|
+
**Output:**
|
|
28
26
|
|
|
29
|
-
|
|
27
|
+
```json
|
|
28
|
+
{
|
|
29
|
+
"results": [
|
|
30
|
+
{
|
|
31
|
+
"url": "https://docs.example.com/guide/buffers",
|
|
32
|
+
"title": "GPU Buffers",
|
|
33
|
+
"excerpt": "Learn about WebGPU buffers...",
|
|
34
|
+
"score": 0.95,
|
|
35
|
+
"llmsTxt": "https://docs.example.com/guide/buffers/_llms-txt"
|
|
36
|
+
}
|
|
37
|
+
],
|
|
38
|
+
"totalResults": 1
|
|
39
|
+
}
|
|
40
|
+
```
|
|
30
41
|
|
|
31
|
-
|
|
32
|
-
- Contains no executable code
|
|
33
|
-
- Provides no functionality
|
|
34
|
-
- Should not be installed as a dependency
|
|
35
|
-
- Exists only for administrative purposes
|
|
42
|
+
### show
|
|
36
43
|
|
|
37
|
-
|
|
44
|
+
Fetch and display llms.txt content from a URL.
|
|
38
45
|
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
46
|
+
```sh
|
|
47
|
+
sls show "https://docs.example.com/guide/buffers/_llms-txt"
|
|
48
|
+
```
|
|
42
49
|
|
|
43
|
-
|
|
50
|
+
## Development
|
|
44
51
|
|
|
45
|
-
|
|
52
|
+
```sh
|
|
53
|
+
pnpm dev # watch mode
|
|
54
|
+
pnpm build # build for production
|
|
55
|
+
pnpm typecheck
|
|
56
|
+
```
|
package/bin.d.ts
ADDED
package/bin.js
ADDED
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import * as NodeContext from '@effect/platform-node/NodeContext';
|
|
3
|
+
import * as NodeHttpClient from '@effect/platform-node/NodeHttpClient';
|
|
4
|
+
import * as NodeRuntime from '@effect/platform-node/NodeRuntime';
|
|
5
|
+
import * as Effect5 from 'effect/Effect';
|
|
6
|
+
import * as Layer5 from 'effect/Layer';
|
|
7
|
+
import { Command, Options, Args } from '@effect/cli';
|
|
8
|
+
import { Context, Schema, Data, Layer, Effect } from 'effect';
|
|
9
|
+
import { HttpClientRequest, HttpClientResponse, HttpClient } from '@effect/platform';
|
|
10
|
+
|
|
11
|
+
var ApiClient = class extends Context.Tag("ApiClient")() {
|
|
12
|
+
};
|
|
13
|
+
var makeApiClientLive = (baseUrl) => Layer.effect(
|
|
14
|
+
ApiClient,
|
|
15
|
+
Effect.gen(function* () {
|
|
16
|
+
const client = yield* HttpClient.HttpClient;
|
|
17
|
+
return {
|
|
18
|
+
client: client.pipe(
|
|
19
|
+
HttpClient.mapRequest(HttpClientRequest.prependUrl(baseUrl))
|
|
20
|
+
),
|
|
21
|
+
baseUrl
|
|
22
|
+
};
|
|
23
|
+
})
|
|
24
|
+
);
|
|
25
|
+
var SearchResult = Schema.Struct({
|
|
26
|
+
url: Schema.String,
|
|
27
|
+
title: Schema.String,
|
|
28
|
+
excerpt: Schema.String,
|
|
29
|
+
score: Schema.Number,
|
|
30
|
+
llmsTxt: Schema.String
|
|
31
|
+
});
|
|
32
|
+
var SearchResponse = Schema.Struct({
|
|
33
|
+
results: Schema.Array(SearchResult),
|
|
34
|
+
totalResults: Schema.Number
|
|
35
|
+
});
|
|
36
|
+
var SearchRequestError = class extends Data.TaggedError("SearchRequestError") {
|
|
37
|
+
};
|
|
38
|
+
var SearchParseError = class extends Data.TaggedError("SearchParseError") {
|
|
39
|
+
};
|
|
40
|
+
var SearchClient = class extends Context.Tag("SearchClient")() {
|
|
41
|
+
};
|
|
42
|
+
var SearchClientLive = Layer.effect(
|
|
43
|
+
SearchClient,
|
|
44
|
+
Effect.gen(function* () {
|
|
45
|
+
const { client } = yield* ApiClient;
|
|
46
|
+
return {
|
|
47
|
+
search: (query) => HttpClientRequest.post("/api/search").pipe(
|
|
48
|
+
HttpClientRequest.bodyJson({ query }),
|
|
49
|
+
Effect.flatMap(client.execute),
|
|
50
|
+
Effect.mapError((e) => new SearchRequestError({ cause: e })),
|
|
51
|
+
Effect.flatMap(HttpClientResponse.schemaBodyJson(SearchResponse)),
|
|
52
|
+
Effect.mapError(
|
|
53
|
+
(e) => e instanceof SearchRequestError ? e : new SearchParseError({ cause: e })
|
|
54
|
+
)
|
|
55
|
+
)
|
|
56
|
+
};
|
|
57
|
+
})
|
|
58
|
+
);
|
|
59
|
+
var ShowRequestError = class extends Data.TaggedError("ShowRequestError") {
|
|
60
|
+
};
|
|
61
|
+
var ShowInvalidUrl = class extends Data.TaggedError("ShowInvalidUrl") {
|
|
62
|
+
};
|
|
63
|
+
var ShowClient = class extends Context.Tag("ShowClient")() {
|
|
64
|
+
};
|
|
65
|
+
var ShowClientLive = Layer.effect(
|
|
66
|
+
ShowClient,
|
|
67
|
+
Effect.gen(function* () {
|
|
68
|
+
const client = yield* HttpClient.HttpClient;
|
|
69
|
+
return {
|
|
70
|
+
fetch: (url) => client.get(url).pipe(
|
|
71
|
+
Effect.flatMap((response) => response.text),
|
|
72
|
+
Effect.mapError((e) => new ShowRequestError({ cause: e }))
|
|
73
|
+
)
|
|
74
|
+
};
|
|
75
|
+
})
|
|
76
|
+
);
|
|
77
|
+
|
|
78
|
+
// src/Cli.ts
|
|
79
|
+
var command = Command.make("sls");
|
|
80
|
+
var searchDomain = Options.text("domain").pipe(
|
|
81
|
+
Options.withAlias("d"),
|
|
82
|
+
Options.withDescription("The root domain for the documentation API.")
|
|
83
|
+
);
|
|
84
|
+
var queryArg = Args.text({ name: "query" }).pipe(
|
|
85
|
+
Args.withDescription(
|
|
86
|
+
"The text used as the search term. Shorter queries are better."
|
|
87
|
+
)
|
|
88
|
+
);
|
|
89
|
+
var searchCommand = Command.make(
|
|
90
|
+
"search",
|
|
91
|
+
{ query: queryArg, domain: searchDomain },
|
|
92
|
+
({ domain, query }) => Effect.gen(function* () {
|
|
93
|
+
const searchClient = yield* SearchClient;
|
|
94
|
+
const response = yield* searchClient.search(query);
|
|
95
|
+
const results = response.results.map((d) => ({
|
|
96
|
+
...d,
|
|
97
|
+
url: `${domain}${d.url}`,
|
|
98
|
+
llmsTxt: `${domain}${d.llmsTxt}`
|
|
99
|
+
}));
|
|
100
|
+
console.log({ results, totalResults: response.totalResults });
|
|
101
|
+
}).pipe(
|
|
102
|
+
Effect.provide(
|
|
103
|
+
SearchClientLive.pipe(Layer.provide(makeApiClientLive(domain)))
|
|
104
|
+
),
|
|
105
|
+
Effect.catchTags({
|
|
106
|
+
SearchParseError: (e) => Effect.logError(e.cause).pipe(Effect.andThen(Effect.void)),
|
|
107
|
+
SearchRequestError: (e) => Effect.logError(e.cause).pipe(Effect.andThen(Effect.void))
|
|
108
|
+
})
|
|
109
|
+
)
|
|
110
|
+
).pipe(
|
|
111
|
+
Command.withDescription(
|
|
112
|
+
"Search the documentation for a specific keyword or string and get a list of search results."
|
|
113
|
+
)
|
|
114
|
+
);
|
|
115
|
+
var showUrl = Args.text({ name: "url" }).pipe(
|
|
116
|
+
Args.withDescription("A full URL path to an llms.txt resource.")
|
|
117
|
+
);
|
|
118
|
+
var showCommand = Command.make(
|
|
119
|
+
"show",
|
|
120
|
+
{ showUrl },
|
|
121
|
+
({ showUrl: showUrl2 }) => Effect.gen(function* () {
|
|
122
|
+
const showClient = yield* ShowClient;
|
|
123
|
+
if (!showUrl2.includes("_llms-txt") && !showUrl2.includes("llms.txt")) {
|
|
124
|
+
return yield* new ShowInvalidUrl({ cause: "Not a valid llms.txt file" });
|
|
125
|
+
}
|
|
126
|
+
const response = yield* showClient.fetch(showUrl2);
|
|
127
|
+
console.log(response);
|
|
128
|
+
}).pipe(
|
|
129
|
+
Effect.provide(ShowClientLive),
|
|
130
|
+
Effect.catchTags({
|
|
131
|
+
ShowInvalidUrl: (e) => Effect.logError(e.cause).pipe(Effect.andThen(Effect.void)),
|
|
132
|
+
ShowRequestError: (e) => Effect.logError(e.cause).pipe(Effect.andThen(Effect.void))
|
|
133
|
+
})
|
|
134
|
+
)
|
|
135
|
+
).pipe(
|
|
136
|
+
Command.withDescription(
|
|
137
|
+
"Show the LLM documentation for a specific url provided."
|
|
138
|
+
)
|
|
139
|
+
);
|
|
140
|
+
var commandWithSearch = command.pipe(
|
|
141
|
+
Command.withSubcommands([searchCommand, showCommand])
|
|
142
|
+
);
|
|
143
|
+
var run = Command.run(commandWithSearch, {
|
|
144
|
+
name: "Starlight Search",
|
|
145
|
+
version: "0.0.1"
|
|
146
|
+
});
|
|
147
|
+
|
|
148
|
+
// src/bin.ts
|
|
149
|
+
var MainLayer = Layer5.mergeAll(NodeContext.layer, NodeHttpClient.layer);
|
|
150
|
+
run(process.argv).pipe(
|
|
151
|
+
Effect5.provide(MainLayer),
|
|
152
|
+
NodeRuntime.runMain({ disableErrorReporting: true })
|
|
153
|
+
);
|
|
154
|
+
//# sourceMappingURL=bin.js.map
|
|
155
|
+
//# sourceMappingURL=bin.js.map
|
package/bin.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/HttpService.ts","../src/Search.ts","../src/Show.ts","../src/Cli.ts","../src/bin.ts"],"names":["Context","Layer","Effect","HttpClientRequest","Data","HttpClient","showUrl"],"mappings":";;;;;;;;;;AAGO,IAAM,YAAN,cAAwB,OAAA,CAAQ,GAAA,CAAI,WAAW,GAMpD,CAAE;AAAC,CAAA;AAEE,IAAM,iBAAA,GAAoB,CAAC,OAAA,KAChC,KAAA,CAAM,MAAA;AAAA,EACJ,SAAA;AAAA,EACA,MAAA,CAAO,IAAI,aAAa;AACtB,IAAA,MAAM,MAAA,GAAS,OAAO,UAAA,CAAW,UAAA;AACjC,IAAA,OAAO;AAAA,MACL,QAAQ,MAAA,CAAO,IAAA;AAAA,QACb,UAAA,CAAW,UAAA,CAAW,iBAAA,CAAkB,UAAA,CAAW,OAAO,CAAC;AAAA,OAC7D;AAAA,MACA;AAAA,KACF;AAAA,EACF,CAAC;AACH,CAAA;ACdK,IAAM,YAAA,GAAe,OAAO,MAAA,CAAO;AAAA,EACxC,KAAK,MAAA,CAAO,MAAA;AAAA,EACZ,OAAO,MAAA,CAAO,MAAA;AAAA,EACd,SAAS,MAAA,CAAO,MAAA;AAAA,EAChB,OAAO,MAAA,CAAO,MAAA;AAAA,EACd,SAAS,MAAA,CAAO;AAClB,CAAC,CAAA;AAEM,IAAM,cAAA,GAAiB,OAAO,MAAA,CAAO;AAAA,EAC1C,OAAA,EAAS,MAAA,CAAO,KAAA,CAAM,YAAY,CAAA;AAAA,EAClC,cAAc,MAAA,CAAO;AACvB,CAAC,CAAA;AAKM,IAAM,kBAAA,GAAN,cAAiC,IAAA,CAAK,WAAA,CAAY,oBAAoB,CAAA,CAE1E;AAAC,CAAA;AAEG,IAAM,gBAAA,GAAN,cAA+B,IAAA,CAAK,WAAA,CAAY,kBAAkB,CAAA,CAEtE;AAAC,CAAA;AAIG,IAAM,eAAN,cAA2BA,OAAAA,CAAQ,GAAA,CAAI,cAAc,GAO1D,CAAE;AAAC,CAAA;AAEE,IAAM,mBAAmBC,KAAAA,CAAM,MAAA;AAAA,EACpC,YAAA;AAAA,EACAC,MAAAA,CAAO,IAAI,aAAa;AACtB,IAAA,MAAM,EAAE,MAAA,EAAO,GAAI,OAAO,SAAA;AAC1B,IAAA,OAAO;AAAA,MACL,QAAQ,CAAC,KAAA,KACPC,iBAAAA,CAAkB,IAAA,CAAK,aAAa,CAAA,CAAE,IAAA;AAAA,QACpCA,iBAAAA,CAAkB,QAAA,CAAS,EAAE,KAAA,EAAO,CAAA;AAAA,QACpCD,MAAAA,CAAO,OAAA,CAAQ,MAAA,CAAO,OAAO,CAAA;AAAA,QAC7BA,MAAAA,CAAO,QAAA,CAAS,CAAC,CAAA,KAAM,IAAI,mBAAmB,EAAE,KAAA,EAAO,CAAA,EAAG,CAAC,CAAA;AAAA,QAC3DA,MAAAA,CAAO,OAAA,CAAQ,kBAAA,CAAmB,cAAA,CAAe,cAAc,CAAC,CAAA;AAAA,QAChEA,MAAAA,CAAO,QAAA;AAAA,UAAS,CAAC,CAAA,KACf,CAAA,YAAa,kBAAA,GACT,CAAA,GACA,IAAI,gBAAA,CAAiB,EAAE,KAAA,EAAO,CAAA,EAAG;AAAA;AACvC;AACF,KACJ;AAAA,EACF,CAAC;AACH,CAAA;AC5DO,IAAM,gBAAA,GAAN,cAA+BE,IAAAA,CAAK,WAAA,CAAY,kBAAkB,CAAA,CAItE;AAAC,CAAA;AAEG,IAAM,cAAA,GAAN,cAA6BA,IAAAA,CAAK,WAAA,CAAY,gBAAgB,CAAA,CAElE;AAAC,CAAA;AAEG,IAAM,aAAN,cAAyBJ,OAAAA,CAAQ,GAAA,CAAI,YAAY,GAKtD,CAAE;AAAC,CAAA;AAEE,IAAM,iBAAiBC,KAAAA,CAAM,MAAA;AAAA,EAClC,UAAA;AAAA,EACAC,MAAAA,CAAO,IAAI,aAAa;AACtB,IAAA,MAAM,MAAA,GAAS,OAAOG,UAAAA,CAAW,UAAA;AACjC,IAAA,OAAO;AAAA,MACL,OAAO,CAAC,GAAA,KACN,MAAA,CAAO,GAAA,CAAI,GAAG,CAAA,CAAE,IAAA;AAAA,QACdH,MAAAA,CAAO,OAAA,CAAQ,CAAC,QAAA,KAAa,SAAS,IAAI,CAAA;AAAA,QAC1CA,MAAAA,CAAO,QAAA,CAAS,CAAC,CAAA,KAAM,IAAI,iBAAiB,EAAE,KAAA,EAAO,CAAA,EAAG,CAAC;AAAA;AAC3D,KACJ;AAAA,EACF,CAAC;AACH,CAAA;;;AC1BA,IAAM,OAAA,GAAU,OAAA,CAAQ,IAAA,CAAK,KAAK,CAAA;AAElC,IAAM,YAAA,GAAe,OAAA,CAAQ,IAAA,CAAK,QAAQ,CAAA,CAAE,IAAA;AAAA,EAC1C,OAAA,CAAQ,UAAU,GAAG,CAAA;AAAA,EACrB,OAAA,CAAQ,gBAAgB,4CAA4C;AACtE,CAAA;AAEA,IAAM,WAAW,IAAA,CAAK,IAAA,CAAK,EAAE,IAAA,EAAM,OAAA,EAAS,CAAA,CAAE,IAAA;AAAA,EAC5C,IAAA,CAAK,eAAA;AAAA,IACH;AAAA;AAEJ,CAAA;AAEA,IAAM,gBAAgB,OAAA,CAAQ,IAAA;AAAA,EAC5B,QAAA;AAAA,EACA,EAAE,KAAA,EAAO,QAAA,EAAU,MAAA,EAAQ,YAAA,EAAa;AAAA,EACxC,CAAC,EAAE,MAAA,EAAQ,OAAM,KACfA,MAAAA,CAAO,IAAI,aAAa;AACtB,IAAA,MAAM,eAAe,OAAO,YAAA;AAC5B,IAAA,MAAM,QAAA,GAAW,OAAO,YAAA,CAAa,MAAA,CAAO,KAAK,CAAA;AACjD,IAAA,MAAM,OAAA,GAAU,QAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,CAAC,CAAA,MAAO;AAAA,MAC3C,GAAG,CAAA;AAAA,MACH,GAAA,EAAK,CAAA,EAAG,MAAM,CAAA,EAAG,EAAE,GAAG,CAAA,CAAA;AAAA,MACtB,OAAA,EAAS,CAAA,EAAG,MAAM,CAAA,EAAG,EAAE,OAAO,CAAA;AAAA,KAChC,CAAE,CAAA;AACF,IAAA,OAAA,CAAQ,IAAI,EAAE,OAAA,EAAS,YAAA,EAAc,QAAA,CAAS,cAAc,CAAA;AAAA,EAC9D,CAAC,CAAA,CAAE,IAAA;AAAA,IACDA,MAAAA,CAAO,OAAA;AAAA,MACL,iBAAiB,IAAA,CAAKD,KAAAA,CAAM,QAAQ,iBAAA,CAAkB,MAAM,CAAC,CAAC;AAAA,KAChE;AAAA,IACAC,OAAO,SAAA,CAAU;AAAA,MACf,gBAAA,EAAkB,CAAC,CAAA,KACjBA,MAAAA,CAAO,QAAA,CAAS,CAAA,CAAE,KAAK,CAAA,CAAE,IAAA,CAAKA,MAAAA,CAAO,OAAA,CAAQA,MAAAA,CAAO,IAAI,CAAC,CAAA;AAAA,MAC3D,kBAAA,EAAoB,CAAC,CAAA,KACnBA,MAAAA,CAAO,QAAA,CAAS,CAAA,CAAE,KAAK,CAAA,CAAE,IAAA,CAAKA,MAAAA,CAAO,OAAA,CAAQA,MAAAA,CAAO,IAAI,CAAC;AAAA,KAC5D;AAAA;AAEP,CAAA,CAAE,IAAA;AAAA,EACA,OAAA,CAAQ,eAAA;AAAA,IACN;AAAA;AAEJ,CAAA;AAEA,IAAM,UAAU,IAAA,CAAK,IAAA,CAAK,EAAE,IAAA,EAAM,KAAA,EAAO,CAAA,CAAE,IAAA;AAAA,EACzC,IAAA,CAAK,gBAAgB,0CAA0C;AACjE,CAAA;AAEA,IAAM,cAAc,OAAA,CAAQ,IAAA;AAAA,EAAK,MAAA;AAAA,EAAQ,EAAE,OAAA,EAAQ;AAAA,EAAG,CAAC,EAAE,OAAA,EAAAI,UAAQ,KAC/DJ,MAAAA,CAAO,IAAI,aAAa;AACtB,IAAA,MAAM,aAAa,OAAO,UAAA;AAC1B,IAAA,IAAI,CAACI,SAAQ,QAAA,CAAS,WAAW,KAAK,CAACA,QAAAA,CAAQ,QAAA,CAAS,UAAU,CAAA,EAAG;AACnE,MAAA,OAAO,OAAO,IAAI,cAAA,CAAe,EAAE,KAAA,EAAO,6BAA6B,CAAA;AAAA,IACzE;AACA,IAAA,MAAM,QAAA,GAAW,OAAO,UAAA,CAAW,KAAA,CAAMA,QAAO,CAAA;AAChD,IAAA,OAAA,CAAQ,IAAI,QAAQ,CAAA;AAAA,EACtB,CAAC,CAAA,CAAE,IAAA;AAAA,IACDJ,MAAAA,CAAO,QAAQ,cAAc,CAAA;AAAA,IAC7BA,OAAO,SAAA,CAAU;AAAA,MACf,cAAA,EAAgB,CAAC,CAAA,KACfA,MAAAA,CAAO,QAAA,CAAS,CAAA,CAAE,KAAK,CAAA,CAAE,IAAA,CAAKA,MAAAA,CAAO,OAAA,CAAQA,MAAAA,CAAO,IAAI,CAAC,CAAA;AAAA,MAC3D,gBAAA,EAAkB,CAAC,CAAA,KACjBA,MAAAA,CAAO,QAAA,CAAS,CAAA,CAAE,KAAK,CAAA,CAAE,IAAA,CAAKA,MAAAA,CAAO,OAAA,CAAQA,MAAAA,CAAO,IAAI,CAAC;AAAA,KAC5D;AAAA;AAEL,CAAA,CAAE,IAAA;AAAA,EACA,OAAA,CAAQ,eAAA;AAAA,IACN;AAAA;AAEJ,CAAA;AAEA,IAAM,oBAAoB,OAAA,CAAQ,IAAA;AAAA,EAChC,OAAA,CAAQ,eAAA,CAAgB,CAAC,aAAA,EAAe,WAAW,CAAC;AACtD,CAAA;AAEO,IAAM,GAAA,GAAM,OAAA,CAAQ,GAAA,CAAI,iBAAA,EAAmB;AAAA,EAChD,IAAA,EAAM,kBAAA;AAAA,EACN,OAAA,EAAS;AACX,CAAC,CAAA;;;AC5ED,IAAM,SAAA,GAAkB,MAAA,CAAA,QAAA,CAAqB,WAAA,CAAA,KAAA,EAAsB,cAAA,CAAA,KAAK,CAAA;AAExE,GAAA,CAAI,OAAA,CAAQ,IAAI,CAAA,CAAE,IAAA;AAAA,EACT,gBAAQ,SAAS,CAAA;AAAA,EACZ,WAAA,CAAA,OAAA,CAAQ,EAAE,qBAAA,EAAuB,IAAA,EAAM;AACrD,CAAA","file":"bin.js","sourcesContent":["import { HttpClient, HttpClientRequest } from \"@effect/platform\";\nimport { Context, Effect, Layer } from \"effect\";\n\nexport class ApiClient extends Context.Tag(\"ApiClient\")<\n ApiClient,\n {\n readonly client: HttpClient.HttpClient;\n readonly baseUrl: string;\n }\n>() {}\n\nexport const makeApiClientLive = (baseUrl: string) =>\n Layer.effect(\n ApiClient,\n Effect.gen(function* () {\n const client = yield* HttpClient.HttpClient;\n return {\n client: client.pipe(\n HttpClient.mapRequest(HttpClientRequest.prependUrl(baseUrl)),\n ),\n baseUrl,\n };\n }),\n );\n","import {\n type HttpBody,\n type HttpClientError,\n HttpClientRequest,\n HttpClientResponse,\n} from \"@effect/platform\";\nimport { Context, Data, Effect, Layer, type ParseResult, Schema } from \"effect\";\nimport { ApiClient } from \"./HttpService.js\";\n\nexport const SearchResult = Schema.Struct({\n url: Schema.String,\n title: Schema.String,\n excerpt: Schema.String,\n score: Schema.Number,\n llmsTxt: Schema.String,\n});\n\nexport const SearchResponse = Schema.Struct({\n results: Schema.Array(SearchResult),\n totalResults: Schema.Number,\n});\n\nexport type SearchResult = typeof SearchResult.Type;\nexport type SearchResponse = typeof SearchResponse.Type;\n\nexport class SearchRequestError extends Data.TaggedError(\"SearchRequestError\")<{\n readonly cause: HttpClientError.HttpClientError | HttpBody.HttpBodyError;\n}> {}\n\nexport class SearchParseError extends Data.TaggedError(\"SearchParseError\")<{\n readonly cause: ParseResult.ParseError | HttpClientError.ResponseError;\n}> {}\n\nexport type SearchError = SearchRequestError | SearchParseError;\n\nexport class SearchClient extends Context.Tag(\"SearchClient\")<\n SearchClient,\n {\n readonly search: (\n query: string,\n ) => Effect.Effect<SearchResponse, SearchError>;\n }\n>() {}\n\nexport const SearchClientLive = Layer.effect(\n SearchClient,\n Effect.gen(function* () {\n const { client } = yield* ApiClient;\n return {\n search: (query: string) =>\n HttpClientRequest.post(\"/api/search\").pipe(\n HttpClientRequest.bodyJson({ query }),\n Effect.flatMap(client.execute),\n Effect.mapError((e) => new SearchRequestError({ cause: e })),\n Effect.flatMap(HttpClientResponse.schemaBodyJson(SearchResponse)),\n Effect.mapError((e) =>\n e instanceof SearchRequestError\n ? e\n : new SearchParseError({ cause: e }),\n ),\n ),\n };\n }),\n);\n","import { HttpClient, type HttpClientError } from \"@effect/platform\";\nimport { Context, Data, Effect, Layer } from \"effect\";\n\nexport class ShowRequestError extends Data.TaggedError(\"ShowRequestError\")<{\n readonly cause:\n | HttpClientError.HttpClientError\n | HttpClientError.ResponseError;\n}> {}\n\nexport class ShowInvalidUrl extends Data.TaggedError(\"ShowInvalidUrl\")<{\n readonly cause: string;\n}> {}\n\nexport class ShowClient extends Context.Tag(\"ShowClient\")<\n ShowClient,\n {\n readonly fetch: (url: string) => Effect.Effect<string, ShowRequestError>;\n }\n>() {}\n\nexport const ShowClientLive = Layer.effect(\n ShowClient,\n Effect.gen(function* () {\n const client = yield* HttpClient.HttpClient;\n return {\n fetch: (url: string) =>\n client.get(url).pipe(\n Effect.flatMap((response) => response.text),\n Effect.mapError((e) => new ShowRequestError({ cause: e })),\n ),\n };\n }),\n);\n","import { Args, Command, Options } from \"@effect/cli\";\nimport { Effect, Layer } from \"effect\";\nimport { makeApiClientLive } from \"./HttpService.js\";\nimport { SearchClient, SearchClientLive } from \"./Search.js\";\nimport { ShowClient, ShowClientLive, ShowInvalidUrl } from \"./Show.js\";\n\nconst command = Command.make(\"sls\");\n\nconst searchDomain = Options.text(\"domain\").pipe(\n Options.withAlias(\"d\"),\n Options.withDescription(\"The root domain for the documentation API.\"),\n);\n\nconst queryArg = Args.text({ name: \"query\" }).pipe(\n Args.withDescription(\n \"The text used as the search term. Shorter queries are better.\",\n ),\n);\n\nconst searchCommand = Command.make(\n \"search\",\n { query: queryArg, domain: searchDomain },\n ({ domain, query }) =>\n Effect.gen(function* () {\n const searchClient = yield* SearchClient;\n const response = yield* searchClient.search(query);\n const results = response.results.map((d) => ({\n ...d,\n url: `${domain}${d.url}`,\n llmsTxt: `${domain}${d.llmsTxt}`,\n }));\n console.log({ results, totalResults: response.totalResults });\n }).pipe(\n Effect.provide(\n SearchClientLive.pipe(Layer.provide(makeApiClientLive(domain))),\n ),\n Effect.catchTags({\n SearchParseError: (e) =>\n Effect.logError(e.cause).pipe(Effect.andThen(Effect.void)),\n SearchRequestError: (e) =>\n Effect.logError(e.cause).pipe(Effect.andThen(Effect.void)),\n }),\n ),\n).pipe(\n Command.withDescription(\n \"Search the documentation for a specific keyword or string and get a list of search results.\",\n ),\n);\n\nconst showUrl = Args.text({ name: \"url\" }).pipe(\n Args.withDescription(\"A full URL path to an llms.txt resource.\"),\n);\n\nconst showCommand = Command.make(\"show\", { showUrl }, ({ showUrl }) =>\n Effect.gen(function* () {\n const showClient = yield* ShowClient;\n if (!showUrl.includes(\"_llms-txt\") && !showUrl.includes(\"llms.txt\")) {\n return yield* new ShowInvalidUrl({ cause: \"Not a valid llms.txt file\" });\n }\n const response = yield* showClient.fetch(showUrl);\n console.log(response);\n }).pipe(\n Effect.provide(ShowClientLive),\n Effect.catchTags({\n ShowInvalidUrl: (e) =>\n Effect.logError(e.cause).pipe(Effect.andThen(Effect.void)),\n ShowRequestError: (e) =>\n Effect.logError(e.cause).pipe(Effect.andThen(Effect.void)),\n }),\n ),\n).pipe(\n Command.withDescription(\n \"Show the LLM documentation for a specific url provided.\",\n ),\n);\n\nconst commandWithSearch = command.pipe(\n Command.withSubcommands([searchCommand, showCommand]),\n);\n\nexport const run = Command.run(commandWithSearch, {\n name: \"Starlight Search\",\n version: \"0.0.1\",\n});\n","import * as NodeContext from \"@effect/platform-node/NodeContext\";\nimport * as NodeHttpClient from \"@effect/platform-node/NodeHttpClient\";\nimport * as NodeRuntime from \"@effect/platform-node/NodeRuntime\";\nimport * as Effect from \"effect/Effect\";\nimport * as Layer from \"effect/Layer\";\nimport { run } from \"./Cli.js\";\n\nconst MainLayer = Layer.mergeAll(NodeContext.layer, NodeHttpClient.layer);\n\nrun(process.argv).pipe(\n Effect.provide(MainLayer),\n NodeRuntime.runMain({ disableErrorReporting: true }),\n);\n"]}
|
package/package.json
CHANGED
|
@@ -1,10 +1,43 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ratiu5/starlight-search-cli",
|
|
3
|
-
"version": "0.0.
|
|
4
|
-
"
|
|
3
|
+
"version": "0.0.3",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"description": "Starlight search CLI",
|
|
6
|
+
"main": "bin.js",
|
|
7
|
+
"types": "bin.d.ts",
|
|
8
|
+
"bin": {
|
|
9
|
+
"sls": "bin.js"
|
|
10
|
+
},
|
|
11
|
+
"files": [
|
|
12
|
+
"bin.js",
|
|
13
|
+
"bin.d.ts",
|
|
14
|
+
"bin.js.map"
|
|
15
|
+
],
|
|
16
|
+
"engines": {
|
|
17
|
+
"node": ">=20.0.0"
|
|
18
|
+
},
|
|
19
|
+
"dependencies": {
|
|
20
|
+
"@effect/cli": "^0.69.0",
|
|
21
|
+
"@effect/platform": "^0.90.3",
|
|
22
|
+
"@effect/platform-node": "^0.96.0",
|
|
23
|
+
"effect": "^3.17.7"
|
|
24
|
+
},
|
|
25
|
+
"repository": {
|
|
26
|
+
"type": "git",
|
|
27
|
+
"url": "https://github.com/RATIU5/webgpu-llm.git",
|
|
28
|
+
"directory": "packages/search-cli"
|
|
29
|
+
},
|
|
30
|
+
"author": "RATIU5",
|
|
31
|
+
"license": "MIT",
|
|
32
|
+
"bugs": {
|
|
33
|
+
"url": "https://github.com/RATIU5/webgpu-llm/issues"
|
|
34
|
+
},
|
|
35
|
+
"homepage": "https://github.com/RATIU5/webgpu-llm#readme",
|
|
5
36
|
"keywords": [
|
|
6
|
-
"
|
|
7
|
-
"
|
|
8
|
-
"
|
|
37
|
+
"starlight",
|
|
38
|
+
"search",
|
|
39
|
+
"cli",
|
|
40
|
+
"astro",
|
|
41
|
+
"documentation"
|
|
9
42
|
]
|
|
10
|
-
}
|
|
43
|
+
}
|