extraktr 1.0.0 → 1.0.1

package/README.md

@@ -1,50 +1,41 @@
 # Extraktr CLI
 
-Installable Node package that calls **`POST /api/extract`** on the Extraktr frontend (same route as the web app). The server proxy may attach session-derived `Authorization` for browser traffic; the CLI uses optional bearer JWTs or anonymous access when the deployment allows it.
-
-This package is **npm-ready** (valid `package.json`, `bin`, and publish `files`). A **public npm publish** may happen later; this README does not assume the package is on the public registry yet.
+Published npm package **[extraktr](https://www.npmjs.com/package/extraktr)** — calls **`POST /api/extract`** on the Extraktr frontend (same route as the web app). The server proxy may attach session-derived `Authorization` for browser traffic; the CLI uses optional bearer JWTs or anonymous access when the deployment allows it.
 
 ## Requirements
 
 - **Node.js 18+** (global `fetch`)
 
-## Install options
+## Install
 
-### From this repo (local development)
+### From npm (recommended)
 
 ```bash
-cd cli
-npm install
+npm install -g extraktr
 ```
 
-Run with Node:
+Then:
 
 ```bash
-node index.js extract --file ./sample-simple.txt
-node index.js --help
-node index.js --version
+extraktr --help
+extraktr extract --file ./thread.txt
 ```
 
-### Global-style command on your machine (`extraktr`)
-
-From `cli/`:
+Run once without a global install:
 
 ```bash
-npm link
+npx extraktr --help
 ```
 
-Then:
+### From this repo (contributors)
 
 ```bash
-extraktr extract --file ./sample-simple.txt
-extraktr --help
-extraktr extract --help
-extraktr --version
+cd cli
+npm install
+npm link
 ```
 
-To remove the link later: `npm unlink -g extraktr-cli` (package name) or follow npm’s unlink docs for your setup.
-
-After a future **public publish**, `npx extraktr-cli …` or a scoped name chosen at publish time would work the same way as any other npm binary; until then, use repo paths or `npm link`.
+Use `node index.js …` instead of `extraktr …` if you prefer not to link.
 
 ## Environment
 
@@ -61,18 +52,26 @@ Use **exactly one** input method:
 - `--file <path>`
 - `--stdin` (pipe text in; fails if stdin is a TTY with no pipe)
 
-### Examples
+### Examples (generic shell)
 
 ```bash
-extraktr extract --file ./sample-simple.txt
-Get-Content sample-simple.txt | extraktr extract --stdin
-extraktr extract --file ./sample-simple.txt --format json
-extraktr extract --file ./sample-simple.txt --format json --output out.json
+npm install -g extraktr
+extraktr extract --file ./thread.txt
+extraktr extract --file ./thread.txt --format json
+extraktr extract --file ./thread.txt --format json --output out.json
 extraktr extract --file ./thread.txt --source slack
 EXTRAKTR_BEARER="Bearer …" extraktr extract --file ./thread.txt
 ```
 
-With **`--format json`**, successful runs write **only JSON to stdout** so you can pipe it. Diagnostics (e.g. `POST https://…`) go to **stderr** for non-JSON formats; for JSON they are omitted on success. Errors are written to **stderr**.
+### Examples (PowerShell)
+
+```powershell
+npm install -g extraktr
+extraktr extract --file C:\path\to\thread.txt
+Get-Content C:\path\to\thread.txt | extraktr extract --stdin
+```
+
+On **success**, stdout contains only the formatted extraction (text, Markdown, or JSON). **Errors** and hints go to **stderr**. With **`--format json`**, stdout is valid JSON only on success—safe for `jq` when stderr is not merged into stdout.
 
 The frontend proxy forwards **`X-Forwarded-For`** and **`X-Forwarded-Proto`** from your request when applicable.
 

package/index.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 /**
  * Extraktr CLI — calls the same POST /api/extract contract as the web app (via the frontend proxy).
@@ -70,7 +70,7 @@ Options:
   --help, -h          Show this help
 
 Notes:
-  Do not combine --file and --stdin. With --format json, stdout is valid JSON only on success (errors on stderr).
+  Do not combine --file and --stdin. On success, stdout is only the formatted result (text, markdown, or JSON). Errors go to stderr.
 
 Examples:
   extraktr extract --file sample.txt
@@ -265,7 +265,6 @@ async function run() {
   }
 
   const content = input.content;
-  const API_URL = extractUrl();
 
   const payload = { raw_content: content };
   if (opts.source) payload.source_type = opts.source;
@@ -279,13 +278,9 @@ async function run() {
     headers.Authorization = opts.bearer.startsWith("Bearer ") ? opts.bearer : `Bearer ${opts.bearer}`;
   }
 
-  if (opts.format !== "json") {
-    console.error("POST", API_URL);
-  }
-
   let res;
   try {
-    res = await fetch(API_URL, {
+    res = await fetch(extractUrl(), {
       method: "POST",
       headers,
       body: JSON.stringify(payload),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "extraktr",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "private": false,
   "description": "Terminal client for Extraktr — calls the same POST /api/extract contract as the web app.",
   "main": "index.js",