postman-cli 1.31.3 → 1.32.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 +278 -13
  2. package/package.json +6 -6
package/man/postman.1 CHANGED
@@ -1,4 +1,4 @@
1
- .TH POSTMAN 1 "2026-03-01" "v1.31.3" "Postman CLI Manual"
1
+ .TH POSTMAN 1 "2026-03-09" "v1.32.0" "Postman CLI Manual"
2
2
  .SH NAME
3
3
  postman \- Command\-line companion utility for Postman
4
4
  .SH SYNOPSIS
@@ -490,44 +490,309 @@ Examples:
490
490
 
491
491
 
492
492
  .SS "flows"
493
- Run Postman Flows from the command line.
493
+ Manage and interact with flows.
494
494
 
495
495
  .B Usage:
496
496
  [options] [command]
497
497
 
498
498
  .B Subcommands:
499
499
  .TP
500
+ .B flows list
501
+ List all flows
502
+ .TP
503
+ .B flows trigger
504
+ Trigger a deployed flow
505
+ .TP
506
+ .B flows deploy
507
+ Deploy a flow (required to trigger it)
508
+ .TP
500
509
  .B flows run
501
- Run a single flow by local path (e.g. ./path/to/flow.postman_flow.json)
510
+ Run a single flow from a file (e.g. ./path/to/flow.json)
511
+ .TP
512
+ .B flows update
513
+ Update settings for a deployed flow
514
+ .TP
515
+ .B flows list-runs
516
+ List run history for a deployed flow
517
+ .TP
518
+ .B flows get-run
519
+ Analyze a specific flow run
502
520
 
503
- .SS "flows run"
504
- Run a single flow by local path (e.g. ./path/to/flow.postman_flow.json)
521
+ .SS "flows list"
522
+ List all flows
505
523
 
506
524
  .B Usage:
507
- <path> [options]
525
+ [options]
508
526
 
509
527
  .B Options:
510
528
  .TP
511
- .B \-x, \-\-suppress\-exit\-code
512
- Specify whether or not to override the default exit code for the current run
529
+ .B \-w, \-\-workspace <workspaceId>
530
+ Specify the workspace ID to list flows from
531
+ .TP
532
+ .B \-p, \-\-paginate
533
+ Paginates the list of flows
534
+ .TP
535
+ .B \-f, \-\-filter <pattern>
536
+ Filter flows by name. Pattern may be a regex, or a name prefix.
537
+ .TP
538
+ .B \-s, \-\-sort <criteria>
539
+ Sort flows by criteria: "name" or "updated" (default: updated) (default: updated)
513
540
  .TP
514
541
  .B \-\-verbose
