unramble 1.0.0 → 1.0.1

package/README.md

@@ -8,7 +8,7 @@
 <p align="center"><b>Press Ctrl+G and the rambling prompt you just dictated becomes the one you meant to type — in place, inside Claude Code, on the plan you already have.</b></p>
 
 <p align="center">
-  <a href="#install">Install</a> ·
+  <a href="https://yadava5.github.io/unramble/"><b>Install in one click</b></a> ·
   <a href="#what-it-does">What it does</a> ·
   <a href="#plan-or-api-key">Plan or API key</a> ·
   <a href="docs/BENCHMARKS.md">Benchmarks</a> ·
@@ -35,15 +35,19 @@ lost. Ctrl+G again puts your original back.
 
 ## Install
 
-Pick one. Both install the same plugin and bind Ctrl+G.
+**One click:** [**Install in Claude Code →**](https://yadava5.github.io/unramble/) opens Claude
+Code in your terminal with the install command typed in; press Enter.
 
-**A. In your terminal** (zsh, bash, PowerShell — not inside Claude Code; needs Node 18+):
+**In your terminal** (zsh, bash, PowerShell — not inside Claude Code; needs Node 18+):
 
 ```sh
 npx unramble
 ```
 
-**B. Inside Claude Code** — start `claude`, then type these at its `❯` prompt, one at a time:
+That installs the plugin and binds Ctrl+G in one step.
+
+**Or inside Claude Code**, with no Node needed: start `claude`, then type these at its `❯`
+prompt, one at a time. Claude Code has no shorter form for a plugin outside its own directory.
 
 ```text
 /plugin install unramble --marketplace yadava5/unramble
@@ -54,7 +58,9 @@ Answer `y` to add the marketplace and pick a scope (user is the default). `setup
 it keeps a backup of your `keybindings.json` and never overwrites a key you bound yourself.
 
 Then quit Claude Code and start a new session (`claude`), say or type a prompt, and press
-**Ctrl+G**. Built and tested on Claude Code **2.1.308**; see
+**Ctrl+G**. Works with Claude Code 2.1.308 and every release after it: CI tests the newest
+Claude Code every day on Linux, macOS and Windows. It always uses the newest Sonnet or Opus,
+because it asks for the model by family, never by version. See
 [Where it is tested](#where-it-is-tested).
 
 ## What it does
@@ -93,6 +99,9 @@ count that as a minor defect.)
 - **Lose a machine value.** A rewrite that drops a path, `--flag`, number, URL, `@ref` or
   `[Pasted text]` chip is refused and your draft stays — unless you corrected that value on
   the spot ("src/utils, no wait, src/lib").
+- **Add a link or a command you never said.** Pasted text can carry instructions; a rewrite
+  that brings in a URL, `curl`/`wget`/`sudo`/`rm -…`, shell chaining or invisible characters
+  you did not say is refused. On 2,240 recorded rewrites this refused none.
 - **Touch pasted logs or code.** They are masked before the model sees the draft and put back
   byte for byte.
 - **Answer your question or do the task.** "Can you check X?" stays a question for Claude Code.
@@ -169,13 +178,23 @@ editor as VS Code and Cursor). If one does not work, please
 - **A short window can hide the band.** In an 80×24 window with a tall status line, Claude Code
   may not draw the `⌃G refine` row; Ctrl+G still works.
 - **Long pastes stay as chips.** When a dictation app pastes a long block, Claude Code folds it
-  into a `[Pasted text #N]` chip that plugins cannot read in 2.1.308, so that text is kept as
+  into a `[Pasted text #N]` chip that plugins cannot read (as of 2.1.308), so that text is kept as
   is. Claude Code's built-in voice input, macOS Dictation and typing all work fully.
 - **Garbled speech stays garbled.** If the transcription is wrong in a way context cannot fix
   ("Apple ID" for a project name), the rewrite keeps it as heard rather than guess. Add the
   name to *Names you often say*.
