aeo-linter 0.1.0 → 0.1.2

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 +58 -0
  2. package/package.json +4 -3
package/README.md ADDED
@@ -0,0 +1,58 @@
1
+ # aeo-linter
2
+
3
+ > Command-Line Interface for **Answer Engine Optimization (AEO/GEO)** and **RAG readiness** linting, built on the **Google Lighthouse architecture**.
4
+
5
+ [![NPM Version](https://img.shields.io/npm/v/aeo-linter.svg)](https://www.npmjs.com/package/aeo-linter)
6
+ [![TypeScript](https://img.shields.io/badge/TypeScript-5.4-blue.svg)](https://www.typescriptlang.org/)
7
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
8
+
9
+ Official CLI for [aeo-audit-linter](https://github.com/DrowLink/aeo-audit-linter).
10
+
11
+ ---
12
+
13
+ ## ⚡ Quickstart (No installation required)
14
+
15
+ ```bash
16
+ # Run a quick audit in terminal
17
+ npx aeo-linter https://example.com
18
+
19
+ # Generate a visual interactive HTML dashboard (Lighthouse style)
20
+ npx aeo-linter https://example.com --html -o aeo-report.html
21
+
22
+ # Output JSON report for CI/CD pipelines
23
+ npx aeo-linter https://example.com --json -o report.json
24
+
25
+ # Run specific categories only
26
+ npx aeo-linter https://example.com -c ai-accessibility,direct-answer-density
27
+ ```
28
+
29
+ ---
30
+
31
+ ## 📦 Global Installation
32
+
33
+ ```bash
34
+ npm install -g aeo-linter
35
+
36
+ # Then use directly anywhere
37
+ aeo-linter https://example.com
38
+ ```
39
+
40
+ ---
41
+
42
+ ## 🎛️ CLI Options
43
+
44
+ | Option | Shorthand | Description |
45
+ |---|---|---|
46
+ | `<url>` | — | The target URL to audit (required). |
47
+ | `--html` | — | Generates an interactive visual HTML dashboard report. |
48
+ | `--json` | `-j` | Outputs the complete report in JSON format. |
49
+ | `--output <file>` | `-o` | Specifies output path for the report (`.html` or `.json`). |
50
+ | `--categories <list>`| `-c` | Comma-separated list of categories to audit. |
51
+ | `--version` | `-V` | Displays the current version. |
52
+ | `--help` | `-h` | Displays help message and option details. |
53
+
54
+ ---
55
+
56
+ ## 📄 License
57
+
58
+ MIT © [DrowLink](https://github.com/DrowLink/aeo-audit-linter)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "aeo-linter",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "description": "Command-line interface for Answer Engine Optimization (AEO/GEO) Linter",
5
5
  "bin": {
6
6
  "aeo-linter": "./bin/aeo-linter.js"
@@ -13,7 +13,8 @@
13
13
  },
14
14
  "files": [
15
15
  "bin",
16
- "dist"
16
+ "dist",
17
+ "README.md"
17
18
  ],
18
19
  "repository": {
19
20
  "type": "git",
@@ -30,7 +31,7 @@
30
31
  "author": "DrowLink",
31
32
  "license": "MIT",
32
33
  "dependencies": {
33
- "@drowlink/aeo-linter-core": "^0.1.0",
34
+ "@drowlink/aeo-linter-core": "^0.1.1",
34
35
  "commander": "^12.0.0"
35
36
  },
36
37
  "devDependencies": {