@ainative/ax 0.1.0 → 0.2.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.
Files changed (2) hide show
  1. package/README.md +31 -8
  2. package/package.json +10 -5
package/README.md CHANGED
@@ -1,26 +1,49 @@
1
1
  # ainative-ax
2
2
 
3
- Score how ready a site is for AI agents, from your terminal.
3
+ Score how ready a website is for AI agents, from your terminal. Checks for the signals agents actually look for — `llms.txt`, `agent.json`, MCP and OAuth discovery, structured data, API catalogs, and more — and returns a 0–100 score, a letter grade, and a per-check breakdown.
4
4
 
5
5
  ```bash
6
6
  npx ainative-ax audit example.com
7
7
  ```
8
8
 
9
- Wraps the same scoring engine behind [ainative.ax](https://ainative.ax) — no separate backend, no API key required for a quick scan.
9
+ Wraps the same scoring engine behind [ainative.ax](https://ainative.ax) — no install, no API key required for a quick scan.
10
10
 
11
11
  ## Usage
12
12
 
13
13
  ```bash
14
- npx ainative-ax audit <url> Run a quick agent-readiness scan
15
- npx ainative-ax --help Show help
14
+ npx ainative-ax audit <url> [options] Run an agent-readiness scan
15
+ npx ainative-ax login Sign in (stores a session locally)
16
+ npx ainative-ax logout Clear your stored session
17
+ npx ainative-ax history [--json] List your past scans while signed in
18
+ npx ainative-ax --help Show this help
16
19
  ```
17
20
 
18
- Exits with status `1` if the scan is incomplete (score below max) or fails, so it can gate CI.
21
+ Audit options:
22
+
23
+ ```
24
+ --json Print the raw API response as JSON (no color) —
25
+ pipeable into jq or a CI step. Exit code unchanged.
26
+ --full Run the full audit (agent simulation + benchmark
27
+ percentile) instead of the quick scan.
28
+ --industry <name> Industry for the full audit's benchmark comparison
29
+ (default: saas). Only used with --full.
30
+ ```
31
+
32
+ Exits with status `1` if the scan is incomplete (score below max) or fails, so it can gate CI:
33
+
34
+ ```yaml
35
+ # example GitHub Actions step
36
+ - run: npx ainative-ax audit ${{ github.event.repository.html_url }} --json
37
+ ```
19
38
 
20
39
  ## What it checks
21
40
 
22
- Discoverability, structured data, API documentation, authentication standards, security transparency, and more — see the full breakdown at [ainative.ax](https://ainative.ax) or run a scan yourself.
41
+ Agent discoverability (`llms.txt`, `agent.json`, agent cards), MCP and OAuth discovery, structured data (JSON-LD, Schema.org, OpenGraph), API documentation and catalogs (OpenAPI, RFC 9727), authentication standards, content negotiation, security transparency, and more — the exact check count grows over time. Run a scan or see the full breakdown at [ainative.ax](https://ainative.ax).
42
+
43
+ ## Full reports, benchmarks, and the leaderboard
44
+
45
+ This CLI covers the quick scan and full audit. For stored reports, industry benchmarks, remediation guidance, and the public [Agentic Web Index](https://ainative.ax/index) leaderboard, visit [ainative.ax](https://ainative.ax).
23
46
 
24
- ## Full reports
47
+ ## Using it from an AI agent instead?
25
48
 
26
- This CLI covers the quick scan. For stored reports, industry benchmarks, and remediation, visit [ainative.ax](https://ainative.ax).
49
+ AX Audit also runs as a [Model Context Protocol](https://modelcontextprotocol.io) server at `https://ainative.ax/mcp` — no separate install. See the [main repo README](https://github.com/AINative-Studio/ainative-ax) for the MCP tool reference.
package/package.json CHANGED
@@ -1,14 +1,19 @@
1
1
  {
2
2
  "name": "@ainative/ax",
3
- "version": "0.1.0",
3
+ "version": "0.2.1",
4
4
  "description": "Score how ready a site is for AI agents — CLI for AINative's AX Audit. npx @ainative/ax audit <url>",
5
- "bin": {
6
- "ax": "ainative-ax.js"
7
- },
5
+ "bin": { "ax": "ainative-ax.js" },
8
6
  "main": "./ainative-ax.js",
9
7
  "engines": { "node": ">=18" },
10
8
  "license": "MIT",
11
9
  "repository": { "type": "git", "url": "git+https://github.com/AINative-Studio/ainative-ax.git" },
12
10
  "homepage": "https://ainative.ax",
13
- "keywords": ["ai", "agents", "agent-readiness", "ax-audit", "llms-txt", "mcp", "seo", "aeo"]
11
+ "keywords": [
12
+ "ai", "ai-agents", "agent-readiness", "agent-ready", "ax-audit",
13
+ "llms-txt", "llms.txt", "agent-json", "mcp", "mcp-server",
14
+ "model-context-protocol", "seo", "aeo", "geo",
15
+ "answer-engine-optimization", "cli", "cli-tool", "website-audit",
16
+ "site-audit", "crawlability", "structured-data", "json-ld",
17
+ "schema-org", "openapi", "robots-txt", "chatgpt", "claude", "llm", "ci"
18
+ ]
14
19
  }