@ratiu5/starlight-search-cli 0.0.2 → 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/README.md +56 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# Starlight Search CLI
|
|
2
|
+
|
|
3
|
+
CLI tool for searching Starlight documentation and fetching llms.txt content.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm install -g @ratiu5/starlight-search-cli
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Commands
|
|
12
|
+
|
|
13
|
+
### search
|
|
14
|
+
|
|
15
|
+
Search documentation for a keyword.
|
|
16
|
+
|
|
17
|
+
```sh
|
|
18
|
+
sls search -d https://docs.example.com "buffers"
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
**Options:**
|
|
22
|
+
|
|
23
|
+
- `-d, --domain` - API domain (e.g. `http://localhost:4321`)
|
|
24
|
+
|
|
25
|
+
**Output:**
|
|
26
|
+
|
|
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
|
+
```
|
|
41
|
+
|
|
42
|
+
### show
|
|
43
|
+
|
|
44
|
+
Fetch and display llms.txt content from a URL.
|
|
45
|
+
|
|
46
|
+
```sh
|
|
47
|
+
sls show "https://docs.example.com/guide/buffers/_llms-txt"
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Development
|
|
51
|
+
|
|
52
|
+
```sh
|
|
53
|
+
pnpm dev # watch mode
|
|
54
|
+
pnpm build # build for production
|
|
55
|
+
pnpm typecheck
|
|
56
|
+
```
|