watchdocs 0.1.6 → 0.1.8
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
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# WatchDocs CLI
|
|
2
2
|
|
|
3
|
-
A lightweight CLI tool that scans a project for dependencies and returns their official documentation URLs as
|
|
3
|
+
A lightweight CLI tool that scans a project for dependencies and returns their official documentation URLs as Markdown — built for AI agents and developers.
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
@@ -22,17 +22,16 @@ Recursively scans the current directory for manifest files, parses dependencies,
|
|
|
22
22
|
watchdocs scan
|
|
23
23
|
watchdocs scan --path ./frontend
|
|
24
24
|
watchdocs scan --ecosystem npm,go
|
|
25
|
-
watchdocs scan --
|
|
25
|
+
watchdocs scan --detailed
|
|
26
26
|
```
|
|
27
27
|
|
|
28
28
|
| Flag | Description |
|
|
29
29
|
|---|---|
|
|
30
30
|
| `--path <dir>` | Target a specific directory instead of cwd |
|
|
31
31
|
| `--ecosystem <list>` | Filter by ecosystem(s), comma-separated |
|
|
32
|
-
| `--
|
|
32
|
+
| `--detailed, -d` | Show detailed output with package metadata |
|
|
33
33
|
| `--clear-cache` | Clear the local cache before scanning |
|
|
34
34
|
| `--no-cache` | Disable reading and writing to the local cache |
|
|
35
|
-
| `--format, -f <format>` | Output format: `json` (default) or `list` |
|
|
36
35
|
|
|
37
36
|
---
|
|
38
37
|
|
|
@@ -43,39 +42,34 @@ Look up a single package by name without needing a manifest file.
|
|
|
43
42
|
```bash
|
|
44
43
|
watchdocs lookup express --ecosystem npm
|
|
45
44
|
watchdocs lookup github.com/spf13/cobra --ecosystem go
|
|
46
|
-
watchdocs lookup requests --ecosystem pip --
|
|
45
|
+
watchdocs lookup requests --ecosystem pip --detailed
|
|
47
46
|
```
|
|
48
47
|
|
|
49
48
|
| Flag | Description |
|
|
50
49
|
|---|---|
|
|
51
50
|
| `--ecosystem <eco>` | Required — one of: `npm`, `go`, `pip`, `cargo`, `pub`, `maven` |
|
|
52
|
-
| `--
|
|
51
|
+
| `--detailed, -d` | Show detailed output with package metadata |
|
|
53
52
|
| `--clear-cache` | Clear the local cache before looking up |
|
|
54
53
|
| `--no-cache` | Disable reading and writing to the local cache |
|
|
55
|
-
| `--format, -f <format>` | Output format: `json` (default) or `list` |
|
|
56
54
|
|
|
57
55
|
---
|
|
58
56
|
|
|
59
57
|
## Output
|
|
60
58
|
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
"ecosystem": "npm",
|
|
70
|
-
"type": "prod",
|
|
71
|
-
"docUrl": "https://expressjs.com",
|
|
72
|
-
"status": "resolved"
|
|
73
|
-
}
|
|
74
|
-
]
|
|
75
|
-
}
|
|
59
|
+
With `--detailed` (or `-d`):
|
|
60
|
+
```markdown
|
|
61
|
+
### Scan Summary
|
|
62
|
+
- **Scanned Manifests:** go.mod, package.json
|
|
63
|
+
- **Total Dependencies:** 5
|
|
64
|
+
|
|
65
|
+
### Results
|
|
66
|
+
- **express** - https://expressjs.com (`^4.18.0`) — `npm` (`prod`) — `resolved`
|
|
76
67
|
```
|
|
77
68
|
|
|
78
|
-
`
|
|
69
|
+
Without `--detailed` (Default - recommended for agents to save context tokens):
|
|
70
|
+
```markdown
|
|
71
|
+
- **express** - https://expressjs.com
|
|
72
|
+
```
|
|
79
73
|
|
|
80
74
|
---
|
|
81
75
|
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "watchdocs",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.8",
|
|
4
4
|
"description": "An LLM-friendly NPM CLI tool for AI agents and developers to scan project dependencies and instantly extract official documentation URLs.",
|
|
5
5
|
"keywords": ["watchdocs", "ai-agents", "llm-tools", "cli-tool", "dependency-scanner", "documentation-finder", "npm-cli", "project-scan", "agentic"],
|
|
6
6
|
"license": "MIT",
|