watchdocs 0.1.7 → 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.
Files changed (5) hide show
  1. package/README.md +8 -8
  2. package/binaries/watchdocs-darwin-arm64 +0 -0
  3. package/binaries/watchdocs-linux-x64 +0 -0
  4. package/binaries/watchdocs-win32-x64.exe +0 -0
  5. package/package.json +1 -1
package/README.md CHANGED
@@ -22,14 +22,14 @@ 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 --slim
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
- | `--slim` | Return only `name` and `docUrl` per result (saves tokens) |
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
35
 
@@ -42,13 +42,13 @@ Look up a single package by name without needing a manifest file.
42
42
  ```bash
43
43
  watchdocs lookup express --ecosystem npm
44
44
  watchdocs lookup github.com/spf13/cobra --ecosystem go
45
- watchdocs lookup requests --ecosystem pip --slim
45
+ watchdocs lookup requests --ecosystem pip --detailed
46
46
  ```
47
47
 
48
48
  | Flag | Description |
49
49
  |---|---|
50
50
  | `--ecosystem <eco>` | Required — one of: `npm`, `go`, `pip`, `cargo`, `pub`, `maven` |
51
- | `--slim` | Return only `name` and `docUrl` |
51
+ | `--detailed, -d` | Show detailed output with package metadata |
52
52
  | `--clear-cache` | Clear the local cache before looking up |
53
53
  | `--no-cache` | Disable reading and writing to the local cache |
54
54
 
@@ -56,19 +56,19 @@ watchdocs lookup requests --ecosystem pip --slim
56
56
 
57
57
  ## Output
58
58
 
59
- Without `--slim`:
59
+ With `--detailed` (or `-d`):
60
60
  ```markdown
61
61
  ### Scan Summary
62
62
  - **Scanned Manifests:** go.mod, package.json
63
63
  - **Total Dependencies:** 5
64
64
 
65
65
  ### Results
66
- - **express** - [docs](https://expressjs.com) (`^4.18.0`) — `npm` (`prod`) — `resolved`
66
+ - **express** - https://expressjs.com (`^4.18.0`) — `npm` (`prod`) — `resolved`
67
67
  ```
68
68
 
69
- With `--slim` (recommended for agents to save context tokens):
69
+ Without `--detailed` (Default - recommended for agents to save context tokens):
70
70
  ```markdown
71
- - **express** - [docs](https://expressjs.com)
71
+ - **express** - https://expressjs.com
72
72
  ```
73
73
 
74
74
  ---
package/binaries/watchdocs-darwin-arm64 CHANGED
Binary file
package/binaries/watchdocs-linux-x64 CHANGED
Binary file
package/binaries/watchdocs-win32-x64.exe CHANGED
Binary file
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "watchdocs",
3
- "version": "0.1.7",
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",