postman-cli 1.38.1 → 1.39.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 +358 -4
  2. package/package.json +6 -6
package/man/postman.1 CHANGED
@@ -1,4 +1,4 @@
1
- .TH POSTMAN 1 "2026-05-29" "v1.38.1" "Postman CLI Manual"
1
+ .TH POSTMAN 1 "2026-06-11" "v1.39.0" "Postman CLI Manual"
2
2
  .SH NAME
3
3
  postman \- Command\-line companion utility for Postman
4
4
  .SH SYNOPSIS
@@ -66,6 +66,9 @@ Migrate a v2.1 collection to the v3 format
66
66
  .B collection lint
67
67
  Run linting on a local v3 collection at the given file or directory path.
68
68
  .TP
69
+ .B collection ai-readiness
70
+ Score a Postman collection for AI readiness by ID, local file path, or local\-mode directory.
71
+ .TP
69
72
  .B collection run
70
73
  Initiate a Postman collection run from a given ID or path.
71
74
 
@@ -94,6 +97,31 @@ Exit with failure if diagnostics at this level or above are present. [choices: "
94
97
  .B \-r, \-\-reporter <value>
95
98
  Output format: cli (human\-readable) or json. (default: cli)
96
99
 
100
+ .SS "collection ai\-readiness"
101
+ Score a Postman collection for AI readiness by ID, local file path, or local\-mode directory.
102
+
103
+ .B Usage:
104
+ <collectionId/Path> [options]
105
+
106
+ .B Options:
107
+ .TP
108
+ .B \-o, \-\-output <value>
109
+ Output format for the results. [choices: "cli", "json"]
110
+ .TP
111
+ .B \-\-min\-score <n>
112
+ Exit with a non\-zero code if the overall score is below this threshold (0\-100).
113
+
114
+ .TP Examples:
115
+
116
+ Examples:
117
+ $ postman collection ai\-readiness ./postman/collections/My\e API
118
+ $ postman collection ai\-readiness ./my\-collection.json
119
+ $ postman collection ai\-readiness 631643\-f695cab7\-... \-\-output json
120
+ $ postman collection ai\-readiness ./my\-collection.json \-\-min\-score 70
121
+
122
+ Resolving a collection by ID requires authentication. Use `postman login` before running this command with a UID.
123
+
124
+
97
125
  .SS "collection run"
98
126
  Initiate a Postman collection run from a given ID or path.
99
127
 
@@ -369,6 +397,10 @@ Lint and validate Specifications from the command line
369
397
  .B spec lint
370
398
  Run linting on the given specification by ID or local file path.
371
399
 
400
+ .TP
401
+ .B spec ai-readiness
402
+ Score an OpenAPI specification for AI readiness by ID or local file path.
403
+
372
404
 
373
405
  .SS "spec lint"
374
406
  Run linting on the given specification by ID or local file path.
@@ -391,6 +423,29 @@ The workspace ID to use for fetching governance rulesets.
391
423
  .B \-\-report\-events
392
424
  Report run events
393
425
 
426
+ .SS "spec ai\-readiness"
427
+ Score an OpenAPI specification for AI readiness by ID or local file path.
428
+
429
+
430
+ .B Usage:
431
+ <spec> [options]
432
+
433
+ .B Options:
434
+ .TP
435
+ .B \-o, \-\-output <value>
436
+ Output format for the results. [choices: "cli", "json"]
437
+ .TP
438
+ .B \-\-min\-score <n>
439
+ Exit with a non\-zero code if the overall score is below this threshold (0\-100).
440
+
441
+ .TP Examples:
442
+
443
+ Examples:
444
+ $ postman spec ai\-readiness ./openapi.yaml
445
+ $ postman spec ai\-readiness 6e2e5b3e\-... \-\-output json
446
+ $ postman spec ai\-readiness ./openapi.yaml \-\-min\-score 70
447
+
448
+
394
449
  .SS "monitor"
395
450
  Invoke a monitor run and display results
396
451
 
@@ -714,6 +769,9 @@ Show full output without truncating long values
714
769
  .B \-\-output <format>
715
770
  Save execution result to a file (supported: json)
716
771
  .TP
772
+ .B \-\-reporters <format>
773
+ Save a test results report to a file (supported: html)
774
+ .TP
717
775
  .B \-x, \-\-suppress\-exit\-code
718
776
  Specify whether or not to override the default exit code for the current run
719
777
  .TP
@@ -737,6 +795,7 @@ Example:
737
795
  postman flows run ./path/to/flow.json \-\-input\-file ./inputs.json
738
796
  postman flows run ./path/to/flow.json \-\-scenario production \-\-verbose
739
797
  postman flows run ./path/to/flow.json \-\-output json
798
+ postman flows run ./path/to/flow.json \-\-reporters html
740
799
  postman flows run ./path/to/flow.json \-\-workspace <workspaceId>
741
800
 
742
801
 
@@ -1642,7 +1701,7 @@ Overwrite the output directory if it exists and is not empty (used with \-\-capt
1642
1701
  Write analytics events to pm\-results/test\-events\-debug.ndjson instead of sending to Postman
1643
1702
  .TP
1644
1703
  .B \-\-report\-events
1645
- Send application test analytics to Postman
1704
+ Send application test run results and analytics to Postman
1646
1705
  .TP
1647
1706
  .B \-\-verbose
1648
1707
  Show detailed per\-request matching, sandbox errors, and debug information
@@ -1658,7 +1717,7 @@ or via \-\-target\-collection/\-\-target\-environment flags. CLI flags override
1658
1717
  Use \-\-capture\-only to skip tests and export captured traffic
1659
1718
  as a V3 Postman collection organised by host.
1660
1719
 
1661
- Analytics events are automatically sent when running in CI.
1720
+ Use \-\-report\-events to send run results to Postman. Analytics are also sent automatically when running in CI.
1662
1721
 
1663
1722
  Examples:
1664
1723
  postman application test \-\-command "npx playwright test"
@@ -1952,7 +2011,7 @@ Quick start:
1952
2011
  postman search requests "auth"
1953
2012
  postman search requests "auth" \-\-filter "method=POST AND visibility=public" \-\-ownership org \-\-limit 10 \-\-output json
1954
2013
 
1955
- Element types: requests, collections, workspaces, flows, specs
2014
+ Element types: requests, collections, workspaces, flows, specs, environments, mocks
1956
2015
 
1957
2016
  Detailed help is split by element type:
1958
2017
  postman search requests \-\-help Request filters and examples
@@ -1960,6 +2019,8 @@ Detailed help is split by element type:
1960
2019
  postman search workspaces \-\-help Workspace filters and examples
1961
2020
  postman search flows \-\-help Flow filters and examples
1962
2021
  postman search specs \-\-help API spec filters and examples
2022
+ postman search mocks \-\-help Mock filters and examples
2023
+ postman search environments \-\-help Environment filters and examples
1963
2024
 
1964
2025
  Pagination: \-\-limit accepts up to 25 results. Use \-\-cursor from the previous response to paginate.
1965
2026
 
@@ -1980,6 +2041,12 @@ Search for flows by name or keyword.
1980
2041
  .TP
1981
2042
  .B search specs
1982
2043
  Search for API specs by name or keyword.
2044
+ .TP
2045
+ .B search mocks
2046
+ Search for mocks by name or keyword.
2047
+ .TP
2048
+ .B search environments
2049
+ Search for environments by name or keyword.
1983
2050
 
1984
2051
  .SS "search requests"
1985
2052
  Search for requests by name or keyword.
@@ -2250,6 +2317,293 @@ Examples:
2250
2317
  postman search specs "payments" \-\-ownership external \-\-filter "publisherIsVerified=true AND visibility=public"
2251
2318
 
2252
2319
 
2320
+ .SS "search mocks"
2321
+ Search for mocks by name or keyword.
2322
+
2323
+ .B Usage:
2324
+ [options] [query]
2325
+
2326
+ .TP Examples:
2327
+
2328
+ Use \-\-cursor from the previous response to paginate.
2329
+ Ownership:
2330
+ organization, org Search resources owned by your organization
2331
+ external Search resources outside your organization
2332
+ all Search both organization and external resources
2333
+
2334
+ Output modes:
2335
+ default Card list including basic overview and web link per result
2336
+ json Detailed JSON response with search metadata
2337
+
2338
+ Filter syntax:
2339
+ Use = or != for single values: workspaceId=ws\-1
2340
+ Use IN or NIN for comma\-separated values: workspaceId IN ws\-1,ws\-2
2341
+ Combine filters with AND. Operators are case\-insensitive.
2342
+ Quote supported values that contain spaces or commas: <field>="value with spaces"
2343
+
2344
+ \-\-filter\-json format:
2345
+ {"$and":[{"workspaceId":{"$eq":"ws\-abc123"}}]}
2346
+ Only a top\-level $and array is supported; $or and nested groups are not supported.
2347
+ Each condition maps one field to one operator object ($eq, $ne, $in, $nin).
2348
+
2349
+ Shared filter fields:
2350
+ privateNetwork $eq, $ne (true/false)
2351
+ publisherIsVerified $eq, $ne (true/false)
2352
+ visibility $eq, $ne (internal, public, partner)
2353
+ workspaceId $eq, $ne, $in, $nin
2354
+ createdBy $eq, $ne, $in, $nin (user ID)
2355
+ organizationId $eq, $ne, $in, $nin (organization ID)
2356
+ teamId $eq, $ne, $in, $nin (team ID)
2357
+ isGitConnected $eq, $ne (true/false)
2358
+
2359
+ Mock filter fields:
2360
+ mockId $eq, $ne, $in, $nin
2361
+
2362
+ ID filters such as createdBy, organizationId, teamId, workspaceId, and collectionId expect IDs.
2363
+ Use \-\-output json on a broader search result to inspect available IDs.
2364
+
2365
+ Examples:
2366
+ postman search mocks "Auth service mock"
2367
+ postman search mocks "auth" \-\-filter "workspaceId=ws\-abc123"
2368
+ postman search mocks \-\-filter "mockId=mock\-abc123"
2369
+
2370
+
2371
+ .SS "search environments"
2372
+ Search for environments by name or keyword.
2373
+
2374
+ .B Usage:
2375
+ [options] [query]
2376
+
2377
+ .TP Examples:
2378
+
2379
+ Use \-\-cursor from the previous response to paginate.
2380
+ Ownership:
2381
+ organization, org Search resources owned by your organization
2382
+ external Search resources outside your organization
2383
+ all Search both organization and external resources
2384
+
2385
+ Output modes:
2386
+ default Card list including basic overview and web link per result
2387
+ json Detailed JSON response with search metadata
2388
+
2389
+ Filter syntax:
2390
+ Use = or != for single values: workspaceId=ws\-1
2391
+ Use IN or NIN for comma\-separated values: workspaceId IN ws\-1,ws\-2
2392
+ Combine filters with AND. Operators are case\-insensitive.
2393
+ Quote supported values that contain spaces or commas: <field>="value with spaces"
2394
+
2395
+ \-\-filter\-json format:
2396
+ {"$and":[{"workspaceId":{"$eq":"ws\-abc123"}}]}
2397
+ Only a top\-level $and array is supported; $or and nested groups are not supported.
2398
+ Each condition maps one field to one operator object ($eq, $ne, $in, $nin).
2399
+
2400
+ Shared filter fields:
2401
+ privateNetwork $eq, $ne (true/false)
2402
+ publisherIsVerified $eq, $ne (true/false)
2403
+ visibility $eq, $ne (internal, public, partner)
2404
+ workspaceId $eq, $ne, $in, $nin
2405
+ createdBy $eq, $ne, $in, $nin (user ID)
2406
+ organizationId $eq, $ne, $in, $nin (organization ID)
2407
+ teamId $eq, $ne, $in, $nin (team ID)
2408
+ isGitConnected $eq, $ne (true/false)
2409
+
2410
+ Environment filter fields:
2411
+ environmentId $eq, $ne, $in, $nin
2412
+
2413
+ ID filters such as createdBy, organizationId, teamId, workspaceId, and collectionId expect IDs.
2414
+ Use \-\-output json on a broader search result to inspect available IDs.
2415
+
2416
+ Examples:
2417
+ postman search environments "Beta Access control service"
2418
+ postman search environments "Payment service" \-\-filter "workspaceId=ws\-abc123"
2419
+ postman search environments \-\-filter "environmentId=env\-abc123"
2420
+
2421
+
2422
+ .SS "webhook"
2423
+ Create and manage Postman webhooks.
2424
+
2425
+ .B Usage:
2426
+ [options] [command]
2427
+
2428
+ .B Subcommands:
2429
+ .TP
2430
+ .B webhook create
2431
+ Create a new webhook and print its public URL.
2432
+ .TP
2433
+ .B webhook start
2434
+ Activate a webhook so it can receive requests.
2435
+ .TP
2436
+ .B webhook pause
2437
+ Pause a webhook so it no longer accepts requests.
2438
+ .TP
2439
+ .B webhook list
2440
+ List all webhooks in a workspace.
2441
+ .TP
2442
+ .B webhook delete
2443
+ Permanently delete a webhook.
2444
+ .TP
2445
+ .B webhook status
2446
+ Show details for a webhook.
2447
+ .TP
2448
+ .B webhook forward
2449
+ Forward incoming webhook requests to a local port.
2450
+
2451
+ .SS "webhook create"
2452
+ Create a new webhook and print its public URL.
2453
+
2454
+ .B Usage:
2455
+ [options]
2456
+
2457
+ .B Options:
2458
+ .TP
2459
+ .B \-t, \-\-title <title>
2460
+ Name for the webhook (default: CLI Webhook)
2461
+ .TP
2462
+ .B \-w, \-\-workspace <workspaceId>
2463
+ Postman workspace ID (falls back to .postman/resources.yaml or .postman/config.json)
2464
+ .TP
2465
+ .B \-\-api\-key <key>
2466
+ Postman API key
2467
+
2468
+ .TP Examples:
2469
+
2470
+ Examples:
2471
+ postman webhook create
2472
+ postman webhook create \-\-title "My Hook"
2473
+ postman webhook create \-\-workspace 00000000\-0000\-0000\-0000\-000000000000
2474
+
2475
+
2476
+
2477
+ .SS "webhook start"
2478
+ Activate a webhook so it can receive requests.
2479
+
2480
+ .B Usage:
2481
+ [options] <webhookIdOrUrl>
2482
+
2483
+ .B Options:
2484
+ .TP
2485
+ .B \-w, \-\-workspace <workspaceId>
2486
+ Postman workspace ID
2487
+ .TP
2488
+ .B \-\-api\-key <key>
2489
+ Postman API key
2490
+
2491
+ .TP Examples:
2492
+
2493
+ Examples:
2494
+ postman webhook start 0123456789abcdefghijklmno
2495
+ postman webhook start https://0123456789abcdefghijklmno.webhook.pstmn.io
2496
+
2497
+
2498
+
2499
+ .SS "webhook pause"
2500
+ Pause a webhook so it no longer accepts requests.
2501
+
2502
+ .B Usage:
2503
+ [options] <webhookIdOrUrl>
2504
+
2505
+ .B Options:
2506
+ .TP
2507
+ .B \-w, \-\-workspace <workspaceId>
2508
+ Postman workspace ID
2509
+ .TP
2510
+ .B \-\-api\-key <key>
2511
+ Postman API key
2512
+
2513
+ .TP Examples:
2514
+
2515
+ Examples:
2516
+ postman webhook pause 0123456789abcdefghijklmno
2517
+ postman webhook pause https://0123456789abcdefghijklmno.webhook.pstmn.io
2518
+
2519
+
2520
+
2521
+ .SS "webhook list"
2522
+ List all webhooks in a workspace.
2523
+
2524
+ .B Usage:
2525
+ [options]
2526
+
2527
+ .B Options:
2528
+ .TP
2529
+ .B \-w, \-\-workspace <workspaceId>
2530
+ Postman workspace ID (falls back to .postman/resources.yaml or .postman/config.json)
2531
+ .TP
2532
+ .B \-\-api\-key <key>
2533
+ Postman API key
2534
+
2535
+ .TP Examples:
2536
+
2537
+ Examples:
2538
+ postman webhook list
2539
+ postman webhook list \-\-workspace 00000000\-0000\-0000\-0000\-000000000000
2540
+
2541
+
2542
+
2543
+ .SS "webhook delete"
2544
+ Permanently delete a webhook.
2545
+
2546
+ .B Usage:
2547
+ [options] <webhookId>
2548
+
2549
+ .B Options:
2550
+ .TP
2551
+ .B \-w, \-\-workspace <workspaceId>
2552
+ Postman workspace ID
2553
+ .TP
2554
+ .B \-\-api\-key <key>
2555
+ Postman API key
2556
+
2557
+ .TP Examples:
2558
+
2559
+ Examples:
2560
+ postman webhook delete 0123456789abcdefghijklmno
2561
+
2562
+
2563
+
2564
+ .SS "webhook status"
2565
+ Show details for a webhook.
2566
+
2567
+ .B Usage:
2568
+ [options] <webhookId>
2569
+
2570
+ .B Options:
2571
+ .TP
2572
+ .B \-w, \-\-workspace <workspaceId>
2573
+ Postman workspace ID
2574
+ .TP
2575
+ .B \-\-api\-key <key>
2576
+ Postman API key
2577
+
2578
+ .TP Examples:
2579
+
2580
+ Examples:
2581
+ postman webhook status 0123456789abcdefghijklmno
2582
+
2583
+
2584
+
2585
+ .SS "webhook forward"
2586
+ Forward incoming webhook requests to a local port.
2587
+
2588
+ .B Usage:
2589
+ [options] <webhookIdOrUrl> <port>
2590
+
2591
+ .B Options:
2592
+ .TP
2593
+ .B \-w, \-\-workspace <workspaceId>
2594
+ Postman workspace ID
2595
+ .TP
2596
+ .B \-\-api\-key <key>
2597
+ Postman API key
2598
+
2599
+ .TP Examples:
2600
+
2601
+ Examples:
2602
+ postman webhook forward 00000000\-0000\-0000\-0000\-000000000000 8080
2603
+ postman webhook forward https://abc123.webhook.pstmn.io 8080
2604
+
2605
+
2606
+
2253
2607
  .SH SEE ALSO
2254
2608
  Full documentation: https://learning.postman.com/docs/postman\-cli/postman\-cli\-overview/
2255
2609
  .SH AUTHOR
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "postman-cli",
3
- "version": "1.38.1",
3
+ "version": "1.39.0",
4
4
  "description": "Official Postman CLI - Command-line companion for API development, testing, and automation",
5
5
  "keywords": [
6
6
  "postman",
@@ -58,10 +58,10 @@
58
58
  "man/"
59
59
  ],
60
60
  "optionalDependencies": {
61
- "@postman/pm-bin-macos-arm64": "1.38.1",
62
- "@postman/pm-bin-macos-x64": "1.38.1",
63
- "@postman/pm-bin-linux-x64": "1.38.1",
64
- "@postman/pm-bin-linux-arm64": "1.38.1",
65
- "@postman/pm-bin-windows-x64": "1.38.1"
61
+ "@postman/pm-bin-macos-arm64": "1.39.0",
62
+ "@postman/pm-bin-macos-x64": "1.39.0",
63
+ "@postman/pm-bin-linux-x64": "1.39.0",
64
+ "@postman/pm-bin-linux-arm64": "1.39.0",
65
+ "@postman/pm-bin-windows-x64": "1.39.0"
66
66
  }
67
67
  }