@confirmdev/listalyze 0.2.1

package/PUBLISH.md

@@ -0,0 +1,71 @@
+# Publishing `@listalyze/cli`
+
+This package is a **self-contained, standalone npm package**. It has **zero
+`workspace:*` dependencies** and an **empty runtime `dependencies`** block:
+
+- The engine packages (`@listalyze/engine-js`, `@listalyze/core`,
+  `@listalyze/operation-schemas`) are **inlined** into `dist/index.js` by esbuild
+  (`--packages=bundle`).
+- The license-nag WASM module is **vendored**, not a dependency. Its committed
+  nodejs binding (`license_nag.cjs` + `license_nag_bg.wasm`) lives in
+  `vendor/license-nag/` and is copied into `dist/vendor/license-nag/` at build
+  time. At runtime the bundle `require`s the `.cjs` from a path relative to
+  itself, and the `.cjs` loads its sibling `.wasm`. **`@listalyze/license-nag`
+  does NOT need to be published separately.**
+
+The vendored files are kept in sync from `packages/license-nag/pkg/` by the
+`sync-vendor` build step. If you regenerate the WASM bindings (re-run
+`packages/license-nag/build.sh`), just rebuild the CLI to re-vendor them.
+
+## Steps
+
+```bash
+# 1. Build (typecheck + re-vendor + esbuild bundle -> dist/, including dist/vendor/)
+pnpm --filter @listalyze/cli build
+
+# 2. Pack and REVIEW the file list before publishing
+cd apps/cli
+npm pack
+tar tzf listalyze-cli-*.tgz
+#   Expect exactly:
+#     package/package.json
+#     package/README.md
+#     package/PUBLISH.md
+#     package/dist/index.js
+#     package/dist/vendor/license-nag/license_nag.cjs
+#     package/dist/vendor/license-nag/license_nag_bg.wasm
+
+# 3. (Optional but recommended) prove the tarball is standalone in a clean dir
+TMP=$(mktemp -d) && cd "$TMP" && npm init -y >/dev/null \
+  && npm install /ABS/PATH/TO/listalyze-cli-*.tgz \
+  && printf 'b\na\na\n' | LISTALYZE_SKIP_NAG_DELAY=1 ./node_modules/.bin/listalyze dedupe
+# stdout should be: b\na   (nag box prints to stderr)
+
+# 4. Publish (needs the owner's npm auth token + the @listalyze scope/org)
+cd /path/to/repo/apps/cli
+npm publish --access public
+```
+
+## Before the first publish — package name / scope
+
+The package is named **`@listalyze/cli`**. To publish under that name the
+**`@listalyze` npm org/scope must exist** and your npm account must be a member
+with publish rights (`npm whoami`, then `npm org ls listalyze`). The final public
+name/scope is **the owner's call** — if `@listalyze` is unavailable, either:
+
+- create the `@listalyze` org on npmjs.com, or
+- rename to another scope you own (e.g. `@your-org/listalyze-cli`), or
+- publish unscoped (e.g. `listalyze`) if the name is free.
+
+`publishConfig.access` is already `public` (required for free scoped packages).
+`files` ships only `dist/` (including `dist/vendor/`), `README.md`, and
+`PUBLISH.md`. `bin.listalyze` → `dist/index.js`. `engines.node` is `>=20`.
+
+## Notes
+
+- `npm publish` is intentionally **manual** — it is never run by CI or any build
+  script in this repo.
+- `package.json` is currently `"private": true` to guard against accidental
+  publishes from the monorepo. Flip it to `false` (or remove the field) in the
+  publish commit when you are ready to ship.
+- Do not commit the generated `.tgz`.

package/README.md

@@ -0,0 +1,87 @@
+# @listalyze/cli
+
+The command-line surface of **Listalyze** — a local-first, privacy-first list &
+text power tool. It runs entirely offline on your machine and uses the same
+engine as the web app.
+
+> **Fully-usable open beta.** Every command works today with no account
+> required. The CLI shows a brief WinRAR/PKZIP-style "Unregistered copy"
+> reminder on **stderr** before each data command (and pauses ~2.5s). The
+> reminder is annoyance-only — it never blocks a command, and **stdout stays
+> clean** so pipes are unaffected. Registering a seat silences it. Run
+> `listalyze register` to learn more.
+
+## Install / build
+
+```bash
+pnpm install
+pnpm --filter @listalyze/cli build   # typecheck + esbuild bundle -> dist/index.js
+```
+
+`build` typechecks (`tsc --noEmit`) and then esbuilds `src/index.ts` into a
+single, self-contained, executable `dist/index.js`. The engine packages
+(`@listalyze/engine-js`, `@listalyze/core`, `@listalyze/operation-schemas`) are
+**inlined** from their TypeScript source, so the bundle runs with **no need to
+pre-build** any workspace package. The license-nag WASM module
+(`license_nag.cjs` + `license_nag_bg.wasm`) is **vendored** into
+`vendor/license-nag/` and copied to `dist/vendor/license-nag/` at build time, so
+it has **no separate dependency** — the published package is fully standalone
+with an empty `dependencies` block.
+
+The binary is `listalyze` (`bin` → `dist/index.js`).
+
+## Usage
+
+Every command reads from **stdin** (or `-i/--input <file>`) and writes to
+**stdout** (or `-o/--output <file>`).
+
+```bash
+printf 'banana\napple\napple\n' | node apps/cli/dist/index.js dedupe
+printf 'banana\napple\n'        | node apps/cli/dist/index.js sort
+listalyze sort -i list.txt -o sorted.txt
+listalyze register     # how to license Listalyze Pro
+```
+
+Set `LISTALYZE_SKIP_NAG_DELAY=1` to skip the unregistered-copy delay (the
+reminder is still printed to stderr).
+
+### Commands
+
+| Command | Description | Flags |
+| --- | --- | --- |
+| `sort` | Sort lines | `--desc`, `--numeric`, `--natural` |
+| `dedupe` | Remove duplicate lines (keep first) | |
+| `trim` | Trim leading/trailing whitespace per line | |
+| `remove-blanks` | Remove blank/whitespace-only lines | |
+| `regex-extract <pattern>` | Emit every regex match, one per line | `--flags <f>` (default `gi`) |
+| `regex-replace <pattern> <replacement>` | Replace regex matches | `--flags <f>` (default `g`) |
+| `stats` | Print list statistics | |
+| `register` | Show how to register Listalyze Pro | |
+
+Top-level: `--help`/`-h`, `--version`/`-v`. Each command also accepts `--help`.
+`--help`, `--version`, and `register` never show the registration reminder.
+
+On a pipeline error the first error message is printed to stderr and the process
+exits non-zero.
+
+## Registration
+
+`listalyze register` explains Listalyze Pro: **$6/month or $36/year per seat**,
+with one subscription covering web + CLI + desktop + mobile. Registration and
+login open at launch; for now, join the launch list at
+<https://listalyze.com/pricing>.
+
+The CLI reads a license token from `~/.config/listalyze/license.json`
+(`{ "token": "..." }`). A valid token silences the reminder. In-CLI sign-in
+(ConfirmID device/loopback login) that fetches and writes that token is a future
+task — this build cannot fetch a token yet.
+
+## Publishing
+
+> `npm publish` is a **manual** step (it is intentionally not run by CI or any
+> build script here).
+
+The package is **fully standalone** (zero `workspace:*` deps, empty runtime
+`dependencies`): engine packages are bundled and license-nag is vendored. See
+[`PUBLISH.md`](./PUBLISH.md) for the exact steps (`build` → `npm pack` →
+`npm publish --access public`) and the name/scope notes.