Forrest logo
back to the newman tool

newman:tldr:1cb13

newman: Run a collection (from a file).
$ newman run ${path-to-collection-json}
try on your machine

This command newman run ${path-to-collection-json} is used to execute collections (JSON files) in Newman, which is a command-line interface (CLI) tool for running Postman collections.

Here's a breakdown of the command:

  • newman run: This is the command to start Newman and run a collection.
  • ${path-to-collection-json}: This is a placeholder for the actual path or location of your collection JSON file. You need to replace ${path-to-collection-json} with the specific file path.

For example, if your collection JSON file is located in the current directory, you can provide the relative path to the file. Assuming your collection file is named my-collection.json, the command would look like this:

newman run my-collection.json

If the file is located in a different directory, you need to provide the absolute or relative path to the file. For example, if the file is located in C:\MyFolder, the command would be:

newman run C:\MyFolder\my-collection.json

The command will run the specified collection file in Newman, executing the requests and generating the corresponding output as configured in the collection (e.g., test results, assertions, response data, etc.).

This explanation was created by an AI. In most cases those are correct. But please always be careful and never run a command you are not sure if it is safe.
back to the newman tool