@v0idd0/tabsnap 1.0.0 → 1.0.2

package/README.md

@@ -1,13 +1,29 @@
 # tabsnap
 
-> One-click browser extension that captures every open tab as plain text,
-> markdown, JSON, or a readme file. Free, MIT, zero telemetry.
+[![npm version](https://img.shields.io/npm/v/@v0idd0/tabsnap.svg?color=A0573A)](https://www.npmjs.com/package/@v0idd0/tabsnap)
+[![npm downloads](https://img.shields.io/npm/dw/@v0idd0/tabsnap.svg?color=1F1A14)](https://www.npmjs.com/package/@v0idd0/tabsnap)
+[![License: MIT](https://img.shields.io/badge/license-MIT-A0573A.svg)](LICENSE)
+[![Manifest V3](https://img.shields.io/badge/manifest-v3-1F1A14)](https://developer.chrome.com/docs/extensions/mv3/intro/)
+[![Built by vøiddo](https://img.shields.io/badge/built%20by-v%C3%B8iddo-1F1A14)](https://voiddo.com/)
 
-[Landing page](https://extensions.voiddo.com/tabsnap/) ·
-[Privacy policy](https://extensions.voiddo.com/tabsnap/privacy/) ·
-[Contact](https://extensions.voiddo.com/tabsnap/contact/)
+> Capture every open tab as plain text, markdown, JSON, or a readme file.
+> One click in the browser. One pipe in the terminal.
+> Free, MIT, zero telemetry.
 
-## What it does
+[Browser-extension landing](https://extensions.voiddo.com/tabsnap/) ·
+[CLI landing](https://tools.voiddo.com/tabsnap/) ·
+[npm](https://www.npmjs.com/package/@v0idd0/tabsnap) ·
+[Privacy](https://extensions.voiddo.com/tabsnap/privacy/)
+
+---
+
+## Two faces, one engine
+
+The same `snapshot.js` formatters drive both the **browser extension** popup
+and the **`@v0idd0/tabsnap` CLI** on npm. Output bytes are identical for the
+same inputs.
+
+### As a browser extension
 
 Click the toolbar icon → tabsnap reads the title and URL of every tab you have
 open and renders them in the popup as one of four formats:
@@ -19,6 +35,53 @@ open and renders them in the popup as one of four formats:
 
 Hit **copy** or **download** and you're done.
 
+### As a CLI
+
+```sh
+npm i -g @v0idd0/tabsnap
+
+# pipe any tabs-shaped JSON in, get a snapshot out
+cat tabs.json | tabsnap                    # markdown (default)
+cat tabs.json | tabsnap --format=readme    # readme.md
+cat tabs.json | tabsnap -f json --no-group # flat structured array
+
+# from file
+tabsnap --file=tabs.json -f plain
+
+# include pinned + incognito tabs (skipped by default)
+tabsnap --include-pinned --include-incognito < tabs.json
+
+# pipe to clipboard (macOS) or any tool
+tabsnap --format=readme < tabs.json | pbcopy
+```
+
+Accepted input shapes (the CLI auto-detects):
+
+```jsonc
+// 1) bare array
+[ {"title":"…","url":"…","windowId":1,"pinned":false}, … ]
+
+// 2) {tabs:[…]} wrapper
+{ "tabs": [ … ] }
+
+// 3) {windows:[{tabs:[…]}]} wrapper — also matches the JSON tabsnap exports
+{ "windows": [ {"window_index":1, "tabs":[…]}, … ] }
+```
+
+### As a library
+
+```js
+const { formatTabs, filterTabs, groupTabsByWindow, countByDomain } = require('@v0idd0/tabsnap');
+
+const out = formatTabs(myTabs, 'markdown', {
+  groupByWindow: true,
+  includePinned: false,
+  includeIncognito: false,
+});
+```
+
+Pure functions, zero deps, works in any JS runtime that has `URL` + `Date`.
+
 ## Privacy
 
 tabsnap reads only `chrome.tabs` metadata (title, URL, windowId, pinned,
@@ -33,24 +96,39 @@ Permissions:
 
 No host permissions. No `activeTab`. No content scripts.
 
+The CLI is a Node.js process — it cannot reach the browser. It only formats
+JSON you hand it.
+
 ## Repo layout
 
     chrome/      Manifest V3 source for Chrome / Edge / Brave
     firefox/     Manifest V3 source with browser_specific_settings.gecko
     edge/        Manifest V3 source (mirrors chrome/)
+    src/         CLI / library source — published to npm as @v0idd0/tabsnap
+    bin/         CLI entry point
+    test.js      40 smoke tests for the lib + CLI
     dist/        Pre-built ZIPs ready for store submission
     shared/      Files copied into each platform tree at build time
 
 ## Build
 
-The platform directories are already self-contained — you can load any of
+The platform directories are already self-contained — load any of
 `chrome/`, `firefox/`, or `edge/` as an unpacked extension in the matching
 browser. The pre-built ZIPs in `dist/` are produced by zipping each platform
 directory.
 
+The npm package ships only `src/`, `bin/`, `README.md`, and `LICENSE` (whitelisted
+via the `files` field in `package.json`).
+
+```sh
+node test.js     # run all 40 tests
+npm publish --access public
+```
+
 ## License
 
 MIT — see `LICENSE`.
 
-Built by [vøiddo](https://voiddo.com/), a small studio shipping AI-flavoured
-tools, browser extensions and weird browser games.
+---
+
+Built by [vøiddo](https://voiddo.com/) — a small studio shipping AI-flavoured products, free dev tools, Chrome extensions and weird browser games.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@v0idd0/tabsnap",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "tabsnap — format a tab list (or any tabs-shaped JSON) as markdown, plain text, JSON, or a readme file. Library + CLI. Same formatters that power the tabsnap browser extension. Zero deps. Free forever from vøiddo.",
   "main": "src/index.js",
   "bin": {
@@ -34,7 +34,7 @@
   ],
   "author": "vøiddo <support@voiddo.com> (https://voiddo.com)",
   "license": "MIT",
-  "homepage": "https://extensions.voiddo.com/tabsnap/",
+  "homepage": "https://tools.voiddo.com/tabsnap/?ref=tabsnap-npm",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/voidd0/tabsnap.git"
@@ -53,4 +53,4 @@
   "engines": {
     "node": ">=14"
   }
-}
+}