***

title: Run a performance test using the Postman CLI
updated: 2026-01-16T00:00:00.000Z
plan: beta
slug: docs/postman-cli/postman-cli-run-performance-test
max-toc-depth: 2
----------------

With performance tests, you can simulate user traffic and observe how your API behaves under load, identifying potential issues that affect performance. You can use the [Postman CLI](/docs/postman-cli/postman-cli-overview/) to trigger [performance tests](/docs/collections/performance-testing/testing-api-performance/) for specified collections, all within your CI/CD pipeline. Your team can use your tests to automatically catch performance issues during the deployment process. Depending on whether the performance test passes or fails, you can push or roll back your changes.

With the [`postman performance run` command](/docs/postman-cli/postman-cli-options/#run-performance-tests), you can configure a performance test for a collection. Add the command into your CI/CD script to [integrate performance tests into your workflow](#run-a-performance-test-within-your-cicd-pipeline). Postman recommends replacing your collection ID and API key with variables.

The Postman CLI triggers the performance test using the `postman performance run` command. The performance test runs against the specified collection according to your performance test configuration. Then the Postman CLI makes the test results available in the [performance test results](/docs/collections/performance-testing/performance-test-metrics/) in Postman.

<Note title="Note">
  Performance tests aren't supported with the [Postman web app](/docs/getting-started/installation/installation-and-updates/#use-the-postman-web-app).
</Note>

## Run a performance test within your CI/CD pipeline

1. Click <img alt="Collection icon" src="https://assets.postman.com/postman-docs/aether-icons/entity-collection-stroke.svg#icon" width="16px" role="img" /> **Collections** in the sidebar, then select a collection you'd like to run a performance test for.

2. Click <img alt="Run icon" src="https://assets.postman.com/postman-docs/aether-icons/action-run-stroke.svg#icon" width="16px" role="img" /> **Run**.

3. Click the **Performance** tab.

4. [Configure the performance test](/docs/collections/performance-testing/performance-test-configuration/) for your collection. Your configuration settings are reflected in the `performance` command that you can copy from the Postman app.

5. Under **Run**, select **via the CLI**.

6. Under **Install Postman CLI**, click <img alt="Copy icon" src="https://assets.postman.com/postman-docs/aether-icons/action-copy-stroke.svg#icon" width="16px" role="img" /> **Copy to clipboard** to copy the Postman CLI installation command.

7. Under **Run the performance test**, click **Add API key**. Do one of the following:

   * Click **Generate Key** to create a new API key. Enter a name for the API key and click **Generate**. Click <img alt="Copy icon" src="https://assets.postman.com/postman-docs/aether-icons/action-copy-stroke.svg#icon" width="16px" /> **Copy** to copy the key and save it somewhere safe.
   * Click **Use Existing Key** and enter a valid API key.

8. Click **Insert Key**.

9. Click <img alt="Copy icon" src="https://assets.postman.com/postman-docs/aether-icons/action-copy-stroke.svg#icon" width="16px" /> **Copy to clipboard** to copy the `login` and `performance` commands.

10. Paste the Postman CLI installation, `login`, and `performance` commands into your CI/CD script. This process depends on your CI tool.

The following example shows how to use the [Postman CLI GitHub Action](/docs/postman-cli/postman-cli-github-actions/) to run a performance test:

```yaml
name: API Testing

on: push

jobs:
  performance:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Run performance test
        uses: postmanlabs/postman-cli-action@v1
        with:
          command: 'performance run ${{ vars.COLLECTION_ID }}'
          api-key: ${{ secrets.POSTMAN_API_KEY }}
```