postman-cli 1.66.0 → 1.68.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/man/postman.1 +186 -84
  2. package/package.json +6 -6
package/man/postman.1 CHANGED
@@ -1,4 +1,4 @@
1
- .TH POSTMAN 1 "2026-09-28" "v1.66.0" "Postman CLI Manual"
1
+ .TH POSTMAN 1 "2026-10-01" "v1.68.0" "Postman CLI Manual"
2
2
  .SH NAME
3
3
  postman \- Command\-line companion utility for Postman
4
4
  .SH SYNOPSIS
@@ -287,12 +287,12 @@ Migrate a v2.1 collection to the v3 format
287
287
  .B collection lint
288
288
  Run linting on a local v3 collection at the given file or directory path.
289
289
  .TP
290
- .B collection ai-readiness
291
- Score a Postman collection for AI readiness by ID, local file path, or local\-mode directory.
292
- .TP
293
290
  .B collection get
294
291
  Fetch a Postman collection in the V3 format and print it.
295
292
  .TP
293
+ .B collection publish
294
+ Publish a cloud collection's documentation (or request Community Manager approval).
295
+ .TP
296
296
  .B collection generate
297
297
  Generate artifacts from a collection.
298
298
  .TP
@@ -305,6 +305,9 @@ Add, update, or remove requests in a local v3 collection.
305
305
  .B collection folder
306
306
  Add, update, or remove folders in a local v3 collection.
307
307
  .TP
308
+ .B collection import
309
+ Import a cURL or HAR source into a v3 collection (local, or cloud with \-\-workspace).
310
+ .TP
308
311
  .B collection list
309
312
  List collections: your local project's collections by default, or a Postman cloud workspace's collections with \-\-workspace.
310
313
  .TP
