CLI Token

To record test runs or run the MCP server with the vrest-ng-cli utility, you need to generate a CLI token and use it in the relevant commands.

Generate CLI Token

To generate the CLI Token, simply follow the steps below:

1. Visit Configuration >> CLI Token from the left side menu bar in vREST NG Configuration page.
2. Click on Generate CLI Token button to generate the CLI Token.
3. That's it.

Use of CLI Token

You may use this generated CLI Token with the following vrest-ng-cli commands:

1. Recording test run results
   Use the token with the run command to store test run results in vREST NG Dashboard Service: vrest-ng-cli run --record="true" --token="<TOKEN>" ...
   For full run options and examples, see Executing Test Cases.

2. Running the MCP server
   Use the token with the mcp command to start the vREST MCP server for Cursor or other MCP clients: vrest-ng-cli mcp --token="<TOKEN>" [--port=<port>]
   For details and options, see MCP Server.

Remove CLI Token

To remove the CLI Token, simply follow the steps below:

1. Visit Configuration >> CLI Token from the left side menu bar on the vREST NG Configuration page.
2. Click on the Remove CLI Token button to remove the generated CLI Token.
3. Once the token is removed then it cannot be used by the vrest-ng-cli utility.