-- **The plugin API is early access.** CI runs the latest Claude Code weekly to catch a release
-  that moves it.
+- **The plugin API is early access.** CI runs the newest Claude Code every day to catch a
+  release that moves it.
+
+## Update
+
+```sh
+npx unramble update
+```
+
+Or have Claude Code keep it current: in `/plugin`, open the `unramble` marketplace and turn on
+auto-update. Every change reaches `main` only through a reviewed pull request, so that is
+what auto-update follows.
 
 ## Uninstall
 
@@ -198,8 +217,15 @@ plan instead of an API key. I used Claude Code to build it.
 ## Contributing
 
 Reports of a rewrite that changed your meaning are the most useful thing you can send; there
-is an [issue template](https://github.com/yadava5/unramble/issues/new/choose) for it. See
-[CONTRIBUTING.md](CONTRIBUTING.md).
+is an [issue template](https://github.com/yadava5/unramble/issues/new/choose) for it. Pull
+requests are welcome: see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## Security
+
+Every change reaches `main` through a reviewed pull request, releases publish only from a
+maintainer-approved tag with npm provenance, and CI fails any change that widens what the
+shipped code can reach. [SECURITY.md](SECURITY.md) lists exactly what the plugin touches and how
+to report a vulnerability privately.
 
 ## License
 

package/cli/unramble.mjs

@@ -1,8 +1,9 @@
 #!/usr/bin/env node
-// npx unramble [install | uninstall | status] — sets the plugin up in one paste.
+// npx unramble [install | update | uninstall | status] — sets the plugin up in one paste.
 //
 // install:   claude plugin install unramble --marketplace yadava5/unramble, then binds Ctrl+G
 //            in keybindings.json (a backup is kept beside it).
+// update:    pulls the newest unramble from its marketplace.
 // uninstall: removes the plugin and takes back only the keybindings install added.
 // status:    shows whether the plugin is installed and Ctrl+G is bound.
 //
@@ -11,14 +12,26 @@
 import { spawnSync } from 'node:child_process'
 import { copyFileSync, existsSync, readFileSync, writeFileSync } from 'node:fs'
 import { homedir } from 'node:os'
-import { join } from 'node:path'
+import { isAbsolute, join, resolve } from 'node:path'
 
 import { isBound, parse, plan, serialize, unplan } from '../hooks/keybindings.js'
 
-const MARKETPLACE = process.env.UNRAMBLE_MARKETPLACE || 'yadava5/unramble'
+// UNRAMBLE_MARKETPLACE points the installer at a fork or a local checkout (CI uses it). On
+// Windows the argument passes through cmd.exe, so only plain repo names and paths are taken.
+const override = process.env.UNRAMBLE_MARKETPLACE
+if (override && (!/^[\w@./:\\ ~#-]+$/.test(override) || override.startsWith('-'))) {
+  process.stderr.write('unramble: UNRAMBLE_MARKETPLACE must be owner/repo or a folder path\n')
+  process.exit(1)
+}
+const MARKETPLACE = override ? (existsSync(override) ? resolve(override) : override) : 'yadava5/unramble'
 const PLUGIN = 'unramble'
 const configDir = process.env.CLAUDE_CONFIG_DIR || join(homedir(), '.claude')
+if (!isAbsolute(configDir)) {
+  process.stderr.write(`unramble: CLAUDE_CONFIG_DIR must be an absolute path (got ${configDir})\n`)
+  process.exit(1)
+}
 const keybindings = join(configDir, 'keybindings.json')
+const backup = `${keybindings}.unramble-backup`
 
 const say = (line = '') => process.stdout.write(`${line}\n`)
 const fail = line => {
@@ -26,11 +39,18 @@ const fail = line => {
   process.exit(1)
 }
 
-/** Runs `claude` with the person's own environment and terminal; true on success. */
+const windows = process.platform === 'win32'
+
+/**
+ * Runs `claude` with the person's own environment and terminal; true on success. It runs from
+ * the home folder: on Windows (where `claude` is a .cmd shim and needs the shell) cmd.exe looks
+ * in the current folder before PATH, so a `claude.cmd` in a cloned repo must never be the one run.
+ */
 function claude(args, { quiet = false } = {}) {
-  const r = spawnSync('claude', args, {
+  const r = spawnSync('claude', windows ? args.map(a => (a.includes(' ') ? `"${a}"` : a)) : args, {
+    cwd: homedir(),
     stdio: quiet ? 'pipe' : 'inherit',
-    shell: process.platform === 'win32',
+    shell: windows,
     encoding: 'utf8',
   })
   if (r.error?.code === 'ENOENT') {
@@ -48,6 +68,11 @@ function readKeys() {
   }
 }
 
+/** The first backup is the person's own file; a later install or uninstall never replaces it. */
+function keepBackup(text) {
+  if (text !== null && !existsSync(backup)) copyFileSync(keybindings, backup)
+}
+
 function bindKeys() {
   const { text, file } = readKeys()
   const next = plan(file)
@@ -57,7 +82,7 @@ function bindKeys() {
     say(`  Free that chord in ${keybindings}, then run /unramble setup in Claude Code.`)
     return
   }
-  if (text !== null) copyFileSync(keybindings, `${keybindings}.unramble-backup`)
+  keepBackup(text)
   writeFileSync(keybindings, serialize(next.file))
   say(`✓ Bound Ctrl+G in ${keybindings}${text !== null ? ' (backup: keybindings.json.unramble-backup)' : ''}`)
   for (const c of next.changes) say(`    ${c}`)
@@ -80,13 +105,21 @@ function uninstall() {
   const { text, file } = readKeys()
   const back = unplan(file)
   if (back.changes.length) {
-    if (text !== null) copyFileSync(keybindings, `${keybindings}.unramble-backup`)
+    keepBackup(text)
     writeFileSync(keybindings, serialize(back.file))
     say(`✓ Took back the Ctrl+G bindings in ${keybindings}`)
   }
   say(removed ? '✓ unramble is uninstalled' : '! The plugin was not installed (or the uninstall failed); see above.')
 }
 
+function update() {
+  claude(['plugin', 'marketplace', 'update', PLUGIN], { quiet: true })
+  if (!claude(['plugin', 'update', `${PLUGIN}@${PLUGIN}`]).ok) {
+    fail('the update did not finish; is unramble installed? Try: npx unramble')
+  }
+  say('✓ unramble is up to date. Start a new Claude Code session to load it.')
+}
+
 function status() {
   const listed = claude(['plugin', 'list'], { quiet: true })
   const installed = new RegExp(`\\b${PLUGIN}@`).test(listed.out)
@@ -95,9 +128,9 @@ function status() {
 }
 
 const command = process.argv[2] ?? 'install'
-const commands = { install, uninstall, status }
+const commands = { install, update, uninstall, status }
 if (command === '--help' || command === '-h' || !(command in commands)) {
-  say('Usage: npx unramble [install | uninstall | status]')
+  say('Usage: npx unramble [install | update | uninstall | status]')
   process.exit(command in commands || command.startsWith('-') ? 0 : 1)
 }
 commands[command]()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unramble",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Ctrl+G turns a rambling, dictated prompt into a clean, ordered one, in place, on your own Claude Code plan.",
   "keywords": [
     "claude-code",
@@ -30,7 +30,8 @@
     "node": ">=18"
   },
   "scripts": {
-    "test": "claude plugin validate . && claude plugin test . && node --test cli/*.test.mjs",
-    "test:cli": "node --test cli/*.test.mjs"
+    "test": "node scripts/guard.mjs && claude plugin validate . && claude plugin test . && node --test cli/*.test.mjs scripts/*.test.mjs",
+    "test:cli": "node --test cli/*.test.mjs",
+    "guard": "node scripts/guard.mjs"
   }
 }