@@ -371,53 +374,65 @@ Exit with failure if diagnostics at this level or above are present. [choices: "
371
374
  .B \-r, \-\-reporter <value>
372
375
  Output format: cli (human\-readable) or json. (default: cli)
373
376
 
374
- .SS "collection ai\-readiness"
375
- Score a Postman collection for AI readiness by ID, local file path, or local\-mode directory.
377
+ .SS "collection get"
378
+ Fetch a Postman collection in the V3 format and print it.
376
379
 
377
380
  .B Usage:
378
- <collectionId/Path> [options]
381
+ [options] <id>
379
382
 
380
383
  .B Options:
381
384
  .TP
382
- .B \-o, \-\-output <value>
383
- Output format for the results. [choices: "cli", "json", "html"]
384
- .TP
385
- .B \-\-export <path>
386
- Write the report to this file instead of stdout. A directory receives the report under a name derived from the collection. Requires \-\-output html.
385
+ .B \-\-api\-key <key>
386
+ Postman API key (defaults to your `postman login` session)
387
387
  .TP
388
- .B \-\-min\-score <n>
389
- Exit with a non\-zero code if the overall score is below this threshold (0\-100).
388
+ .B \-\-json
389
+ Print the collection as machine\-readable V3 JSON instead of a table
390
390
 
391
391
  .TP Examples:
392
392
 
393
- Examples:
394
- $ postman collection ai\-readiness ./postman/collections/My\e API
395
- $ postman collection ai\-readiness ./my\-collection.json
396
- $ postman collection ai\-readiness 631643\-f695cab7\-... \-\-output json
397
- $ postman collection ai\-readiness ./my\-collection.json \-\-output html > report.html
398
- $ postman collection ai\-readiness ./my\-collection.json \-\-min\-score 70
399
-
400
- Resolving a collection by ID requires authentication. Use `postman login` before running this command with a UID.
393
+ Eg. postman collection get 12345\-33823532ab9e41c9b6fd12d0fd459b8b
394
+ postman collection get 0123456789abcdef01234567 \-\-json
401
395
 
402
396
 
403
- .SS "collection get"
404
- Fetch a Postman collection in the V3 format and print it.
397
+ .SS "collection publish"
398
+ Publish a cloud collection's documentation (or request Community Manager approval).
405
399
 
406
400
  .B Usage:
407
- [options] <id>
401
+ [options] <collection\-id>
408
402
 
409
403
  .B Options:
410
404
  .TP
405
+ .B \-\-target <name>
406
+ Where to publish (default: documentation) (default: documentation)
407
+ .TP
408
+ .B \-\-environment <environment\-id>
409
+ Cloud environment UID to bind to the docs
410
+ .TP
411
+ .B \-\-title <seo\-title>
412
+ SEO title meta tag (max 120 characters)
413
+ .TP
414
+ .B \-\-description <seo\-description>
415
+ SEO description meta tag (max 320 characters)
416
+ .TP
417
+ .B \-\-note <text>
418
+ Note for Community Managers (request\-to\-publish only)
419
+ .TP
411
420
  .B \-\-api\-key <key>
412
421
  Postman API key (defaults to your `postman login` session)
413
422
  .TP
414
423
  .B \-\-json
415
- Print the collection as machine\-readable V3 JSON instead of a table
424
+ Machine\-readable JSON on stdout (errors on stderr)
416
425
 
417
426
  .TP Examples:
418
427
 
419
- Eg. postman collection get 12345\-33823532ab9e41c9b6fd12d0fd459b8b
420
- postman collection get 0123456789abcdef01234567 \-\-json
428
+ Cloud only — pass a collection UID, not a local path or name.
429
+
430
+ Examples:
431
+ postman collection publish 12345\-33823532\-ab9e\-41c9\-b6fd\-12d0fd459b8b
432
+ postman collection publish <collection\-id> \-\-title "Orders API" \-\-description "Public Orders reference"
433
+ postman collection publish <collection\-id> \-\-note "Ready for Q3 review."
434
+ postman collection publish <collection\-id> \-\-json
435
+
421
436
 
422
437
 
423
438
  .SS "collection generate"
@@ -563,13 +578,16 @@ Folder to scope the request selector, e.g. "Users/Admin" (local: name/path; clou
563
578
  Rename the request (moves its file). Any request type.
564
579
  .TP
565
580
  .B \-\-url <url>
566
- Request URL. Any request type.
581
+ Request URL; its query string becomes the query parameters. Any request type.
567
582
  .TP
568
583
  .B \-\-method <method>
569
584
  HTTP method (http requests only).
570
585
  .TP
571
586
  .B \-\-param <key:value>
572
- Replace query parameters. Repeatable (http requests only). (default: )
587
+ Replace all query parameters and the url query string. Repeatable (http requests only). (default: )
588
+ .TP
589
+ .B \-\-clear\-params
590
+ Remove all query parameters and the url query string (http requests only).
573
591
  .TP
574
592
  .B \-d, \-\-body <body>
575
593
  Request payload (inline, @file, or \- for stdin), interpreted by request type. For http, an optional "<type>:" prefix picks the content type: json/text/xml/html/javascript, file:<path>, urlencoded:key=v&k2=v2, or formdata:key=v&file=@path.
@@ -600,10 +618,12 @@ JSON output.
600
618
 
601
619
  .TP Examples:
602
620
 
603
- Works on any request type; \-\-rename/\-\-url/\-\-description/\-\-headers/\-\-auth/\-\-scripts apply to all, while \-\-method/\-\-param/\-\-body are http\-only. Select the request by the <request> selector: local — a name or "Folder/Name" path (or \-\-folder to scope a bare name); cloud (\-\-workspace) — a request id, with \-\-collection an id too.
621
+ Works on any request type; \-\-rename/\-\-url/\-\-description/\-\-headers/\-\-auth/\-\-scripts apply to all, while \-\-method/\-\-param/\-\-clear\-params are http\-only and \-\-body is interpreted per type. \-\-param and \-\-clear\-params apply after \-\-url. Select the request by the <request> selector: local — a name or "Folder/Name" path (or \-\-folder to scope a bare name); cloud (\-\-workspace) — a request id, with \-\-collection an id too.
604
622
 
605
623
  Examples:
606
624
  postman collection request update "Get user" \-\-collection "My API" \-\-url "{{baseUrl}}/users/:id"
625
+ postman collection request update "List" \-\-collection "My API" \-\-url "{{baseUrl}}/orders?limit=99"
626
+ postman collection request update "List" \-\-collection "My API" \-\-clear\-params
607
627
  postman collection request update "Get user" \-\-collection "My API" \-\-folder Users \-\-rename "Fetch user"
608
628
  postman collection request update "Get user" \-\-collection "My API" \-\-headers "Authorization:Bearer x" \-\-auth bearer:TOKEN \-\-scripts "test:@check.js"
609
629
  postman collection request update <requestId> \-\-collection <collectionId> \-\-url "..." \-w <workspaceId>
@@ -770,6 +790,50 @@ Examples:
770
790
 
771
791
 
772
792
 
793
+ .SS "collection import"
794
+ Import a cURL or HAR source into a v3 collection (local, or cloud with \-\-workspace).
795
+
796
+ .B Usage:
797
+ [options] <src>
798
+
799
+ .B Options:
800
+ .TP
801
+ .B \-\-type <format>
802
+ Source format: curl or har. Auto\-detected from the extension/content when omitted.
803
+ .TP
804
+ .B \-\-name <name>
805
+ Collection display name. Defaults to a per\-format fallback.
806
+ .TP
807
+ .B \-o, \-\-output <dir>
808
+ Output directory for the local collection (default: postman/collections/<name>).
809
+ .TP
810
+ .B \-w, \-\-workspace <id>
811
+ Create the collection in a Postman cloud workspace by id (cloud mode).
812
+ .TP
813
+ .B \-\-force
814
+ Overwrite an existing local target directory.
815
+ .TP
816
+ .B \-\-timeout <ms>
817
+ Max time for a cloud import, in milliseconds (default 120000).
818
+ .TP
819
+ .B \-\-verbose
820
+ Verbose output (cloud import diagnostics).
821
+ .TP
822
+ .B \-\-json
823
+ JSON output.
824
+
825
+ .TP Examples:
826
+
827
+ <src> is a file path, `\-` for stdin, or an inline cURL command.
828
+
829
+ Examples:
830
+ postman collection import ./login.curl
831
+ postman collection import ./session.har \-\-name "Recorded session"
832
+ pbpaste | postman collection import \- \-\-type curl \-\-name Users
833
+ postman collection import ./session.har \-\-name Session \-\-workspace <workspaceId>
834
+
835
+
836
+
773
837
  .SS "collection list"
774
838
  List collections: your local project's collections by default, or a Postman cloud workspace's collections with \-\-workspace.
775
839
 
@@ -821,7 +885,7 @@ Specify an Id or path to a file containing Postman Globals
821
885
  Specify the reporters to use for the run: cli,json,junit,html. For multiple reporters, provide their names as a comma\-separated list (E.g., \-r cli,json) (default: cli)
822
886
  .TP
823
887
  .B \-\-output <folder>
824
- Write a YAML\-based run report to the given folder. Creates a paired `<prefix>.collection\-run\-summary.yaml` (refreshed during the run) and streaming `<prefix>.collection\-run\-executions.yaml`, where prefix defaults to `<collection\-slug>\-<timestamp>`. Gotcha: \-\-output streams run data to file and cannot be combined with the built\-in reporters (\-r/\-\-reporter\-*); doing so exits with an error. This keeps large runs from buffering an entire report in memory.
888
+ Write a YAML\-based run report to the given folder. Creates a paired `<prefix>.collection\-run\-summary.yaml` (refreshed during the run) and streaming `<prefix>.collection\-run\-executions.yaml`, where prefix defaults to `<collection\-slug>\-<timestamp>`. Gotcha: \-\-output streams run data to file, which keeps large runs from buffering an entire report in memory.
825
889
  .TP
826
890
  .B \-\-reporter\-[reporter]\-export <path>
827
891
  [Optional] Specify a path to save the report. By default, reports are saved to the /postman\-cli\-reports directory in your current working directory. If the directory doesn't exist, it will be created automatically. If the specified path is an existing directory, the report file will be saved within it. Supported reporters: json, junit and html.
@@ -854,13 +918,13 @@ Define the number of iterations to run
854
918
  Specify a data file to use for iterations (either JSON or CSV)
855
919
  .TP
856
920
  .B \-\-iteration\-data\-dataset <pathOrId>
857
- [BETA] Path to a .dataset.yaml (local collection) or a cloud dataset id (cloud collection) whose view drives the iteration data. Mutually exclusive with \-\-iteration\-data. Requires \-\-iteration\-data\-view.
921
+ Path to a .dataset.yaml (local collection) or a cloud dataset id (cloud collection) whose view drives the iteration data. Mutually exclusive with \-\-iteration\-data. Requires \-\-iteration\-data\-view.
858
922
  .TP
859
923
  .B \-\-iteration\-data\-view <nameOrId>
860
- [BETA] Name or id of the view to execute (within \-\-iteration\-data\-dataset). The view's result set drives one iteration per row.
924
+ Name or id of the view to execute (within \-\-iteration\-data\-dataset). The view's result set drives one iteration per row.
861
925
  .TP
862
926
  .B \-\-dataset <pathOrDir>
863
- [BETA] Pass \-\-dataset multiple times to load several .dataset.yaml files (or directories containing them). Each is made available to collection scripts and local mock handlers as pm.datasets(<id>). When provided, auto\-discovery of .dataset.yaml files from the collection's parent repo is disabled. For a cloud collection, scripts address cloud datasets by id via pm.datasets(<id>) (resolved from your `postman login` session). SECURITY: for a cloud collection this does NOT scope access — a script can pm.datasets(<anyId>) for any dataset your session can read. Only run collections you trust against a logged\-in cloud session. (default: )
927
+ Pass \-\-dataset multiple times to load several .dataset.yaml files (or directories containing them). Each is made available to collection scripts and local mock handlers as pm.datasets(<id>). When provided, auto\-discovery of .dataset.yaml files from the collection's parent repo is disabled. For a cloud collection, scripts address cloud datasets by id via pm.datasets(<id>) (resolved from your `postman login` session). SECURITY: for a cloud collection this does NOT scope access — a script can pm.datasets(<anyId>) for any dataset your session can read. Only run collections you trust against a logged\-in cloud session. (default: )
864
928
  .TP
865
929
  .B \-i <id>
866
930
  Specify the request/folder id, name, or path to run from the collection. Use a path (e.g. "FolderName/RequestName") to disambiguate items with the same name. Can be specified multiple times to run multiple items (default: )
@@ -1424,10 +1488,6 @@ Lint and validate Specifications from the command line
1424
1488
  .B spec lint
1425
1489
  Run linting on the given specification by ID or local file path.
1426
1490
 
1427
- .TP
1428
- .B spec ai-readiness
1429
- Score an OpenAPI specification for AI readiness by ID or local file path.
1430
-
1431
1491
  .TP
1432
1492
  .B spec list
1433
1493
  List local spec files under a path, or (no path) a workspace's cloud specs.
@@ -1474,34 +1534,6 @@ Accepted for compatibility; analytics are sent by default
1474
1534
  .B \-\-no\-report\-events
1475
1535
  Do not send analytics to Postman
1476
1536
 
1477
- .SS "spec ai\-readiness"
1478
- Score an OpenAPI specification for AI readiness by ID or local file path.
1479
-
1480
-
1481
- .B Usage:
1482
- <spec> [options]
1483
-
1484
- .B Options:
1485
- .TP
1486
- .B \-o, \-\-output <value>
1487
- Output format for the results. [choices: "cli", "json", "html"]
1488
- .TP
1489
- .B \-\-export <path>
1490
- Write the report to this file instead of stdout. A directory receives the report under a name derived from the specification. Requires \-\-output html.
1491
- .TP
1492
- .B \-\-min\-score <n>
1493
- Exit with a non\-zero code if the overall score is below this threshold (0\-100).
1494
-
1495
- .TP Examples:
1496
-
1497
- Examples:
1498
- $ postman spec ai\-readiness ./openapi.yaml
1499
- $ postman spec ai\-readiness 6e2e5b3e\-... \-\-output json
1500
- $ postman spec ai\-readiness ./openapi.yaml \-\-output html > report.html
1501
- $ postman spec ai\-readiness ./openapi.yaml \-\-output html \-\-export ./report.html
1502
- $ postman spec ai\-readiness ./openapi.yaml \-\-min\-score 70
1503
-
1504
-
1505
1537
  .SS "spec list"
1506
1538
  List local spec files under a path, or (no path) a workspace's cloud specs.
1507
1539
 
@@ -1796,7 +1828,7 @@ Invoke a monitor run and display results.
1796
1828
  Create a collection\-based monitor.
1797
1829
  .TP
1798
1830
  .B monitor update
1799
- Update a monitor's schedule, runner, notifications or run options.
1831
+ Update a monitor's schedule, runner, notifications, request selection or run options.
1800
1832
  .TP
1801
1833
  .B monitor delete
1802
1834
  Permanently delete a monitor. Prompts for confirmation unless \-\-yes is passed.
@@ -1874,6 +1906,9 @@ Time zone for \-\-schedule, for example America/New_York (defaults to the host m
1874
1906
  .B \-\-runner <value>
1875
1907
  A Postman region name (see `postman runner regions`) or the id of a self\-hosted runner created in Postman (list existing ones with `postman runner list`) to run from (repeatable) (default: )
1876
1908
  .TP
1909
+ .B \-i, \-\-item <id>
1910
+ Id of a request or folder in the collection to run, in the order given (repeatable; ids only, not names or paths; defaults to every request; list ids with `postman collection get <collection\-id> \-\-json`) (default: )
1911
+ .TP
1877
1912
  .B \-\-notify\-email <email>
1878
1913
  Email to notify on a run failure or error (repeatable) (default: )
1879
1914
  .TP
@@ -1928,12 +1963,13 @@ Examples:
1928
1963
  postman monitor create \-\-collection 12345678\-90ab\-cdef\-1234\-567890abcdef
1929
1964
  postman monitor create \-\-collection <id> \-\-schedule "0 9 * * MON" \-\-timezone America/New_York
1930
1965
  postman monitor create \-\-collection <id> \-\-runner us\-east \-\-runner <self\-hosted\-runner\-id>
1966
+ postman monitor create \-\-collection <id> \-\-item <request\-id> \-\-item <folder\-id>
1931
1967
  postman monitor create \-\-collection <id> \-\-workspace 12345678\-90ab\-cdef\-1234\-567890abcdef
1932
1968
 
1933
1969
 
1934
1970
 
1935
1971
  .SS "monitor update"
1936
- Update a monitor's schedule, runner, notifications or run options.
1972
+ Update a monitor's schedule, runner, notifications, request selection or run options.
1937
1973
 
1938
1974
  .B Usage:
1939
1975
  [options] <monitorId>
@@ -1952,6 +1988,12 @@ Time zone for \-\-schedule, for example America/New_York (defaults to the host m
1952
1988
  .B \-\-runner <value>
1953
1989
  A Postman region name (see `postman runner regions`) or the id of a self\-hosted runner created in Postman (list existing ones with `postman runner list`) to run from (repeatable; replaces the current set) (default: )
1954
1990
  .TP
1991
+ .B \-i, \-\-item <id>
1992
+ Id of a request or folder in the collection to run, in the order given (repeatable; ids only, not names or paths; replaces the saved selection; list ids with `postman collection get <collection\-id> \-\-json`) (default: )
1993
+ .TP
1994
+ .B \-\-clear\-items
1995
+ Remove the saved selection so the monitor runs every request in its collection
1996
+ .TP
1955
1997
  .B \-\-notify\-email <email>
1956
1998
  Email to notify on a run failure or error (repeatable; replaces the current list) (default: )
1957
1999
  .TP
@@ -2013,6 +2055,8 @@ Examples:
2013
2055
  postman monitor update <id> \-\-notify\-email a@example.com \-\-notify\-email b@example.com
2014
2056
  postman monitor update <id> \-\-clear\-notifications
2015
2057
  postman monitor update <id> \-\-runner us\-east \-\-runner <self\-hosted\-runner\-id>
2058
+ postman monitor update <id> \-\-item <request\-id> \-\-item <folder\-id>
2059
+ postman monitor update <id> \-\-clear\-items
2016
2060
  postman monitor update <id> \-\-environment 12345678\-90ab\-cdef\-1234\-567890abcdef
2017
2061
 
2018
2062
  This command cannot change a monitor's linked collection \-\- that is fixed when the monitor is created, so run a different collection by creating a new monitor. It does not pause or resume a monitor either; use `monitor pause`/`monitor resume` for that.
@@ -2332,6 +2376,9 @@ Filter workspaces by name.
2332
2376
  .B \-t, \-\-type <type>
2333
2377
  Filter workspaces by visibility type: team, public, private, personal.
2334
2378
  .TP
2379
+ .B \-\-cursor <cursor>
2380
+ Fetch the page of workspaces that follows this cursor.
2381
+ .TP
2335
2382
  .B \-\-verbose
2336
2383
  Verbose output
2337
2384
  .TP
@@ -2348,6 +2395,7 @@ Examples:
2348
2395
  postman workspace list \-\-filter "my\-workspace"
2349
2396
  postman workspace list \-\-type team
2350
2397
  postman workspace list \-\-type team \-\-filter "project"
2398
+ postman workspace list \-\-cursor "<cursor>"
2351
2399
 
2352
2400
 
2353
2401
 
@@ -2361,6 +2409,9 @@ Prepare local collections and environments for push by validating and regenerati
2361
2409
  .TP
2362
2410
  .B \-\-verbose
2363
2411
  Show detailed logging
2412
+ .TP
2413
+ .B \-\-json
2414
+ Print the outcome as machine\-readable JSON.
2364
2415
 
2365
2416
  .SS "workspace push"
2366
2417
  Push local workspace entities (collections, environments, specifications, mocks and more) to Postman workspace.
@@ -2379,6 +2430,9 @@ Skip all confirmation prompts
2379
2430
  .B \-\-push\-strategy <strategy>
2380
2431
  Push strategy. "force\-sync": mirror the whole workspace — also DELETE cloud entities that have no local counterpart (destructive). Defaults to "default" (create/update only).
2381
2432
  .TP
2433
+ .B \-\-json
2434
+ Print the outcome as machine\-readable JSON. Implies non\-interactive: use \-\-yes to actually push.
2435
+ .TP
2382
2436
  .B \-\-verbose
2383
2437
  Show detailed logging
2384
2438
  .TP
@@ -2470,6 +2524,9 @@ Create the workspace without binding it to the repository
2470
2524
  .TP
2471
2525
  .B \-\-force
2472
2526
  Create even when a workspace is already recorded for this repo
2527
+ .TP
2528
+ .B \-\-json
2529
+ Print the created workspace as machine\-readable JSON.
2473
2530
 
2474
2531
  .TP Examples:
2475
2532
 
@@ -2531,6 +2588,9 @@ Skip all confirmation prompts
2531
2588
  .B \-\-source\-workspace <workspaceId>
2532
2589
  Pull from a different source workspace.
2533
2590
  .TP
2591
+ .B \-\-json
2592
+ Print the outcome as machine\-readable JSON. Implies non\-interactive: use \-\-yes to actually pull.
2593
+ .TP
2534
2594
  .B \-\-verbose
2535
2595
  Show detailed logging
2536
2596
 
@@ -2557,6 +2617,9 @@ Connect a Postman workspace to a local git repository.
2557
2617
  .TP
2558
2618
  .B \-\-verbose
2559
2619
  Show detailed logging
2620
+ .TP
2621
+ .B \-\-json
2622
+ Print the outcome as machine\-readable JSON.
2560
2623
 
2561
2624
  .TP Examples:
2562
2625
 
@@ -2583,6 +2646,9 @@ Skip all confirmation prompts
2583
2646
  .TP
2584
2647
  .B \-\-verbose
2585
2648
  Show detailed logging
2649
+ .TP
2650
+ .B \-\-json
2651
+ Print the outcome as machine\-readable JSON. Requires \-\-yes to actually disconnect.
2586
2652
 
2587
2653
  .TP Examples:
2588
2654
 
@@ -3228,6 +3294,30 @@ Preserves the original HTTP method when following redirects. By default, redirec
3228
3294
  .B \-\-redirects\-remove\-referrer
3229
3295
  Removes the Referer header when following redirects. By default, Referer header is sent with redirects.
3230
3296
  .TP
3297
+ .B \-k, \-\-insecure
3298
+ Disable SSL certificate verification.
3299
+ .TP
3300
+ .B \-\-ssl\-client\-cert\-list <path>
3301
+ Specify the path to client certificate configurations (JSON).
3302
+ .TP
3303
+ .B \-\-ssl\-client\-cert <path>
3304
+ Specify the path to a client certificate (PEM).
3305
+ .TP
3306
+ .B \-\-ssl\-client\-key <path>
3307
+ Specify the path to a client certificate private key.
3308
+ .TP
3309
+ .B \-\-ssl\-client\-passphrase <passphrase>
3310
+ Specify the client certificate passphrase (for protected key).
3311
+ .TP
3312
+ .B \-\-ssl\-extra\-ca\-certs <path>
3313
+ Specify additional trusted CA certificates (PEM).
3314
+ .TP
3315
+ .B \-\-cookie\-jar <path>
3316
+ Specify the path to a custom cookie jar (serialized tough\-cookie JSON).
3317
+ .TP
3318
+ .B \-\-export\-cookie\-jar <path>
3319
+ Export the cookie jar to a file after completing the request.
3320
+ .TP
3231
3321
  .B \-\-retry <n>
3232
3322
  Number of retry attempts for failed requests (4xx, 5xx, network errors). Useful for flaky endpoints or rate\-limited APIs. (default: 0)
3233
3323
  .TP
@@ -3975,6 +4065,9 @@ Workspace that owns the run, for recording its start history. Auto\-resolved for
3975
4065
  .B \-\-no\-history
3976
4066
  Do not record this run in the mock's start history.
3977
4067
  .TP
4068
+ .B \-\-output <format>
4069
+ Live output format: auto (default, human\-readable logs) or ndjson (one JSON event per line on stdout, ending with a "summary" event — for CI or other non\-interactive use) (default: auto)
4070
+ .TP
3978
4071
  .B \-\-dataset <pathOrDir>
3979
4072
  Pass \-\-dataset multiple times to load several .dataset.yaml files (or directories containing them). Each is made available to the mock's handlers as pm.datasets(<id>). (default: )
3980
4073
 
@@ -3985,6 +4078,7 @@ Eg. postman mock run 12345678\-90ab\-cdef\-1234\-567890abcdef # by id, from Pos
3985
4078
  postman mock run ./postman/mocks/orders \-\-environment ./postman/environments/dev.environment.yaml
3986
4079
  postman mock run ./postman/mocks/orders \-\-port auto # pick any free port
3987
4080
  postman mock run ./postman/mocks/orders \-\-port 4600 # use port 4600 (fails if it is in use)
4081
+ postman mock run ./postman/mocks/orders \-\-output ndjson # stream machine\-readable events
3988
4082
  postman mock run ./postman/mocks/orders \-\-workspace <id> # record start history for a path run
3989
4083
  postman mock run ./postman/mocks/orders \-\-dataset ./postman/datasets/Orders
3990
4084
 
@@ -5631,7 +5725,7 @@ Run an ad\-hoc SQL query against a dataset (local YAML path or cloud id).
5631
5725
  .B Options:
5632
5726
  .TP
5633
5727
  .B \-q, \-\-query <sql>
5634
- SQL query to execute (e.g. "SELECT * FROM source_users LIMIT 10")
5728
+ SQL query to execute (e.g. "SELECT * FROM users LIMIT 10")
5635
5729
  .TP
5636
5730
  .B \-s, \-\-source <nameOrIdOrSlug>
5637
5731
  Execute directly against a database datasource; without \-\-source, use federated SQLite
@@ -5651,10 +5745,10 @@ Include safe classified dataset diagnostics
5651
5745
  .TP Examples:
5652
5746
 
5653
5747
  Examples:
5654
- postman dataset query ./users.dataset.yaml \-q "SELECT * FROM source_users LIMIT 5"
5748
+ postman dataset query ./users.dataset.yaml \-q "SELECT * FROM users LIMIT 5"
5655
5749
  postman dataset query ./users.dataset.yaml \-\-source warehouse \-q "SELECT * FROM users LIMIT 5"
5656
5750
  postman dataset query ./users.dataset.yaml \e
5657
- \-q 'SELECT * FROM source_users WHERE id = $1 AND active = $2' \-p 42 true
5751
+ \-q 'SELECT * FROM users WHERE id = $1 AND active = $2' \-p 42 true
5658
5752
  postman dataset query 14e30f6c\-1234\-1234\-1234\-cafef00dc0de \-q "SELECT * FROM users LIMIT 5"
5659
5753
 
5660
5754
 
@@ -5783,19 +5877,19 @@ Add a datasource to a dataset.
5783
5877
  Dataset to add the source to; positional target is also accepted for v1.45 compatibility
5784
5878
  .TP
5785
5879
  .B \-n, \-\-name <name>
5786
- Logical name for the source (becomes the SQL table name)
5880
+ Logical name for the source (becomes the SQL table name). Required for every source except a spreadsheet, whose worksheets are each named source_<worksheet>
5787
5881
  .TP
5788
5882
  .B \-\-source\-id <uuid>
5789
5883
  Override the generated source id (local dataset only)
5790
5884
  .TP
5791
- .B \-\-format <csv|json|mysql|postgres|sqlserver>
5792
- Use this format instead of extension/type inference; file contents are not sniffed
5885
+ .B \-\-format <csv|json|xlsx|xls|ods|jdbc|mysql|postgres|sqlserver>
5886
+ Use this format instead of extension/type inference; file contents are not sniffed. A spreadsheet (xlsx/xls/ods) is added as one source per worksheet, each named source_<worksheet>
5793
5887
  .TP
5794
5888
  .B \-\-type <local|mysql|postgresql|sqlserver|jdbc>
5795
5889
  Source kind; local is inferred from \-\-file, jdbc from \-\-driver\-jar
5796
5890
  .TP
5797
5891
  .B \-\-file <path>
5798
- Path to a local CSV/JSON file (absolute or cwd\-relative)
5892
+ Path to a local CSV/JSON/spreadsheet file (absolute or cwd\-relative)
5799
5893
  .TP
5800
5894
  .B \-\-ref\-only
5801
5895
  Reference the file in place; do NOT copy into data_dir (local dataset)
@@ -5804,7 +5898,7 @@ Reference the file in place; do NOT copy into data_dir (local dataset)
5804
5898
  When copying, overwrite an existing file at the destination (local dataset)
5805
5899
  .TP
5806
5900
  .B \-\-upload
5807
- Cloud dataset only: upload \-\-file as a postmancloudfile source (runs via /exec). Without \-\-upload, \-\-file is registered as a local_filesystem csv/json source read by the local engine.
5901
+ Cloud dataset only: upload \-\-file as a postmancloudfile source (runs via /exec). Without \-\-upload, \-\-file is registered as a local_filesystem source read by the local engine. Either way a cloud dataset takes csv/json only — add a spreadsheet to a local .dataset.yaml, where each worksheet becomes its own source.
5808
5902
  .TP
5809
5903
  .B \-\-driver\-jar <path...>
5810
5904
  JDBC driver JAR(s). Repeatable, or pass several after one flag
@@ -5960,6 +6054,11 @@ Connection test:
5960
6054
  JSON output (\-\-json):
5961
6055
  Success: {"ok":true,"source":{"id","name","target","format","driver",
5962
6056
  "urlTemplate","connectionTest"},"warnings":[...]}
6057
+ Spreadsheet: also "sources":[{"id","name","worksheet","table"}] — one entry
6058
+ per worksheet, however many there are, with "source" set to the
6059
+ first. "table" is the identifier to query: the engine collapses
6060
+ "_" runs and drops leading and trailing "_", so it can differ
6061
+ from "name".
5963
6062
  Failure: {"ok":false,"error":{"code","message","remediation",...context}}
5964
6063
  Both go to stdout, so `\-\-json 2>/dev/null | jq .` parses either way.
5965
6064
  Error codes: DRIVER_FILE_NOT_FOUND, DRIVER_CLASS_NOT_FOUND,
@@ -5968,10 +6067,13 @@ JSON output (\-\-json):
5968
6067
  VAULT_REFERENCE_INVALID,
5969
6068
  VARS_FILE_UNREADABLE, VARS_FILE_INVALID, SOURCE_NOT_FOUND, SOURCE_NOT_JDBC,
5970
6069
  JAVA_NOT_FOUND, JAVA_UNSUPPORTED, DRIVER_LOAD_FAILED, CONNECTION_FAILED,
5971
- CONNECTION_TIMEOUT, SECRET_RESOLUTION_FAILED, INVALID_ARGUMENT
6070
+ CONNECTION_TIMEOUT, SECRET_RESOLUTION_FAILED, INVALID_ARGUMENT,
6071
+ SPREADSHEET_DESCRIBE_FAILED, SPREADSHEET_NO_WORKSHEETS,
6072
+ SPREADSHEET_UNIT_NOT_PINNED, SOURCE_ID_AMBIGUOUS,
6073
+ SPREADSHEET_CLOUD_UNSUPPORTED, WORKBOOK_FORMAT_UNSUPPORTED
5972
6074
  Warning codes: PLAINTEXT_SECRET, CONNECTION_NOT_TESTED, NO_VARIABLES,
5973
- EMPTY_VARIABLE_VALUE, NAME_NOT_SQL_SAFE, TRUST_SERVER_CERTIFICATE,
5974
- SSH_VALUES_IN_ARGV, SSH_HOST_KEY_UNVERIFIED
6075
+ EMPTY_VARIABLE_VALUE, NAME_NOT_SQL_SAFE, NAME_UNUSED_FOR_SPREADSHEET,
6076
+ TRUST_SERVER_CERTIFICATE, SSH_VALUES_IN_ARGV, SSH_HOST_KEY_UNVERIFIED
5975
6077
  LOCAL_VAULT_UNSUPPORTED, SOURCE_NAME_CONFLICT, SOURCE_ID_CONFLICT and
5976
6078
  DATASET_FILE_CHANGED are also possible; DATASET_COMMAND_FAILED is the
5977
6079
  fallback for anything unclassified.
@@ -6015,8 +6117,8 @@ Dataset the source belongs to — a local .dataset.yaml path or a cloud dataset
6015
6117
  .B \-n, \-\-name <name>
6016
6118
  Rename the source
6017
6119
  .TP
6018
- .B \-\-format <csv|json|mysql|postgres|sqlserver>
6019
- Change the format (local dataset only; cloud source formats are immutable)
6120
+ .B \-\-format <csv|json|jdbc|mysql|postgres|sqlserver>
6121
+ Change the format (local dataset only; cloud source formats are immutable). A spreadsheet format is not offered here: this command changes the format field alone and cannot pin a worksheet, so the source would not compile. Add the workbook with `dataset source add` instead, which makes one worksheet\-pinned source per sheet
6020
6122
  .TP
6021
6123
  .B \-\-file <path>
6022
6124
  Replace the source file (local dataset only; cloud file replacement is unsupported)
@@ -6321,7 +6423,7 @@ Postman API key (defaults to the `postman login` session)
6321
6423
 
6322
6424
  Examples:
6323
6425
  postman dataset view create \-d ./users.dataset.yaml \e
6324
- \-n "Active Users" \-q "SELECT * FROM source_users WHERE active = true"
6426
+ \-n "Active Users" \-q "SELECT * FROM users WHERE active = true"
6325
6427
  postman dataset view create \-d 14e30f6c\-1234\-1234\-1234\-cafef00dc0de \e
6326
6428
  \-n "Active Users" \-q "SELECT * FROM users WHERE active = true"
6327
6429
 
@@ -6389,7 +6491,7 @@ Postman API key (defaults to the `postman login` session)
6389
6491
 
6390
6492
  Examples:
6391
6493
  postman dataset view update "Active Users" \e
6392
- \-d ./users.dataset.yaml \-q "SELECT * FROM source_users"
6494
+ \-d ./users.dataset.yaml \-q "SELECT * FROM users"
6393
6495
  postman dataset view update "Active Users" \e
6394
6496
  \-d 14e30f6c\-1234\-1234\-1234\-cafef00dc0de \-q "SELECT * FROM users"
6395
6497
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "postman-cli",
3
- "version": "1.66.0",
3
+ "version": "1.68.0",
4
4
  "description": "Official Postman CLI - Command-line companion for API development, testing, and automation",
5
5
  "keywords": [
6
6
  "postman",
@@ -62,10 +62,10 @@
62
62
  "scripts/"
63
63
  ],
64
64
  "optionalDependencies": {
65
- "@postman/pm-bin-macos-arm64": "1.66.0",
66
- "@postman/pm-bin-macos-x64": "1.66.0",
67
- "@postman/pm-bin-linux-x64": "1.66.0",
68
- "@postman/pm-bin-linux-arm64": "1.66.0",
69
- "@postman/pm-bin-windows-x64": "1.66.0"
65
+ "@postman/pm-bin-macos-arm64": "1.68.0",
66
+ "@postman/pm-bin-macos-x64": "1.68.0",
67
+ "@postman/pm-bin-linux-x64": "1.68.0",
68
+ "@postman/pm-bin-linux-arm64": "1.68.0",
69
+ "@postman/pm-bin-windows-x64": "1.68.0"
70
70
  }
71
71
  }