revise 3.1.1 → 3.1.3

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 3.1.3
+
+### Changed
+
+- **The package README** has a plain heading and tagline. No changes to the
+  CLI or the library.
+
+## 3.1.2
+
+### Changed
+
+- **`revise skill install` installs where the agent running it reads
+  skills:** `.claude/skills` from Claude Code or in a project with a
+  `.claude` folder, otherwise `.agents/skills`, which Codex, Cursor, Copilot,
+  and others read. It used to fall back to `.claude/skills`, which other
+  agents don't read.
+- **It ends by saying to read the installed SKILL.md now:** a running agent
+  session doesn't load a newly installed skill; new sessions do. The
+  quickest install for any agent with a terminal is
+  `npx -y revise@latest skill install`.
+
 ## 3.1.1
 
 ### Changed

package/LICENSE

@@ -19,6 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-
-This package depends on @reviseio/engine, which is distributed separately
-under its own license (free for any use, including commercial).

package/README.md

@@ -1,19 +1,43 @@
-# revise
+# reviseio
 
-Read, edit, and redline Word documents from the command line or TypeScript.
+The swiss army knife for documents
+
+[![](https://img.shields.io/npm/v/revise)](https://www.npmjs.com/package/revise) [![](https://img.shields.io/badge/read_the-docs-blue)](https://revise.io/developer/docs/revise/cli)
+
+Read, edit, and redline Word documents. Available as CLI and TypeScript library.
 
 ```bash
-npm i -g revise  # or: npx revise <command>
+npx revise
 ```
 
-AI agents using `revise` can edit documents several times faster. Paste this into your agent:
+## For Agents
+
+AI agents using `revise` can work with Word documents several times faster.
+
+To get started, tell your agent:
 
 ```text
 Read https://revise.io/skills/cli.md and follow it.
 ```
 
+Or install the skill directly from a terminal:
+
+```bash
+npx -y revise@latest skill install
+```
+
+## Install
+
+You can also just install the `revise` CLI by itself:
+
+```bash
+npm i -g revise
+```
+
 ## CLI
 
+The `revise` CLI lets you inspect, edit, and convert .docx files.
+
 ```bash
 revise outline contract.docx                              # headings with block ranges
 revise read contract.docx 0                               # blocks as HTML, with ids
@@ -28,6 +52,8 @@ revise export contract.docx contract.pdf                  # .docx .pdf .md .html
 cat notes.md | revise convert - notes.docx
 ```
 
+`revise` was designed primarily for AI agents, and has a whole suite of agent-ready tools for granular editing:
+
 ```bash
 revise tools                        # every editing tool
 revise call contract.docx set_header_footer '{"side":"footer","center":"Page {PAGE} of {PAGES}"}'
@@ -39,15 +65,34 @@ revise examples                     # more
 
 ## Agent skills
 
+Quick install:
+
+```bash
+revise skill install                                                               # anything else
+```
+
+Claude:
+
 ```bash
 claude plugin marketplace add reviseio/skills && claude plugin install cli@revise  # Claude Code
+```
+
+Codex:
+
+```bash
 codex plugin marketplace add reviseio/skills && codex plugin add cli@revise        # Codex
+```
+
+Via `skills`:
+
+```bash
 npx skills add reviseio/skills --skill revise-cli                                  # Cursor, Copilot, Windsurf…
-revise skill install                                                               # anything else
 ```
 
 ## Library
 
+`revise` is also available as a [TypeScript library](https://revise.io/developer/docs/revise/library).
+
 ```ts
 import { ReviseDocument } from "revise";
 
@@ -92,13 +137,8 @@ await doc.replaceAll("draft", "final");
 const { bytes } = await doc.export({ format: "docx" });
 ```
 
-## Links
-
-[Docs](https://revise.io/developer/docs/revise/introduction) ·
-[Changelog](https://revise.io/developer/docs/revise/changelog) ·
-[Browser editor (`@reviseio/editor`)](https://www.npmjs.com/package/@reviseio/editor)
-
 ## License
 
-MIT. Runs on [`@reviseio/engine`](https://www.npmjs.com/package/@reviseio/engine),
-free for any use under its own license.
+`revise` is available under the MIT License.
+
+[`@reviseio/engine`](https://www.npmjs.com/package/@reviseio/engine) is free for any use under its own license.

package/cli.js

@@ -870,8 +870,8 @@ var ui = PLAIN;
 var uiErr = PLAIN;
 function producer() {
   return {
-    version: true ? "3.1.1" : "dev",
-    build: true ? "2953a6472" : null
+    version: true ? "3.1.3" : "dev",
+    build: true ? "8faaded78" : null
   };
 }
 var warnings = [];
@@ -2846,7 +2846,7 @@ async function cmdSkill(args, install) {
       text: () => markdown.replace(/\n$/, "")
     };
   }
-  const base = flagString(args, "dir") ?? (fs2.existsSync(".agents/skills") ? ".agents/skills" : ".claude/skills");
+  const base = flagString(args, "dir") ?? skillsDirFor(io.env ?? {});
   const dir = path2.join(base, "revise-cli");
   const file = path2.join(dir, "SKILL.md");
   const older = path2.join(base, "revise");
@@ -2860,9 +2860,20 @@ async function cmdSkill(args, install) {
   }
   return {
     data: { output: path2.resolve(file), outputWritten: true },
-    text: () => `${ui.green("Installed")} ${dir}/ (SKILL.md and reference/)${replaced ? `, replacing the older ${older}/` : ""}`
+    text: () => [
+      `${ui.green("Installed")} ${dir}/ (SKILL.md and reference/)${replaced ? `, replacing the older ${older}/` : ""}.`,
+      // An agent's running session doesn't load a skill installed during
+      // it; new sessions do.
+      `Agents: read ${file} now and follow it. New sessions load it automatically.`
+    ].join("\n")
   };
 }
+function skillsDirFor(env) {
+  if (env.CLAUDECODE) return ".claude/skills";
+  if (fs2.existsSync(".agents/skills")) return ".agents/skills";
+  if (fs2.existsSync(".claude")) return ".claude/skills";
+  return ".agents/skills";
+}
 var RENAMED_COMMANDS = {
   "replace-text": "replace-all"
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "revise",
-  "version": "3.1.1",
-  "reviseBuild": "2953a6472",
+  "version": "3.1.3",
+  "reviseBuild": "8faaded78",
   "description": "Read, edit, and redline Word documents from the command line or TypeScript, with tracked changes, comments, and tools for AI agents.",
   "keywords": [
     "docx",
@@ -55,7 +55,7 @@
   ],
   "sideEffects": false,
   "dependencies": {
-    "@reviseio/engine": "3.1.1",
+    "@reviseio/engine": "3.1.3",
     "jszip": "^3.10.1",
     "yjs": "^13.6.27"
   },