@sifurai/cli 0.1.4 → 0.1.5

package/README.md

@@ -96,7 +96,8 @@ sifur accept AZA-12 --url https://test.example.internal
 
 1. Finds the ticket in your organizations and downloads its cases.
 2. Runs each UI case in a headless browser against `--url` (paths in the cases are relative to
-   it), taking a screenshot after every step. Add `--headed` to watch.
+   it), taking a screenshot after every step, in a browser window you can watch. Add `--headless`
+   to run it without one.
 3. For a step that needs a person's eye, shows you the screenshot's path and asks whether it looks
    right.
 4. Runs automated cases in your checkout of their repository (see below); without one, asks you
@@ -193,7 +194,7 @@ sifur record AZA-12 --new "…" --repository web            # when the project h
 Like `accept`, it uses the project's test server unless `--url` names another. The CLI:
 
 1. Downloads the ticket's cases and signs in to your test server with Sifur's sign-in (the steps
-   every UI case starts with), in a browser you don't see (`--headed` shows it). The sign-in's
+   every UI case starts with), in a browser you can watch (`--headless` hides it). The sign-in's
    secrets come from `SIFUR_SECRET_<NAME>`, or are asked for, as for `accept`.
 2. Opens Playwright's recorder in Chrome (or Edge), already signed in, on the page the sign-in
    left it at. Do the case's steps, then check the result with the toolbar's **Assert text** or
@@ -275,7 +276,7 @@ SIFUR_SECRET_ADMIN_PASSWORD='…' sifur accept AZA-12 --url https://test.example
 | Option | |
 |---|---|
 | `--url <url>` | Your test server, where the ticket's branch is deployed |
-| `--headed` | Show the browser while the cases run |
+| `--headless` | Run the browser without showing it; it shows by default |
 | `--timeout <seconds>` | How long each browser step may take, page loads included (default 60). Raise it when the test server is slow, for example over a VPN |
 | `--workdir <repository>=<dir>` | Run that repository's automated cases in `<dir>`; repeatable. Default: the checkout you're in, when it's that repository's |
 | `--download` / `--run` / `--upload` | The three steps for a full-tunnel VPN |

package/dist/cli.js

@@ -13,17 +13,17 @@ const USAGE = `Usage:
   sifur logout
   sifur apply <KEY|uuid> [--workdir <repo>=<dir> …]
   sifur apply <KEY|uuid> --revert
-  sifur accept <KEY|uuid> --url <test url> [--apply] [--headed] [--workdir <repo>=<dir> …]
+  sifur accept <KEY|uuid> [--url <test url>] [--apply] [--headless] [--workdir <repo>=<dir> …]
   sifur accept <KEY|uuid> --download [--apply]
-  sifur accept <KEY|uuid> --run --url <test url> [--headed] [--workdir <repo>=<dir> …]
+  sifur accept <KEY|uuid> --run [--url <test url>] [--headless] [--workdir <repo>=<dir> …]
   sifur accept <KEY|uuid> --upload
-  sifur record <KEY|uuid> <TC-n> [--url <test url>] [--headed]
-  sifur record <KEY|uuid> --new "<title>" [--repository <name>] [--url <test url>] [--headed]
+  sifur record <KEY|uuid> <TC-n> [--url <test url>] [--headless]
+  sifur record <KEY|uuid> --new "<title>" [--repository <name>] [--url <test url>] [--headless]
 
 Options:
   --api <url>              Sifur's API (default ${DEFAULT_API}, or SIFUR_API_URL)
-  --url <url>              Your test server, where the ticket's branch is deployed
-  --headed                 Show the browser while the cases run
+  --url <url>              Your test server (default: the project's saved address)
+  --headless               Run the browser without showing it (it shows by default)
   --timeout <seconds>      How long each browser step may take (default 60; raise it for a slow VPN)
   --apply                  Put Sifur's changes in your checkouts first, uncommitted, as \`sifur apply\` does
   --revert                 Take the changes \`sifur apply\` put in back out
@@ -72,7 +72,9 @@ export async function main(argv, io, env = process.env, cwd = process.cwd()) {
         options: {
             api: { type: 'string' },
             url: { type: 'string' },
+            // Kept so older instructions still work: the browser shows by default now.
             headed: { type: 'boolean', default: false },
+            headless: { type: 'boolean', default: false },
             timeout: { type: 'string' },
             workdir: { type: 'string', multiple: true, default: [] },
             download: { type: 'boolean', default: false },
@@ -135,7 +137,7 @@ export async function main(argv, io, env = process.env, cwd = process.cwd()) {
                 ref,
                 mode,
                 url: values.url,
-                headed: values.headed,
+                headed: !values.headless,
                 workdirs: parseWorkdirs(values.workdir ?? []),
                 cwd,
                 store: cacheDir(env),
@@ -155,7 +157,7 @@ export async function main(argv, io, env = process.env, cwd = process.cwd()) {
                 title: values.new,
                 repository: values.repository,
                 url: values.url,
-                headed: values.headed,
+                headed: !values.headless,
                 consoleOrigin: env.SIFUR_CONSOLE_URL ?? credentials?.console ?? null,
             }, { io, env, timeoutMs: timeoutSeconds(values.timeout) * 1000 });
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sifurai/cli",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "Run a Sifur ticket's acceptance cases against your own test server and upload the results.",
   "license": "UNLICENSED",
   "homepage": "https://sifur.ai",