npm - postman-cli - Versions diffs - 1.23.1 → 1.24.1 - Mend

postman-cli 1.23.1 → 1.24.1

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 (3) hide show

package/README.md CHANGED Viewed

@@ -64,7 +64,10 @@ This package automatically downloads the appropriate binary for your platform:
 - Windows (x64)
 > **Note:** Linux support excludes Alpine Linux distributions due to libc compatibility requirements.
-For Alpine environments, consider using alternative installation methods or running from a glibc-based base image.
+## Troubleshooting Installation
+The Postman CLI relies on platform-specific binaries distributed as optional dependencies. If you encounter "Binary not found" errors, ensure you're not using `--no-optional` or `--omit=optional` flags during installation, and verify that your `.npmrc` configuration doesn't contain `optional=false`. Installation failures may also occur due to network/registry access issues blocking `@postman/*` scoped packages or when using an unsupported platform architecture.
 ## Resources

package/man/postman.1 CHANGED Viewed

@@ -1,4 +1,4 @@
-.TH POSTMAN 1 "2025-11-05" "v1.23.1" "Postman CLI Manual"
+.TH POSTMAN 1 "2025-11-10" "v1.24.1" "Postman CLI Manual"
 .SH NAME
 postman \- Command\-line companion utility for Postman
 .SH SYNOPSIS
@@ -267,7 +267,7 @@ Eg. postman api publish <apiId> \-\-name v1\e
 .SS "runner"
-Run runners on your own environments for monitoring your APIs
+[BETA] Run runners on your own environments for monitoring your APIs
 .B Usage:
 [options] [command]
@@ -415,6 +415,291 @@ Skip the prepare step before pushing
 .B \-y, \-\-yes
 Skip all confirmation prompts
