@watermarkws/cli 0.1.1 → 0.1.3

package/README.md

@@ -28,7 +28,7 @@ watermark image process <source> --op <operation> [--op ...] [--format webp] [--
 watermark image read <source> [--level]   # --level also finds the angle that levels a tilted horizon
 watermark image create --width 1200 --height 300 --op 'text:text=Hi,font=inter-bold,size=96' --op trim --out logo.png
 watermark video process <source> --op <operation> [--max-duration 30] [--out file]
-watermark video read <source> | watermark video screenshot <source> --seconds 5
+watermark video read <source> | watermark video screenshot <source> --seconds 5 [--auto]   # --auto takes another frame when that one is blank
 watermark document process <source> --op <operation> [--max-pages 10] [--out file]
 watermark document read <source> | watermark document snapshot <source> --page 1
 watermark request get <id> | watermark request abort <id>

package/SKILL.md

@@ -26,7 +26,7 @@ watermark image process photo.jpg --op resize:width=1600,height=1600 --op waterm
 watermark image read photo.jpg --json                       # width, height, format; add --level for the angle that levels the horizon
 watermark image create --width 1200 --height 300 --op 'text:text=Lena Hart,font=inter-bold,size=96,color=#202020,position=center' --op trim --format png --out logo.png
 watermark video process clip.mp4 --op watermark:image_url=https://example.com/logo.png,x=24,y=24 --max-duration 30 --out preview.mp4
-watermark video screenshot clip.mp4 --seconds 5 --format png --out frame.png
+watermark video screenshot clip.mp4 --seconds 5 --auto --format png --out frame.png   # --auto: if that frame is blank (black, white, a fade), take one 10% in or the middle
 watermark document process contract.pdf --op watermark:image_url=https://example.com/stamp.png,x=20,y=230 --out contract-stamped.pdf
 watermark document snapshot contract.pdf --page 1 --format png --out page-1.png
 watermark operations image                                   # every operation and parameter, live from the API (also video, document)
@@ -35,9 +35,9 @@ watermark request get 1234                                   # follow a request
 watermark account                                            # balance and limits
 ```
 
-Useful options on processing commands: `--out <file>` (wait, then download), `--no-wait` (print the queued request and return), `--timeout <seconds>` (default 300), `--format <fmt>`, `--ops-json '[…]'` instead of `--op`, `--max-duration <s>` (video), `--max-pages <n>` (documents), `--customer <id>`, `--metadata key=value`, `--json`.
+Useful options on processing commands: `--out <file>` (wait, then download), `--no-wait` (print the queued request and return), `--timeout <seconds>` (default 300), `--format <fmt>`, `--ops-json '[…]'` instead of `--op`, `--max-duration <s>` (video), `--auto` (video screenshot: pass over a blank frame; `result.data.seconds` says which moment was used), `--max-pages <n>` (documents), `--customer <id>`, `--metadata key=value`, `--json`.
 
-Operations that exist: images `resize`, `crop`, `rotate`, `flip`, `grayscale`, `border`, `watermark`, `thumbnail`, `compress`, `sepia`, `exposure`, `filter`, `remove_background`, `orient`, `text`, `trim`, `color`, `frame`, `protect`, `shave`, `line`, `adjust`, `color_profile`; videos `resize`, `crop`, `rotate`, `flip`, `grayscale`, `border`, `watermark`; documents `watermark` only (an image on every page; make a text stamp with `image create` first). `watermark` takes `image_url` or `image` (a `file_…` id), `x`, `y` from the top left, `tile_spacing_x`/`tile_spacing_y` to repeat it, `diagonal_lines_color`/`diagonal_lines_opacity`. Run `watermark operations image` before using a parameter you are not sure of.
+Operations that exist: images `resize`, `crop`, `rotate`, `flip`, `grayscale`, `border`, `watermark`, `thumbnail`, `compress`, `sepia`, `exposure`, `filter`, `remove_background`, `orient`, `text`, `trim`, `color`, `frame`, `protect`, `shave`, `line`, `adjust`, `color_profile`; videos `resize`, `crop`, `rotate`, `flip`, `grayscale`, `border`, `watermark`; documents `watermark` only (an image on every page; make a text stamp with `image create` first). `watermark` takes `image_url` or `image` (a `file_…` id), `x`, `y` from the top left, `tile_spacing_x`/`tile_spacing_y` to repeat it. Run `watermark operations image` before using a parameter you are not sure of.
 
 ## A folder of files
 
@@ -81,7 +81,7 @@ A failed request has `"status": "failed"` and `error.code` / `error.message`. An
 ## Rules
 
 - Never paste file contents or base64 into a command; give the path and the CLI uploads it. Never ask the user to host a local file first.
-- Credit is prepaid and every finished request is charged ($0.002 an image, $0.004 a document page, $0.02 a started minute of video). Before more than about 20 files, a video over about 10 minutes, or a document with hundreds of pages, tell the user the cost and ask.
+- Credit is prepaid and every finished request is charged ($0.002 an image, $0.005 a document page, $0.03 a started minute of video). Before more than about 20 files, a video over about 10 minutes, or a document with hundreds of pages, tell the user the cost and ask.
 - Failed and aborted requests are free; fix the cause (the message names the field) and run again. Rate limits and server errors are retried by the CLI itself.
 - Always pass `--out` when the user wants the file, and `--json` when a script reads the result. Download links in `result.files[].url` last 7 days; `watermark file get <file_id>` gives a fresh one while the file is kept.
 - Video needs a live key on an account that has bought credit; a test key gets `402 paid_account_required`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@watermarkws/cli",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Watermark, resize and convert images, videos and PDFs from the command line with the Watermark API.",
   "type": "module",
   "bin": {

package/src/api.js

@@ -2,7 +2,7 @@
 // retries for 429 (after Retry-After), 5xx and dropped connections, with an
 // Idempotency-Key on every POST so a retried POST never runs twice.
 
-export const VERSION = '0.1.1';
+export const VERSION = '0.1.3';
 
 export class ApiError extends Error {
   constructor(status, error = {}) {

package/src/cli.js

@@ -9,7 +9,7 @@ Usage:
   watermark image create --width 1200 --height 300 [--background "#ffffff"] --op <operation> [--out file]
   watermark video process <source> --op <operation> [--max-duration 30] [--out file]
   watermark video read <source>
-  watermark video screenshot <source> --seconds 5 [--format png] [--out file]
+  watermark video screenshot <source> --seconds 5 [--auto] [--format png] [--out file]
   watermark document process <source> --op <operation> [--max-pages 10] [--out file]
   watermark document read <source>
   watermark document snapshot <source> [--page 1] [--format png] [--out file]
@@ -62,7 +62,7 @@ const ACTIONS = {
   documents: ['process', 'read', 'snapshot'],
 };
 const REPEATABLE = new Set(['op', 'metadata', 'prefix', 'event']);
-const FLAGS = new Set(['json', 'no-wait', 'help', 'version', 'level']);
+const FLAGS = new Set(['json', 'no-wait', 'help', 'version', 'level', 'auto']);
 
 // Parse argv into positionals and options; repeatable options collect arrays.
 export function parseArgs(argv) {
@@ -286,6 +286,11 @@ async function runMedia(api, media, [action, source], options, { output, print,
     body.level = true;
   }
 
+  if (options.auto) {
+    if (media !== 'videos' || action !== 'screenshot') throw new UsageError('--auto is for watermark video screenshot.');
+    body.auto = true;
+  }
+
   if (action === 'process' || action === 'create') {
     const operations = options['ops-json'] ? JSON.parse(options['ops-json']) : options.op.map(parseOperation);
     if (operations.length === 0) throw new UsageError('Give at least one --op (see: watermark operations).');