@facetlayer/docs-tool 0.1.0 → 0.1.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/docs/ClaudeMdSetup.md +27 -0
- package/package.json +3 -2
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# CLAUDE.md Setup
|
|
2
|
+
|
|
3
|
+
Add the following to your project's `CLAUDE.md` file to enable AI assistants to use the `docs` tool for looking up NPM library documentation.
|
|
4
|
+
|
|
5
|
+
## Recommended Section
|
|
6
|
+
|
|
7
|
+
```markdown
|
|
8
|
+
### docs
|
|
9
|
+
|
|
10
|
+
Generic CLI tool to fetch documentation for a target NPM library. This will
|
|
11
|
+
search local node_modules first and will search NPM if necessary.
|
|
12
|
+
|
|
13
|
+
Syntax:
|
|
14
|
+
|
|
15
|
+
docs list <library-name> # List the documentation files for <library-name>
|
|
16
|
+
docs show <library-name> <file> # Show a documentation file
|
|
17
|
+
|
|
18
|
+
Example:
|
|
19
|
+
|
|
20
|
+
docs list yargs
|
|
21
|
+
docs show yargs README.md
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Notes
|
|
25
|
+
|
|
26
|
+
- The `docs` tool must be installed globally (`npm install -g @facetlayer/docs-tool`)
|
|
27
|
+
- Place this section under a heading like `## Helpful development tools` or similar
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@facetlayer/docs-tool",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.3",
|
|
4
4
|
"description": "Library and CLI tool for browsing docs in NPM packages",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -12,7 +12,8 @@
|
|
|
12
12
|
"build": "node build.mts build",
|
|
13
13
|
"prepublishOnly": "node build.mts validate && node build.mts build",
|
|
14
14
|
"typecheck": "tsc -p .",
|
|
15
|
-
"test": "vitest run --testTimeout=30000"
|
|
15
|
+
"test": "vitest run --testTimeout=30000",
|
|
16
|
+
"local:install": "npm run build && npm i -g ."
|
|
16
17
|
},
|
|
17
18
|
"keywords": [
|
|
18
19
|
"doc",
|