+.SS "request"
+Send HTTP requests from the command line with full Postman capabilities including authentication, environment variables, assertions, retries, and detailed output control.
+.B Usage:
+[METHOD] <URL> [options]
+.B Options:
+.TP
+.B \-H, \-\-header <header>
+Add HTTP header in key:value format. Can be used multiple times. Example: \-H "Content\-Type:application/json" \-H "X\-API\-Key:abc123" (default: )
+.TP
+.B \-d, \-\-body <body>
+Request body content. Supports: inline string, @filepath for file content, or "\-" for stdin. Example: \-\-body '{"name":"John"}' or \-\-body @data.json
+.TP
+.B \-f, \-\-form <field>
+Add multipart/form\-data field in key=value format. Can be used multiple times. For file uploads use key=@filepath. Example: \-f "name=John" \-f "avatar=@photo.jpg" (default: )
+.TP
+.B \-e, \-\-environment <path>
+Load Postman Environment by UUID or file path. Variables in URL, headers, and body will be resolved. Example: \-e dev.postman_environment.json
+.TP
+.B \-\-auth\-<type>\-<param> <value>
+[Optional] Supply authentication parameters dynamically.
+                                   Use \-\-auth\-<type>\-<param> where <type> is the auth method and <param> is the parameter.
+                                   Supported auth types: basic, bearer, digest, oauth1, oauth2, hawk, aws, ntlm, apikey
+                                   Examples:
+                                     Basic Auth: \-\-auth\-basic\-username user \-\-auth\-basic\-password pass
+                                     Bearer Token: \-\-auth\-bearer\-token mytoken123
+                                     API Key: \-\-auth\-apikey\-key "X\-API\-Key" \-\-auth\-apikey\-value "abc123" \-\-auth\-apikey\-in header
+                                     AWS: \-\-auth\-aws\-accessKey KEY \-\-auth\-aws\-secretKey SECRET \-\-auth\-aws\-service s3
+                                   Type: string, Default: null
+.TP
+.B \-\-timeout <n>
+Request timeout in milliseconds. Request will fail if no response within this time. (default: 300000)
+.TP
+.B \-\-redirects\-ignore
+Prevents Postman CLI from automatically following 3XX redirect responses. By default, redirects are followed.
+.TP
+.B \-\-redirects\-max <n>
+Maximum number of redirects to follow. Default is unlimited. Useful for preventing redirect loops.
+.TP
+.B \-\-redirects\-follow\-method
+Preserves the original HTTP method when following redirects. By default, redirects are followed with GET method.
+.TP
+.B \-\-redirects\-remove\-referrer
+Removes the Referer header when following redirects. By default, Referer header is sent with redirects.
+.TP
+.B \-\-retry <n>
+Number of retry attempts for failed requests (4xx, 5xx, network errors). Useful for flaky endpoints or rate\-limited APIs. (default: 0)
+.TP
+.B \-\-retry\-delay <ms>
+Delay between retry attempts in milliseconds. (default: 1000)
+.TP
+.B \-\-script\-pre\-request <script>
+Add JavaScript script to run before the request. Can be inline JS or @filepath to load from file. Scripts have access to pm.* APIs. Example: \-\-script\-pre\-request "pm.environment.set('timestamp', Date.now());" or \-\-script\-pre\-request @setup.js
+.TP
+.B \-\-script\-post\-request <script>
+Add JavaScript script to run after the request. Can be inline JS or @filepath to load from file. Scripts have access to pm.* APIs. Example: \-\-script\-post\-request "console.log(pm.response.json());" or \-\-script\-post\-request @validate.js
+.TP
+.B \-o, \-\-output <path>
+Save complete response to JSON file.Useful for debugging or further processing.
+.TP
+.B \-\-verbose
+Show detailed request and response information including headers, body, and metadata.
+.TP
+.B \-q, \-\-quiet
+Quiet mode: suppress all output except response body. Useful for piping to other commands.
+.TP
+.B \-\-debug
+Debug mode: show detailed execution information including retry attempts, redirects, and timing breakdowns.
+.TP Examples:
+Examples:
+  Basic Requests:
+    Simple GET request (method defaults to GET):
+      postman request https://api.example.com/users
+    GET request with explicit method:
+      postman request GET https://api.example.com/users
+    POST request with JSON body:
+      postman request POST https://api.example.com/users \e
+        \-\-body '{"name": "Alice", "email": "alice@example.com"}'
+    PUT request with body from file:
+      postman request PUT https://api.example.com/users/123 \-\-body @user\-data.json
+    DELETE request:
+      postman request DELETE https://api.example.com/users/123
+  Authentication:
+    Bearer token authentication:
+      postman request https://api.example.com/protected \e
+        \-\-auth\-bearer\-token eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
+    Basic authentication:
+      postman request https://api.example.com/protected \e
+        \-\-auth\-basic\-username myuser \e
+        \-\-auth\-basic\-password mypass
+    API Key in header:
+      postman request https://api.example.com/data \e
+        \-\-auth\-apikey\-key "X\-API\-Key" \e
+        \-\-auth\-apikey\-value "abc123xyz" \e
+        \-\-auth\-apikey\-in header
+    API Key in query parameter:
+      postman request https://api.example.com/data \e
+        \-\-auth\-apikey\-key "apikey" \e
+        \-\-auth\-apikey\-value "abc123xyz" \e
+        \-\-auth\-apikey\-in query
+    AWS Signature v4 authentication:
+      postman request https://s3.amazonaws.com/my\-bucket/object \e
+        \-\-auth\-aws\-accessKey AKIAIOSFODNN7EXAMPLE \e
+        \-\-auth\-aws\-secretKey wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY \e
+        \-\-auth\-aws\-service s3 \e
+        \-\-auth\-aws\-region us\-east\-1
+  Headers and Forms:
+    Add custom headers:
+      postman request https://api.example.com/data \e
+        \-H "Content\-Type:application/json" \e
+        \-H "X\-Custom\-Header:custom\-value" \e
+        \-H "Accept:application/json"
+    Multipart form data (file upload):
+      postman request POST https://api.example.com/upload \e
+        \-f "file=@document.pdf" \e
+        \-f "title=My Document" \e
+        \-f "description=Important file"
+    Form data with multiple files:
+      postman request POST https://api.example.com/gallery \e
+        \-f "photos=@image1.jpg" \e
+        \-f "photos=@image2.jpg" \e
+        \-f "album_name=Vacation 2025"
+  Environment Variables:
+    Use Postman environment file:
+      postman request https://api.example.com/{{endpoint}} \e
+        \-e production.postman_environment.json \e
+        \-H "Authorization:Bearer {{auth_token}}"
+    Environment with authentication:
+      postman request POST https://{{base_url}}/api/data \e
+        \-e dev.postman_environment.json \e
+        \-\-body '{"userId": "{{user_id}}", "data": "test"}'
+  Pre\-Request and Post\-Request Scripts:
+    Inline pre\-request script (set timestamp before request):
+      postman request https://api.example.com/data \e
+        \-\-script\-pre\-request "pm.environment.set('timestamp', Date.now());"
+    Inline post\-request script (log response):
+      postman request https://api.example.com/users \e
+        \-\-script\-post\-request "console.log('Response:', pm.response.json());"
+    Load pre\-request script from file:
+      postman request https://api.example.com/data \e
+        \-\-script\-pre\-request @setup.js
+    Load post\-request script from file:
+      postman request https://api.example.com/users \e
+        \-\-script\-post\-request @validate.js
+    Combine both pre\-request and post\-request scripts (inline):
+      postman request POST https://api.example.com/orders \e
+        \-\-body '{"product": "widget", "quantity": 5}' \e
+        \-\-script\-pre\-request "pm.environment.set('requestTime', new Date().toISOString());" \e
+        \-\-script\-post\-request "const order = pm.response.json(); console.log('Order created:', order.id);"
+    Combine both scripts (from files):
+      postman request POST https://api.example.com/process \e
+        \-\-body @data.json \e
+        \-\-script\-pre\-request @setup.js \e
+        \-\-script\-post\-request @teardown.js
+    Use scripts for dynamic authentication (inline):
+      postman request https://api.example.com/protected \e
+        \-\-script\-pre\-request "pm.request.headers.add({key: 'X\-Request\-ID', value: Date.now().toString()});" \e
+        \-\-script\-post\-request "console.log('Status:', pm.response.code);"
+    Advanced post\-request script with validation (from file):
+      postman request https://api.example.com/users/123 \e
+        \-\-script\-post\-request @validate\-user\-response.js
+    Example setup.js file content:
+      // Set dynamic timestamp
+      pm.environment.set('timestamp', Date.now());
+      // Add custom header
+      pm.request.headers.add({
+        key: 'X\-Request\-Time',
+        value: new Date().toISOString()
+      });
+    Example validate.js file content:
+      // Validate response structure
+      const response = pm.response.json();
+      if (!response.id) {
+        console.error('Response missing required id field');
+      }
+      console.log('Validation passed for:', response.id);
+  Retry Logic:
+    Retry failed requests up to 3 times:
+      postman request https://api.flaky\-service.com/data \e
+        \-\-retry 3 \e
+        \-\-retry\-delay 2000
+    Retry with debug output to see all attempts:
+      postman request https://api.example.com/data \e
+        \-\-retry 5 \e
+        \-\-retry\-delay 1000 \e
+        \-\-debug
+  Output Control:
+    Save complete response to JSON file (status, headers, body, timings):
+      postman request https://api.example.com/data \-\-output response.json
+    Download binary file using quiet mode and shell redirection:
+      postman request https://cdn.example.com/archive.zip \-\-quiet > archive.zip
+    Quiet mode \- only output response body (useful for piping):
+      postman request https://api.example.com/data \-\-quiet | jq '.results[]'
+    Verbose mode \- show all request/response details:
+      postman request https://api.example.com/data \-\-verbose
+    Debug mode \- show execution details, redirects, timing:
+      postman request https://api.example.com/data \-\-debug
+  Advanced Use Cases:
+    Complete CI/CD health check with validation:
+      postman request https://api.production.com/health \e
+        \-\-timeout 5000 \e
+        \-\-retry 3 \e
+        \-\-retry\-delay 1000 \e
+        \-\-script\-post\-request "pm.test('Health check status', function() { \e
+          const resp = pm.response.json(); \e
+          pm.expect(resp.status).to.equal('healthy'); \e
+        });" \e
+        \-\-quiet
+    Long\-running request with complete response capture:
+      postman request https://api.example.com/long\-process \e
+        \-\-output response.json \e
+        \-\-timeout 300000 \e
+        \-\-verbose
+    Chain requests using jq and environment variables:
+      TOKEN=$(postman request POST https://api.example.com/login \e
+        \-\-body '{"username":"admin","password":"pass"}' \e
+        \-\-quiet | jq \-r '.token')
+      postman request https://api.example.com/protected \e
+        \-\-auth\-bearer\-token "${TOKEN}" \e
+        \-\-script\-post\-request "console.log('Authorized access granted');"
+    Request with environment variables and post\-processing:
+      postman request POST https://{{base_url}}/api/users \e
+        \-e dev.postman_environment.json \e
+        \-\-body '{"name": "{{test_user}}", "role": "admin"}' \e
+        \-\-script\-post\-request "const user = pm.response.json(); console.log('Created user with ID:', user.id);"
+  Usage Notes:
+    \- Quick API testing without leaving the terminal
+    \- CI/CD pipelines with pre/post\-request scripts for dynamic setup and validation
+    \- Automated health checks and monitoring
+    \- Replacing curl/wget with Postman's powerful features
+    \- Testing APIs with complex authentication schemes
+    \- Integration with Postman Environments for multi\-environment testing
+    \- Use pre\-request scripts to set dynamic values, headers, or environment variables
+    \- Use post\-request scripts to process responses, log data, or validate results
+  Exit Codes:
+    0: Success (2xx\-3xx response, all tests passed)
+    N: Number of failed tests (e.g., exit code 3 means 3 tests failed)
+  Piping Output:
+    postman request https://api.example.com/users \-\-quiet | jq '.[] | .name'
 .SH SEE ALSO
 Full documentation: https://learning.postman.com/docs/postman\-cli/postman\-cli\-overview/
 .SH AUTHOR

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "postman-cli",
-  "version": "1.23.1",
+  "version": "1.24.1",
   "description": "Official Postman CLI - Command-line companion for API development, testing, and automation",
   "keywords": [
     "postman",
@@ -58,9 +58,9 @@
     "man/"
   ],
   "optionalDependencies": {
-    "@postman/pm-bin-macos-arm64": "1.23.1",
-    "@postman/pm-bin-macos-x64": "1.23.1",
-    "@postman/pm-bin-linux-x64": "1.23.1",
-    "@postman/pm-bin-windows-x64": "1.23.1"
+    "@postman/pm-bin-macos-arm64": "1.24.1",
+    "@postman/pm-bin-macos-x64": "1.24.1",
+    "@postman/pm-bin-linux-x64": "1.24.1",
+    "@postman/pm-bin-windows-x64": "1.24.1"
   }
 }