crawlwise 1.0.0 → 1.0.1
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 +15 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
Audit a URL from a terminal, and ask whether AI crawlers can reach it.
|
|
4
4
|
|
|
5
|
+
Published on npm as [`crawlwise`](https://www.npmjs.com/package/crawlwise). Requires Node.js 22+.
|
|
6
|
+
|
|
5
7
|
```bash
|
|
6
8
|
npx crawlwise ai-crawlers https://example.com
|
|
7
9
|
npx crawlwise audit https://example.com
|
|
@@ -11,14 +13,20 @@ npx crawlwise tools
|
|
|
11
13
|
|
|
12
14
|
## What needs a key and what does not
|
|
13
15
|
|
|
14
|
-
`ai-crawlers` and `tools`
|
|
15
|
-
|
|
16
|
-
|
|
16
|
+
`ai-crawlers` and `tools` need no account and no API key — they call the same public endpoints as the free web tools at [crawlwise.site/tools](https://crawlwise.site/tools).
|
|
17
|
+
|
|
18
|
+
`audit` calls the REST API (`POST /v1/audits`). That spends credits on your account. You need:
|
|
19
|
+
|
|
20
|
+
1. **Pro plan or above** — Free and Starter cannot create API keys.
|
|
21
|
+
2. An API key from [crawlwise.site/account/api](https://crawlwise.site/account/api) (`cw_live_…`).
|
|
22
|
+
3. Enough credits for the audit (about 1.25 credits for a full page audit plus the AI-crawler probe; the API quotes before it runs).
|
|
17
23
|
|
|
18
24
|
```bash
|
|
19
25
|
export CRAWLWISE_API_KEY=cw_live_...
|
|
20
26
|
```
|
|
21
27
|
|
|
28
|
+
Docs: [REST API](https://crawlwise.site/docs/api) · [Agents & MCP](https://crawlwise.site/agents)
|
|
29
|
+
|
|
22
30
|
## Exit codes
|
|
23
31
|
|
|
24
32
|
- `0` — done, and no regression at or above `--fail-on` (default `critical`)
|
|
@@ -43,13 +51,12 @@ regression — a methodology change is not a defect.
|
|
|
43
51
|
| `--endpoint <origin>` | point at staging, default `https://crawlwise.site` |
|
|
44
52
|
| `--fail-on <level>` | `critical`, `warning`, `never` |
|
|
45
53
|
|
|
46
|
-
##
|
|
47
|
-
|
|
48
|
-
This package is not on npm yet. Until it is, run it from a checkout:
|
|
54
|
+
## Develop from a checkout
|
|
49
55
|
|
|
50
56
|
```bash
|
|
51
57
|
node cli/bin/crawlwise.mjs ai-crawlers https://example.com
|
|
52
58
|
```
|
|
53
59
|
|
|
54
|
-
|
|
55
|
-
|
|
60
|
+
## Publish a new version
|
|
61
|
+
|
|
62
|
+
From this directory: bump `version` in `package.json`, then `npm publish` (npm account needs 2FA for publishing).
|