ironprose 0.2.0 → 0.3.0

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 (4) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/README.md +74 -51
  3. package/npm-shrinkwrap.json +2 -2
  4. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -1,5 +1,25 @@
1
1
  # ironprose-cli
2
2
 
3
+ ## 0.3.0
4
+
5
+ ### Minor Changes
6
+
7
+ - baf06b0: Add `rate` subcommand for agent diagnostic feedback
8
+
9
+ - New `ironprose rate` command with `--json` as primary agent path and `--rule`/`--rating` convenience flags
10
+ - Telemetry Bridge fields (`source_type`, `confidence`) surfaced on `DiagnosticItem`
11
+ - Text output shows `[Heuristic 1.00] [id:d-001]` tags and rating hint on stderr
12
+ - AGENTS.md rule #6: "Rate diagnostics you disagree with"
13
+ - SKILL.md rating workflow section with examples
14
+ - 4 new integration tests for rate command
15
+
16
+ ## 0.2.1
17
+
18
+ ### Patch Changes
19
+
20
+ - 18d488e: Use JPOEHNELT_BOT PAT for workflow permissions and update README with brand-aligned copy.
21
+ - d1498bb: Clean up README with badges, CLI usage examples, and improved structure for both human and AI readers.
22
+
3
23
  ## 0.2.0
4
24
 
5
25
  ### Minor Changes
package/README.md CHANGED
@@ -1,77 +1,100 @@
1
1
  # ironprose
2
2
 