515
- Show detailed information of flow run and each request (method, URL, assertions)
542
+ Verbose output
543
+ .TP
544
+ .B \-\-debug
545
+ Debug output
546
+ .TP
547
+ .B \-\-json
548
+ JSON output
549
+
550
+ .TP Examples:
551
+
552
+ Examples:
553
+ postman flows list \-\-workspace 12345\-67890\-abcdef
554
+ postman flows list \-\-workspace 12345\-67890\-abcdef \-\-filter "My"
555
+ postman flows list \-\-workspace 12345\-67890\-abcdef \-\-filter "^Test.*" \-\-paginate
556
+ postman flows list \-\-workspace 12345\-67890\-abcdef \-\-sort name
557
+ postman flows list \-\-workspace 12345\-67890\-abcdef \-\-sort updated \-\-filter "API"
558
+
559
+
560
+
561
+ .SS "flows trigger"
562
+ Trigger a deployed flow
563
+
564
+ .B Usage:
565
+ <flowId> [options]
566
+
567
+ .B Options:
568
+ .TP
569
+ .B \-i, \-\-input <key=value>
570
+ Set key=value pairs in the trigger payload (e.g. \-\-input foo=bar \-\-input baz=qux) (default: )
571
+ .TP
572
+ .B \-f, \-\-input\-file <path.json>
573
+ Set payload values from JSON files (e.g. \-\-input\-file ./inputs.json \-\-input\-file ./config.json) (default: )
574
+ .TP
575
+ .B \-q, \-\-query <key=value>
576
+ Set query parameters as key=value pairs (e.g. \-\-query foo=bar \-\-query baz=qux) (default: )
577
+ .TP
578
+ .B \-\-headers <key=value>
579
+ Set custom headers as key=value pairs (e.g. \-\-headers X\-API\-Key=12345 \-\-headers User\-Agent=MyApp) (default: )
580
+ .TP
581
+ .B \-n, \-\-dry\-run
582
+ Show the flow requestURL and payload that would be sent without making the actual request (default: false)
583
+ .TP
584
+ .B \-\-show\-secrets
585
+ Show actual authentication tokens in dry\-run output (otherwise secrets are masked) (default: false)
586
+ .TP
587
+ .B \-r, \-\-result
588
+ Show only the response body (default: false)
589
+ .TP
590
+ .B \-\-verbose
591
+ Verbose output
592
+ .TP
593
+ .B \-\-debug
594
+ Debug output
595
+ .TP
596
+ .B \-\-json
597
+ JSON output
598
+
599
+ .TP Examples:
600
+
601
+ Examples:
602
+ postman flows trigger 12345\-67890\-abcdef
603
+ postman flows trigger 12345\-67890\-abcdef \-i name=John \-i age=30
604
+ postman flows trigger 12345\-67890\-abcdef \-\-input\-file ./inputs.json
605
+ postman flows trigger 12345\-67890\-abcdef \-f ./inputs.json \-i override=value
606
+ postman flows trigger 12345\-67890\-abcdef \-\-headers X\-API\-Key=12345 \-\-headers User\-Agent=MyApp
607
+ postman flows trigger 12345\-67890\-abcdef \-\-query version=v2 \-q debug=true
608
+ postman flows trigger 12345\-67890\-abcdef \-\-result
609
+ postman flows trigger 12345\-67890\-abcdef \-\-dry\-run
610
+ postman flows trigger 12345\-67890\-abcdef \-\-dry\-run \-\-show\-secrets
611
+
612
+
613
+
614
+ .SS "flows deploy"
615
+ Deploy a flow (required to trigger it)
616
+
617
+ .B Usage:
618
+ <flowId> [options]
619
+
620
+ .B Options:
621
+ .TP
622
+ .B \-p, \-\-path <path>
623
+ Specify the URL path for the trigger
624
+ .TP
625
+ .B \-t, \-\-timeout <timeout>
626
+ Specify the HTTP session timeout (5000ms to 60000ms) (default: 10000ms)
627
+ .TP
628
+ .B \-a, \-\-auth
629
+ Enable authentication for the trigger (default: false)
630
+ .TP
631
+ .B \-\-verbose
632
+ Verbose output
633
+ .TP
634
+ .B \-\-debug
635
+ Debug output
636
+ .TP
637
+ .B \-\-json
638
+ JSON output
639
+
640
+ .TP Examples:
641
+
642
+ Examples:
643
+ postman flows deploy 12345\-67890\-abcdef \-\-path /my\-trigger
644
+ postman flows deploy 12345\-67890\-abcdef \-\-path /my\-trigger \-\-auth
645
+ postman flows deploy 12345\-67890\-abcdef \-\-path /my\-trigger \-\-timeout 5000ms
646
+
647
+
648
+
649
+ .SS "flows run"
650
+ Run a single flow from a file (e.g. ./path/to/flow.json)
651
+
652
+ .B Usage:
653
+ <path> [options]
654
+
655
+ .B Options:
516
656
  .TP
517
- .B \-\-input <key=value>
657
+ .B \-i, \-\-input <key=value>
518
658
  Set flow inputs as key=value pairs (e.g. \-\-input foo=bar \-\-input baz=qux) (default: )
519
659
  .TP
520
- .B \-\-input\-file <path.json>
660
+ .B \-f, \-\-input\-file <path.json>
521
661
  Set flow inputs from JSON files (e.g. \-\-input\-file ./inputs.json \-\-input\-file ./config.json) (default: )
522
662
  .TP
523
- .B \-\-scenario <name>
663
+ .B \-s, \-\-scenario <name>
524
664
  Use a pre\-built scenario as flow inputs (by scenario name). Can be combined with \-\-input and \-\-input\-file to override values.
525
665
  .TP
526
666
  .B \-\-working\-dir <path>
527
667
  Specify the path to the working directory
668
+ .TP
669
+ .B \-\-verbose
670
+ Show detailed information of flow run and each request (method, URL, assertions)
671
+ .TP
672
+ .B \-x, \-\-suppress\-exit\-code
673
+ Specify whether or not to override the default exit code for the current run
674
+ .TP
675
+ .B \-\-verbose
676
+ Verbose output
677
+ .TP
678
+ .B \-\-debug
679
+ Debug output
680
+ .TP
681
+ .B \-\-json
682
+ JSON output
528
683
 
529
684
  .TP Examples:
530
- Eg. postman flows run ./path/to/flow.postman_flow.json
685
+
686
+ Example:
687
+ postman flows run ./path/to/flow.json
688
+ postman flows run ./path/to/flow.json \-i name=John \-i age=30
689
+ postman flows run ./path/to/flow.json \-\-input\-file ./inputs.json
690
+ postman flows run ./path/to/flow.json \-\-scenario production \-\-verbose
691
+
692
+
693
+
694
+ .SS "flows update"
695
+ Update settings for a deployed flow
696
+
697
+ .B Usage:
698
+ <flowId> [options]
699
+
700
+ .B Options:
701
+ .TP
702
+ .B \-t, \-\-trigger <on|off>
703
+ Enable or disable the flow trigger
704
+ .TP
705
+ .B \-a, \-\-auth <on|off>
706
+ Enable or disable authentication for the flow trigger
707
+ .TP
708
+ .B \-\-verbose
709
+ Verbose output
710
+ .TP
711
+ .B \-\-debug
712
+ Debug output
713
+ .TP
714
+ .B \-\-json
715
+ JSON output
716
+
717
+ .TP Examples:
718
+
719
+ Examples:
720
+ postman flows update 12345\-67890\-abcdef \-\-trigger on
721
+ postman flows update 12345\-67890\-abcdef \-\-trigger off
722
+ postman flows update 12345\-67890\-abcdef \-\-auth on
723
+ postman flows update 12345\-67890\-abcdef \-\-auth off
724
+
725
+
726
+
727
+ .SS "flows list\-runs"
728
+ List run history for a deployed flow
729
+
730
+ .B Usage:
731
+ [options]
732
+
733
+ .B Options:
734
+ .TP
735
+ .B \-w, \-\-workspace <workspaceId>
736
+ Specify the workspace ID
737
+ .TP
738
+ .B \-f, \-\-flow <flowId>
739
+ Filter sessions by flow ID
740
+ .TP
741
+ .B \-r, \-\-range <range>
742
+ Time range to list runs (e.g. 30m, 2h, 3d) (default: 1h)
743
+ .TP
744
+ .B \-\-verbose
745
+ Verbose output
746
+ .TP
747
+ .B \-\-debug
748
+ Debug output
749
+ .TP
750
+ .B \-\-json
751
+ JSON output
752
+
753
+ .TP Examples:
754
+
755
+ Examples:
756
+ postman flows list\-runs \-\-workspace 12345\-67890\-abcdef
757
+ postman flows list\-runs \-\-workspace 12345\-67890\-abcdef \-\-flow <flowId>
758
+ postman flows list\-runs \-\-workspace 12345\-67890\-abcdef \-\-range 30m
759
+ postman flows list\-runs \-\-workspace 12345\-67890\-abcdef \-\-range 3d
760
+
761
+
762
+
763
+ .SS "flows get\-run"
764
+ Analyze a specific flow run
765
+
766
+ .B Usage:
767
+ [options]
768
+
769
+ .B Options:
770
+ .TP
771
+ .B \-r, \-\-run\-id <runId>
772
+ Specify the run ID to analyze
773
+ .TP
774
+ .B \-l, \-\-logs
775
+ Show detailed event log (default: false)
776
+ .TP
777
+ .B \-\-filter <blockId>
778
+ Filter event log by block ID prefix (can be specified multiple times) (default: )
779
+ .TP
780
+ .B \-\-verbose
781
+ Verbose output
782
+ .TP
783
+ .B \-\-debug
784
+ Debug output
785
+ .TP
786
+ .B \-\-json
787
+ JSON output
788
+
789
+ .TP Examples:
790
+
791
+ Examples:
792
+ postman flows get\-run \-\-run\-id session\-abc123
793
+ postman flows get\-run \-\-run\-id session\-abc123 \-\-logs
794
+ postman flows get\-run \-\-run\-id session\-abc123 \-\-logs \-\-filter blockId1
795
+
531
796
 
532
797
 
533
798
  .SS "request"
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "postman-cli",
3
- "version": "1.31.3",
3
+ "version": "1.32.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.31.3",
62
- "@postman/pm-bin-macos-x64": "1.31.3",
63
- "@postman/pm-bin-linux-x64": "1.31.3",
64
- "@postman/pm-bin-linux-arm64": "1.31.3",
65
- "@postman/pm-bin-windows-x64": "1.31.3"
61
+ "@postman/pm-bin-macos-arm64": "1.32.0",
62
+ "@postman/pm-bin-macos-x64": "1.32.0",
63
+ "@postman/pm-bin-linux-x64": "1.32.0",
64
+ "@postman/pm-bin-linux-arm64": "1.32.0",
65
+ "@postman/pm-bin-windows-x64": "1.32.0"
66
66
  }
67
67
  }