3
- CLI for [IronProse](https://ironprose.com) — prose analysis tools for writers.
3
+ [![npm](https://img.shields.io/npm/v/ironprose)](https://www.npmjs.com/package/ironprose)
4
+ [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
4
5
 
5
- ## Install
6
+ **Grammarly catches commas. AI tries to write the book for you.**
7
+ **IronProse actually helps you edit.**
8
+
9
+ 103+ deterministic craft analyzers — no AI hallucinations, no guessing. Every diagnostic is computed from your actual prose.
6
10
 
7
11
  ```bash
8
- # via npm (recommended)
9
- npx ironprose --help
12
+ npx ironprose analyze "The dark night was very dark and she felt scared."
13
+ ```
10
14
 
11
- # via cargo
12
- cargo install ironprose-cli
15
+ ```json
16
+ {
17
+ "score": 42,
18
+ "diagnostics": [
19
+ {
20
+ "rule": "repetition",
21
+ "severity": "warning",
22
+ "message": "\"dark\" repeated 2× within 8 words"
23
+ },
24
+ {
25
+ "rule": "filter_words",
26
+ "severity": "info",
27
+ "message": "\"felt\" distances the reader from the emotion"
28
+ },
29
+ {
30
+ "rule": "adverb_density",
31
+ "severity": "info",
32
+ "message": "\"very\" weakens the adjective it modifies"
33
+ }
34
+ ]
35
+ }
13
36
  ```
14
37
 
15
- ## Usage
38
+ ## What it catches
16
39
 
17
- ### MCP Server (Claude Desktop, VS Code, Cursor)
40
+ | Category | Examples |
41
+ | --------------------------- | ---------------------------------------------------------------- |
42
+ | **Grammar & Mechanics** | Comma splices · dangling modifiers · tense consistency |
43
+ | **Word Choice & Economy** | Passive voice · filter words · adverb density · hedging |
44
+ | **Craft & Style** | Show don't tell · purple prose · clichés · emotional restraint |
45
+ | **Sentence & Rhythm** | Repetitive structure · echoed openers · monotonous length |
46
+ | **Readability & Structure** | Pacing variance · paragraph balance · readability score |
47
+ | **Dialogue** | Said-ism soup · "As you know, Bob" · dialogue-to-narration ratio |
48
+ | **Character** | Voice fingerprinting · white room syndrome · emotional residue |
18
49
 
19
- Start the MCP stdio server for editor integration:
50
+ [Browse all 103+ craft lenses →](https://ironprose.com#lenses)
51
+
52
+ ## Install
20
53
 
21
54
  ```bash
22
- ironprose mcp --workspace /path/to/your/manuscript
55
+ # npm (recommended)
56
+ npx ironprose --help
57
+
58
+ # macOS/Linux
59
+ curl --proto '=https' --tlsv1.2 -LsSf https://github.com/benchcutlogic/ironprose-cli/releases/latest/download/ironprose-cli-installer.sh | sh
23
60
  ```
24
61
 
25
- #### Claude Desktop
62
+ ## Usage
26
63
 
27
- Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
64
+ ```bash
65
+ # Analyze a file
66
+ ironprose analyze --file chapter-01.md
28
67
 
29
- ```json
30
- {
31
- "mcpServers": {
32
- "ironprose": {
33
- "command": "npx",
34
- "args": ["-y", "ironprose", "mcp", "--workspace", "/path/to/manuscript"]
35
- }
36
- }
37
- }
38
- ```
68
+ # Pipe from stdin
69
+ cat draft.md | ironprose analyze
39
70
 
40
- #### VS Code (Copilot MCP)
71
+ # Human-readable output
72
+ ironprose analyze --file draft.md --output text
41
73
 
42
- Add to `.vscode/mcp.json`:
74
+ # Filter by rule or severity
75
+ ironprose analyze --file draft.md --rules passive_voice,repetition
76
+ ironprose analyze --file draft.md --severity-min warning
43
77
 
44
- ```json
45
- {
46
- "servers": {
47
- "ironprose": {
48
- "command": "npx",
49
- "args": ["-y", "ironprose", "mcp", "--workspace", "${workspaceFolder}"]
50
- }
51
- }
52
- }
53
- ```
78
+ # Compare revisions
79
+ ironprose compare --original-file v1.md --revised-file v2.md
80
+
81
+ # List all rules
82
+ ironprose list-rules
54
83
 
55
- ### Available MCP Tools
84
+ # Inspect API schema
85
+ ironprose schema analyze
56
86
 
57
- | Tool | Description |
58
- | ------------ | -------------------------------------------------- |
59
- | `analyze` | Analyze prose for style, grammar, and craft issues |
60
- | `compare` | Compare original vs revised text |
61
- | `list_rules` | List all 108 analysis rules |
62
- | `rate` | Submit feedback on diagnostics |
63
- | `read_file` | Read a file from the workspace |
64
- | `write_file` | Write a file to the workspace |
65
- | `list_files` | List workspace files |
87
+ # Rate a diagnostic (closes the feedback loop)
88
+ ironprose rate --rule repetition --rating false_positive --diagnostic-id d-001
89
+ ```
66
90
 
67
- ### Environment Variables
91
+ ## Configuration
68
92
 
69
- | Variable | Description | Default |
70
- | --------------------- | -------------------------------- | --------------------------- |
71
- | `IRONPROSE_API_URL` | API base URL | `https://api.ironprose.com` |
72
- | `IRONPROSE_API_KEY` | API key for authenticated access | (free tier) |
73
- | `IRONPROSE_WORKSPACE` | Workspace directory | (none) |
93
+ | Variable | Description | Default |
94
+ | ------------------- | -------------------------------- | --------------------------- |
95
+ | `IRONPROSE_API_URL` | API base URL | `https://api.ironprose.com` |
96
+ | `IRONPROSE_API_KEY` | API key for authenticated access | _(free tier)_ |
74
97
 
75
98
  ## License
76
99
 
77
- MIT
100
+ [MIT](LICENSE)
package/npm-shrinkwrap.json CHANGED
@@ -23,7 +23,7 @@
23
23
  "hasInstallScript": true,
24
24
  "license": "MIT",
25
25
  "name": "ironprose",
26
- "version": "0.2.0"
26
+ "version": "0.3.0"
27
27
  },
28
28
  "node_modules/@isaacs/cliui": {
29
29
  "engines": {
@@ -542,5 +542,5 @@
542
542
  }
543
543
  },
544
544
  "requires": true,
545
- "version": "0.2.0"
545
+ "version": "0.3.0"
546
546
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "artifactDownloadUrls": [
3
- "https://github.com/benchcutlogic/ironprose-cli/releases/download/v0.2.0"
3
+ "https://github.com/benchcutlogic/ironprose-cli/releases/download/v0.3.0"
4
4
  ],
5
5
  "bin": {
6
6
  "ironprose": "run-ironprose.js"
@@ -112,7 +112,7 @@
112
112
  "zipExt": ".tar.gz"
113
113
  }
114
114
  },
115
- "version": "0.2.0",
115
+ "version": "0.3.0",
116
116
  "volta": {
117
117
  "node": "18.14.1",
118
118
  "npm": "9.5.0"