Thunder Client

https://docs.thunderclient.com/
Admin
Thunder Client is a lightweight REST API Client Extension for Visual Studio Code, focusing on...
Tokens:45,363
Snippets:531
Trust Score:9.1
Update:5 days ago
Show doc for...
Tokens:
Raw
### Install Thunder Client CLI globally with npm

Source: https://docs.thunderclient.com/cli/install

Install the CLI globally using npm. Requires Node.js 18 or higher and a Thunder Client subscription.

```bash
npm i -g @thunderclient/cli
```

--------------------------------

### Execute command with tc.exec

Source: https://docs.thunderclient.com/scripting/api

Executes a system command and returns the result. The example runs 'node --version'.

```javascript
await tc.exec("node --version");
```

--------------------------------

### Get npm global bin folder

Source: https://docs.thunderclient.com/cli/jetbrains

Run npm config get prefix to print the global node_modules bin folder, which can help locate the tc executable.

```bash
# prints the global node_modules bin folder
npm config get prefix
```

--------------------------------

### Get Environment Variables with tc.getVar

Source: https://docs.thunderclient.com/scripting/variables

Retrieves environment variables by name using tc.getVar. The example fetches 'API_KEY' and 'token'.

```javascript
let apiKey = tc.getVar("API_KEY");
let token = tc.getVar("token");
```

--------------------------------

### Using built-in libraries (e.g., axios)

Source: https://docs.thunderclient.com/scripting/api

Shows how to import a built-in library using require(). This example uses axios, but the same pattern applies to other libraries listed in the built-in libraries table.

```javascript
// e.g: to use axios library
const axios = require('axios');
```

--------------------------------

### Example JSON data file (data.json)

Source: https://docs.thunderclient.com/features/collection-runner

JSON array with three objects, each containing username, email, and password keys. Keys become variable names in the request body.

```json
[
  { "username": "alice", "email": "alice@example.com", "password": "Pass@123" },
  { "username": "bob", "email": "bob@example.com", "password": "Pass@456" },
  { "username": "carol", "email": "carol@example.com", "password": "Pass@789" }
]
```

--------------------------------

### GitHub Actions workflow for Thunder Client CLI

Source: https://docs.thunderclient.com/cli/ci-cd

Sample YAML workflow for GitHub Actions or other build pipelines. It checks out the repository, installs Node 20, installs the Thunder Client CLI globally, creates a thunder-reports directory, runs the collection with the command `tc --col "ColNameOrId" --report cli,json,xml,html --log 8`, and uploads the reports as artifacts even on failure.

```yaml
# This is a basic workflow to help you get started with Actions
 
name: TestBuild
 
# Controls when the workflow will run
on: 
  # Triggers the workflow on push or pull request events but only for the "master" branch
  # push:
  #  branches: [ "main" ]
  # pull_request:
  #  branches: [ "main" ]
 
  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:
 
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  # This workflow contains a single job called "build"
  build:
    # The type of runner that the job will run on
    runs-on: ubuntu-latest
 
    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
      - uses: actions/checkout@v4
      
      # Install Node on the runner
      - name: Install Node
        uses: actions/setup-node@v4
        with:
          node-version: 20
 
      # Install Thunder Client CLI
      - name: Install Thunder Client CLI
        run: |
          npm install -g @thunderclient/cli
          
      - name: Make Directory for results
        run: mkdir -p thunder-reports
 
      # Run the Thunder Client collection
      - name: Run Thunder Client collection
        run: |
          tc --col "ColNameOrId" --report cli,json,xml,html --log 8
 
      # Upload the contents of the test results directory to workspace
      - name: Output the run Details
        if: ${{ always() }}
        uses: actions/upload-artifact@v4
        with:
          name: RunReports
          path: thunder-reports

```

--------------------------------

### Example CSV data file (data.csv)

Source: https://docs.thunderclient.com/features/collection-runner

CSV file with headers username, email, password and three rows of test data. Column headers become variable names in the request body.

```csv
username,email,password
alice,alice@example.com,Pass@123
bob,bob@example.com,Pass@456
carol,carol@example.com,Pass@789
```

--------------------------------

### Create JS file with module.exports

Source: https://docs.thunderclient.com/scripting/import-files

Create a new JS file in the workspace and export functions using module.exports. The example defines a helloWorld function that returns a string.

```javascript
// test-import.js file
function helloWorld(){
   return "hello world";
}
 
module.exports = {
  helloWorld
}
```

--------------------------------

### tc.loadModule(moduleName: string, version?: string): Promise<any>

Source: https://docs.thunderclient.com/scripting/api

Loads and gets a node module from the npm registry.

```APIDOC
## tc.loadModule(moduleName: string, version?: string): Promise<any>

### Description
Loads and gets a node module from the npm registry.

### Method
Function call

### Signature
`tc.loadModule(moduleName: string, version?: string): Promise<any>`

### Parameters
- **moduleName** (string) - Required - The module name.
- **version** (string) - Optional - The module version; if empty, the latest version will be used.

### Returns
- **Promise<any>** - A promise that resolves to the loaded module.
```

--------------------------------

### Find global tc path with where (Windows)

Source: https://docs.thunderclient.com/cli/jetbrains

Use the where command on Windows to locate the tc executable. Example output: C:\Users\username\AppData\Roaming\npm\tc.

```bash
where tc
```

--------------------------------

### Load Node Module with tc.loadModule

Source: https://docs.thunderclient.com/scripting/libraries

Loads an external Node module from the npm registry. The module is automatically downloaded and installed. Supports specifying a version. The example loads 'moment' and sets a variable with the current date.

```javascript
console.log("load node module");
 
var moment = await tc.loadModule("moment");
 
// use moment specific version
var moment = await tc.loadModule("moment", "2.30.0");
 
console.log(moment().format());
tc.setVar("date", moment().format());
```

--------------------------------

### .env file format example

Source: https://docs.thunderclient.com/features/environments

Shows the key=value format required for variables in a .env file linked to an environment. Use this format when creating a .env file to store variables accessible via {{variable}} in requests.

```plaintext
key=value
name=thunder
number=25543
```

--------------------------------

### Environment to collection mapping example

Source: https://docs.thunderclient.com/features/environments

Illustrates attaching environments to collections, where each collection is linked to a specific environment. This mapping is used when you want to link multiple collections to multiple environments.

```plaintext
CollectionA -> EnvA
CollectionB -> EnvB
CollectionC -> EnvC
```

--------------------------------

### Pre-Request Filter Example (custom-filters.js)

Source: https://docs.thunderclient.com/scripting/custom-filters

Example of a custom filter for the Pre-Run tab. It sets an environment variable using tc.setVar and returns no value.

```javascript
function preFilter1() {
 
    console.log("set env variable example");
    let uuid = uuid4();
 
    // ---- save to active environment
    tc.setVar("uuidFromScript", uuid);
 
    // ---- save to local environment
    // tc.setVar("uuidFromScript", uuid, "local");
 
    // ---- save to global environment
    // tc.setVar("uuidFromScript", uuid, "global");
}
 
module.exports = [preFilter1];
```

--------------------------------

### Execute CLI command with tc.exec

Source: https://docs.thunderclient.com/scripting/functions

Use `tc.exec` to run a CLI command and get its response. The example shows checking the Node.js version with `node -v`.

```javascript
var result = await tc.exec("command");
 
// example
var result = await tc.exec("node -v");
```

--------------------------------

### URL Query Parameters

Source: https://docs.thunderclient.com/scripting/postman

Shows how to get and set URL query parameters in Thunder Client scripts, compared to Postman.

```APIDOC
## URL Query Parameters

### Description
Demonstrates how to get and set URL query parameters in Thunder Client scripts.

### Thunder Client Script
```javascript
// Get a query param value
const userId = tc.request.url.getParam("userId");

// Add or update a query param
tc.request.url.setParam("debug", "true");
```

### Postman Equivalent
```javascript
// Get a query param value
const userId = pm.request.url.getQueryParam("userId");

// Add or update a query param
pm.request.url.addQueryParams({
    debug: "true",
});
```
```

--------------------------------

### Find global tc path with which (macOS/Linux)

Source: https://docs.thunderclient.com/cli/jetbrains

Use the which command on macOS or Linux to locate the tc executable. Example output: /usr/local/bin/tc.

```bash
which tc
```

--------------------------------

### Plain Text Environment File (tc_env_staging.json)

Source: https://docs.thunderclient.com/features/environments/encrypted-envs

Example of an environment file with a variable stored in plain text format, as used in Free, Starter & Business plans. The 'secret' field is set to true but the value is not encrypted.

```json
{
   "name": "color",
   "value": "red",
   "secret": true,
}
```

--------------------------------

### Clipboard example with button and error handling

Source: https://docs.thunderclient.com/testing/chart-view

Creates a button that copies text to the clipboard using parent.postMessage(). Includes error handling and displays a success or failure message. The HTML is passed to tc.chartHTML(html).

```javascript
var html = `
<div id="container"></div>
 
<script>
// get the container element
let container = document.getElementById("container");
 
// Create a new button element
var button = document.createElement('button');
button.innerHTML = 'Copy to clipboard';
 
// Add an event listener for the click event
button.addEventListener('click', function() {
    // Use the Clipboard API to write text
    try{
 
      parent.postMessage({command:'copy-text', "text": "textdata"}); 
 
      // Create a new paragraph element
      var p = document.createElement('p');
      p.innerHTML = 'Text copied to clipboard';
 
      // Append the paragraph to the body of the document
      document.body.appendChild(p);
  } catch(error) {
 
      // Create a new paragraph element
      var p = document.createElement('p');
      p.innerHTML = 'Failed to copy text' + error;
 
      // Append the paragraph to the body of the document
      document.body.appendChild(p);
  }
});
 
// Append the button to the body of the container
container.appendChild(button);
</script>
`
 
tc.chartHTML(html);
```

--------------------------------

### Configure SSL certificates via thunder-client.certificates setting

Source: https://docs.thunderclient.com/features/auth

Example of the VS Code setting 'thunder-client.certificates' for providing SSL certificate paths. Supports relative or absolute paths, and optional passphrase. The 'pfxPath' can be used alone or with 'certPath' and 'keyPath'.

```json
"thunder-client.certificates": [
        {
            "host": "thunderclient.io",
            "certPath": "ssl/cert.pem",
            "keyPath": "ssl/keyfile.key",
            "pfxPath": "ssl/pfx.p12",
            "passphrase": "test"
        },
        {
            "host": "localhost:8081",
            "pfxPath": "/Users/test/Documents/ssl/pfx.p12",
            "passphrase": "test"
        },
        {
            "host": "testing.com",
            "certPath": "ssl/cert.pem",
            "keyPath": "ssl/keyfile.key"
        },
    ]
```

--------------------------------

### Sample JSON Schema (schema_file.json)

Source: https://docs.thunderclient.com/testing/schema

A JSON schema example that validates an object with properties like fraction, balance, bignumber, and isNumber. It requires all four properties and disallows additional properties.

```json
{
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "fraction": {
            "type": "number"
        },
        "balance": {
            "type": "number"
        },
        "bignumber": {
            "type": "integer"
        },
        "isNumber": {
            "type": "null"
        }
    },
    "required": [
        "balance",
        "bignumber",
        "fraction",
        "isNumber"
    ],
    "title": "Welcome4"
}
```

--------------------------------

### Assertions using Chai library

Source: https://docs.thunderclient.com/scripting/assertions

Use Chai's expect and assert styles to write assertions. The example checks that the response status equals 200 using both expect(...).to.equal(200) and assert.equal(...).

```javascript
tc.test("Response code expect to be 200", function () {
     expect(tc.response.status).to.equal(200);
 })

 tc.test("Response code is 200", function () {
     assert.equal(tc.response.status, 200)
 })
```

--------------------------------

### Create Cookies from scripting using tc.setCookie

Source: https://docs.thunderclient.com/features/cookies

Sets a cookie for a given URL. The first example sets a cookie for a specific URL, the second uses tc.request.url to set it for the current request URL.

```javascript
// set cookie for current url
await tc.setCookie("https://www.thunderclient.com", "cookieName", "cookieValue");
await tc.setCookie(tc.request.url, "cookieName", "cookieValue");
```

--------------------------------

### tc.info

Source: https://docs.thunderclient.com/scripting/api

Gets the request info model containing environment, request, collection, folder names, and iteration details. Available since version 2.15.0.

```APIDOC
## tc.info

### Description
Gets the request info model containing environment, request, collection, folder names, and iteration details.

### Property
info

### Type
InfoModel

### Fields
- **environmentName** (string) - Environment name.
- **requestName** (string) - Request name.
- **collectionName** (string) - Collection name.
- **folderName** (string) - Folder name.
- **currentIteration** (number) - Current iteration number.
- **totalIterations** (number) - Total iterations.

### Since
2.15.0
```

--------------------------------

### axios.get

Source: https://docs.thunderclient.com/scripting/send-request

Sends a custom HTTP GET request using the Axios library. Useful for executing custom requests programmatically from scripts.

```APIDOC
## axios.get

### Description
Sends a custom HTTP GET request using the Axios library. Useful for executing custom requests programmatically from scripts.

### Method
`axios.get`

### Parameters
- **url** (string) - Required - The URL to send the GET request to.

### Request Example
```javascript
const axios = require('axios');
const response = await axios.get("https://www.thunderclient.com/welcome");
console.log(response);
```

### Response
Returns the response object from the HTTP request.
```

--------------------------------

### Create Custom Filters File (custom-filters.js)

Source: https://docs.thunderclient.com/scripting/custom-filters

Example of a custom filters JavaScript file that exports functions using module.exports. It demonstrates reading a file, executing a command, and computing an HMAC using CryptoJS.

```javascript
const CryptoJS = require("crypto-js");
const { v4: uuid4 } = require("uuid");
 
async function appendString(input, param1) {
 
     // read a file
    var data = await tc.readFile(input);
    
    // execute a command
    var result = await tc.exec("echo testing");
    
    return `${input} ${data} ${result}`;
}
 
function customHmac(input) {
    console.log("running custom hmac");
    var secretValue = tc.getVar("secret");
 
    let encoded = CryptoJS.HmacSHA256(input, secretValue);
    return encoded.toString(CryptoJS.enc.Base64);
}
 
module.exports = [customHmac, appendString];
```

--------------------------------

### Control output with --log argument

Source: https://docs.thunderclient.com/cli/run-requests

The --log argument controls which data is displayed. Log options: 0=All Data, 1=ReqHeaders, 2=ReqBody, 6=ResHeaders, 7=ResBody, 8=Tests. The example shows displaying request headers, request body, and response body.

```bash
tc 'welcome' --log 1,2,7
```

--------------------------------

### Setting request-scoped variables via scripting

Source: https://docs.thunderclient.com/features/environments

Example of setting collection- and request-specific environment variables using the 'request' scope in the Pre Run scripting tab. These variables are available only during the execution of the request.

```javascript
tc.setVar("name", "Thunder Client", "request");
tc.setVar("baseUrl", "http://localhost:8744", "request");
```

--------------------------------

### Load Node Modules and Generate Fake Data in Pre-Request Script

Source: https://docs.thunderclient.com/features/system-variables

Example custom script for the Pre Run tab's Scripting tab. It loads faker-js, chance, and falso modules using tc.loadModule and sets variables with tc.setVar. This feature is available only in the paid version.

```javascript
    // example code to load faker-js module
    var { faker } = await tc.loadModule("@faker-js/faker");
    tc.setVar("firstName", faker.person.firstName());
 
    // example code to load chance module
    var Chance = await tc.loadModule("chance");
    var chance = new Chance();
    tc.setVar("firstName", chance.name());
 
    // example code to load falso module
    var falso = await tc.loadModule("@ngneat/falso");
    var user = falso.randUser();
    tc.setVar("firstName", user.firstName);
```

--------------------------------

### Get absolute path with tc.getAbsolutePath

Source: https://docs.thunderclient.com/scripting/api

Converts a relative path to an absolute path. The example then appends data to the file using fs.appendFileSync.

```javascript
// To get Absolute path of the file from relative path
var fullPath = tc.getAbsolutePath("testing.json");
 
var dataString = "124";
 
// To save to a file using full path
fs.appendFileSync(fullPath, dataString)
```

--------------------------------

### Open request in UI with --ui flag

Source: https://docs.thunderclient.com/cli/run-requests

Opens a request in the extension UI and runs it automatically.

```bash
tc 'welcome' --ui
```

--------------------------------

### tc.response

Source: https://docs.thunderclient.com/scripting/api

Gets the response object (read-only).

```APIDOC
## tc.response

### Description
Gets the response object (read-only).

### Property
response

### Type
ResponseModel

### Fields
- **status** (number) - HTTP status code.
- **time** (number) - Response time.
- **size** (number) - Response size.
- **contentType** (string) - Content type.
- **headers** (KeyValue[]) - Response headers.
- **cookies** (KeyValue[]) - Response cookies.
- **json** (any) - Parsed JSON response.
- **text** (string) - Response text.

### Methods
- **getHeader(name: string): string | undefined** - Gets a header value by name.
- **getBinary(): Buffer | undefined** - Gets the response body as a Buffer.
```

--------------------------------

### prop

Source: https://docs.thunderclient.com/scripting/filters

Gets the property value of an object.

```APIDOC
## prop

### Description
Gets the property value of an object.

### Syntax
`{{object | prop(property)}}`

### Parameters
- **property** (string) - Required - The property name to get.
```

--------------------------------

### tc.request

Source: https://docs.thunderclient.com/scripting/api

Gets the request object. Only headers can be modified.

```APIDOC
## tc.request

### Description
Gets the request object. Only headers can be modified.

### Property
request

### Type
RequestModel

### Fields
- **id** (string) - Request ID.
- **name** (string) - Request name.
- **url** (UrlModel) - Request URL.
- **method** (string) - HTTP method.
- **headers** (KeyValue[]) - Request headers.
- **body** (RequestBody | undefined) - Request body.
- **auth** (Authentication | undefined) - Authentication object.

### Methods
- **getHeader(name: string): string | undefined** - Gets a header value by name.
- **setHeader(name: string, value: string): void** - Sets a header value.
- **setBody(body: string | object | GraphqlBody | undefined, type?: BodyType): void** - Sets the request body.
```

--------------------------------

### Azure CLI: Switch subscription

Source: https://docs.thunderclient.com/features/environments/secret-managers

Use this command to switch to a different Azure subscription later.

```bash
az account set --subscription "<subscription-name-or-id>"
```

--------------------------------

### Open Run Collection UI

Source: https://docs.thunderclient.com/cli/run-collection

Opens the Run Collection UI from the CLI, with --ui to run automatically and --ui2 to open without auto-running.

```bash
tc --col 'User' --ui
```

```bash
tc --col 'User' --ui2
```

--------------------------------

### tc.getAbsolutePath

Source: https://docs.thunderclient.com/scripting/api

Gets the absolute path of a file from a relative path.

```APIDOC
## tc.getAbsolutePath

### Description
Get the absolute path of the file.

### Method
`tc.getAbsolutePath(relativePath: string): string`

### Parameters
- **relativePath** (string) - Required - The relative path to the file. (Right-click on the file in VS Code and select **Copy Relative Path**)

### Sample Usage
```javascript
// To get Absolute path of the file from relative path
var fullPath = tc.getAbsolutePath("testing.json");

var dataString = "124";

// To save to a file using full path
fs.appendFileSync(fullPath, dataString)
```
```

--------------------------------

### prop

Source: https://docs.thunderclient.com/scripting/filters

Gets a property value from an object or array of objects.

```APIDOC
## prop

### Description
Gets a property value from an object or array of objects.

### Syntax
`json.items | prop("id")`

### Parameters
- **property** (string) - Required - The property name to extract.

### Examples
- If `json.items` value is `[{"id":1005, "name":"boston"}]`, then `prop("id")` returns `1005`.
- If the array is `[{"id":1005, "name":"boston"}, {"id":1006, "name":"london"}]`, then `prop("id")` returns `1005,1006`.
```

--------------------------------

### tc.request.url.getParam

Source: https://docs.thunderclient.com/scripting/api

Gets the value of a specific URL parameter from the request URL. This method is part of the tc.request.url object.

```APIDOC
## tc.request.url.getParam

### Description
Gets the value of a specific URL parameter from the request URL.

### Method
Function

### Signature
`tc.request.url.getParam()`

### Parameters
- (none explicitly documented)

### Returns
- (not explicitly documented)

### Example
```javascript
const paramValue = tc.request.url.getParam();
```
```

--------------------------------

### prop filter syntax

Source: https://docs.thunderclient.com/scripting/filters

Gets a property value from an object or array of objects. Used in the Tests tab.

```plaintext
json.items | prop("id")
```

--------------------------------

### Run with Environment

Source: https://docs.thunderclient.com/cli/run-collection

Runs a collection using a specified environment instead of the active one.

```bash
tc --col 'colNameOrId' --env 'Staging'
```

--------------------------------

### tc.request.getHeader

Source: https://docs.thunderclient.com/scripting/api

Gets the value of a specific header from the request. This method is part of the tc.request object and can be used to read request headers in scripting.

```APIDOC
## tc.request.getHeader

### Description
Gets the value of a specific header from the request.

### Method
Function

### Signature
`tc.request.getHeader(name: string): string | undefined`

### Parameters
- **name** (string) - Required - The name of the header to retrieve.

### Returns
- **string | undefined** - The value of the header, or undefined if not found.

### Example
```javascript
const contentType = tc.request.getHeader('Content-Type');
```
```

--------------------------------

### Run Multiple Folders

Source: https://docs.thunderclient.com/cli/run-collection

Runs requests in multiple folders by providing comma-separated names or IDs.

```bash
tc --fol 'folNameOrId1,folNameOrId2'
```

--------------------------------

### Configure AWS SSO profile

Source: https://docs.thunderclient.com/features/environments/secret-managers

Run these commands to set up an IAM Identity Center (SSO) named profile and sign in. The second command opens a browser; on a machine without a browser, add --use-device-code.

```bash
aws configure sso
aws sso login --profile <profile-name>
```

--------------------------------

### Azure CLI: Non-interactive login with service principal and certificate

Source: https://docs.thunderclient.com/features/environments/secret-managers

Use a service principal with a certificate. The PEM file must contain both the private key and the certificate.

```bash
az login --service-principal -u <app-id> --certificate /path/to/cert.pem --tenant <tenant-id>
```

--------------------------------

### Get environment variable value with tc.getVar

Source: https://docs.thunderclient.com/scripting/api

Retrieves the value of an environment variable. The returned value is a string; use parseInt to convert numeric strings.

```javascript
var name = tc.getVar("locationName");
 
var numberString = tc.getVar("incrementNumber");
 
var number = parseInt(numberString);
```

--------------------------------

### Azure CLI: Sign in to Azure

Source: https://docs.thunderclient.com/features/environments/secret-managers

Sign in to your Azure account. If you have access to more than one subscription, you will be prompted to select one; choose the subscription containing the Key Vault.

```bash
az login
```

--------------------------------

### Delay script execution with tc.delay

Source: https://docs.thunderclient.com/scripting/functions

Use `tc.delay` to pause script execution for a specified number of milliseconds. The example delays for 5 seconds and then logs a message.

```javascript
// delay for 5 seconds
await tc.delay(5000);
console.log("delayed for 5 seconds");
```

--------------------------------

### Run All Collections

Source: https://docs.thunderclient.com/cli/run-collection

Runs all collections, optionally skipping specified ones.

```bash
tc --col all
```

```bash
tc --col all --skip "ColA,ColB"
```

--------------------------------

### exec

Source: https://docs.thunderclient.com/scripting/filters

Executes a node command and returns the output. Requires a paid version.

```APIDOC
## exec

### Description
Executes a node command and returns the output. Requires a paid version.

### Syntax
`{{variable | exec("command")}}` or `{{@ | exec("command")}}`

### Parameters
- **command** (string) - Required - The node command to execute.
- **var1, var2, ...** (string) - Optional - Variables to substitute into the command using `{0}`, `{1}`, etc.

### Example
If `command` value is `node --version`, then the result is `v16.15.0`.
```

--------------------------------

### tc.loadFromPath(modulPath: string): any

Source: https://docs.thunderclient.com/scripting/api

Loads a module from the specified folder path.

```APIDOC
## tc.loadFromPath(modulPath: string): any

### Description
Loads a module from the specified folder path.

### Method
Function call

### Signature
`tc.loadFromPath(modulPath: string): any`

### Parameters
- **modulPath** (string) - Required - The module path relative to project root or absolute path.

### Returns
- **any** - The loaded module.

### Notes
Available since version 2.21.0.
```

--------------------------------

### Run Folder

Source: https://docs.thunderclient.com/cli/run-collection

Runs all requests in a folder by name or ID.

```bash
tc --fol 'folNameOrId'
```

--------------------------------

### URL Query Parameters - Postman Script

Source: https://docs.thunderclient.com/scripting/postman

Postman script to get and add query parameters using pm.request.url. Use getQueryParam to read a value and addQueryParams to add or update a parameter.

```javascript
// Postman script
// Get a query param value
const userId = pm.request.url.getQueryParam("userId");
 
// Add or update a query param
pm.request.url.addQueryParams({
    debug: "true",
});
```

--------------------------------

### Import JS file with require

Source: https://docs.thunderclient.com/scripting/import-files

Import the JS file using require, including the .js extension. The path should be relative to the workspace if using Git Sync, otherwise use the full path.

```javascript
const { helloWorld } = require("thunder-tests/test-import.js");
 
var result = helloWorld();
console.log(result);
```

--------------------------------

### Open request in UI without auto-run with --ui2 flag

Source: https://docs.thunderclient.com/cli/run-requests

Opens a request in the UI without auto-running it.

```bash
tc 'welcome' --ui2
```

--------------------------------

### format filter syntax

Source: https://docs.thunderclient.com/scripting/filters

Formats a string with placeholders. In environment variables, use `{{variable | format("Hello {0}")}}`. For multiple variables, `{0}`, `{1}`, etc. are replaced by the values of the variables in order. In the Tests tab, use `json.var1 | format("hello {0} {1}", "var2")`.

```plaintext
{{variable | format("Hello {0}")}}
```

```plaintext
{{var1 | format("Hello {0} {1} {2}", "var2", "var3")}}
```

```plaintext
json.var1 | format("hello {0} {1}", "var2")
```

--------------------------------

### Set Environment Variables with tc.setVar

Source: https://docs.thunderclient.com/scripting/variables

Sets environment variables using tc.setVar. The example shows saving to active, local, global, and request scopes. The request scope is for collection or request level variables.

```javascript
  // To save to active environment
  tc.setVar(varName, value);
  
  // To save to local environment
  tc.setVar(varName, value, "local");
  
  // To save to global environment
  tc.setVar(varName, value, "global");
  
  // To set collection or request level variables
  tc.setVar(varName, value, "request");
```

--------------------------------

### Run Multiple Collections

Source: https://docs.thunderclient.com/cli/run-collection

Runs multiple collections by providing comma-separated names or IDs.

```bash
tc --col "colNameOrId1,colNameOrId2"
```

--------------------------------

### first

Source: https://docs.thunderclient.com/scripting/filters

Returns the first element in an array.

```APIDOC
## first

### Description
Returns the first element in an array.

### Syntax
`json.items | first`

### Example
If `json.items` value is `[3,6,8,9]`, then the result is `3`.
```

--------------------------------

### URL Query Parameters - Thunder Client Script

Source: https://docs.thunderclient.com/scripting/postman

Thunder Client script to get and set query parameters using tc.request.url. Use getParam to read a value and setParam to add or update a parameter.

```javascript
// Thunder Client script
// Get a query param value
const userId = tc.request.url.getParam("userId");
 
// Add or update a query param
tc.request.url.setParam("debug", "true");
```

--------------------------------

### format

Source: https://docs.thunderclient.com/scripting/filters

Formats the string output.

```APIDOC
## format

### Description
Formats the string output.

### Syntax
`{{input | format}}`
```

--------------------------------

### Convert JSON response to HTML table

Source: https://docs.thunderclient.com/testing/chart-view

Generic example to convert any response JSON array to an HTML table. The response is passed to tc.chartHTML(html, response) and the data is available in chart_data. Modify the style as needed.

```javascript
var response = tc.response.json;
 
var html = `
    <style>
      body {
        font-size: 13px;
        font-family: "HelveticaNeue", "Helvetica Neue", Helvetica, Arial, sans-serif;
      }
 
      table {
        width: 100%;
        box-sizing: border-box;
        border-collapse: collapse;
        border-spacing: 0;
      }
 
      td,
      th {
        padding: 0;
      }
 
      th, td {
        padding: 4px 6px;
        text-align: left;
        border-bottom: 1px solid #E1E1E1;
      }
 
      th:first-child,
      td:first-child {
        padding-left: 0;
      }
 
      th:last-child,
      td:last-child {
        padding-right: 0;
      }
 
     /* for dark mode use .vscode-dark to override */
     .vscode-dark th, .vscode-dark td {
        border-bottom: 1px solid #555;
      }
  
  </style>
 
    <div id="container"></div>
    
    <script>
         // get the container element
         let container = document.getElementById("container");
         
         var cols = Object.keys(chart_data[0]);
 
          var headerRow = '<tr>';
          var bodyRows = '';
      
          cols.map(function(col) {
              headerRow += '<th>' + col + '</th>';
          });
      
          headerRow += '</tr>';
      
          chart_data.map(function(row) {
              bodyRows += '<tr>';
      
              cols.map(function(colName) {
                  bodyRows += '<td>' + row[colName] + '</td>';
              })
      
              bodyRows += '</tr>';
          });
      
          var tabledata=  '<table>' + headerRow + bodyRows + '</table>';
         container.innerHTML = tabledata; // set table html
      
   </script>`
   
   tc.chartHTML(html, response);
```

--------------------------------

### Run with Iterations

Source: https://docs.thunderclient.com/cli/run-collection

Runs a collection for a specific number of iterations.

```bash
tc --col 'colNameOrId' --iterations 10
```

--------------------------------

### Run with Data File

Source: https://docs.thunderclient.com/cli/run-collection

Runs a collection using a specified data file in CSV or JSON format.

```bash
tc --col 'colNameOrId' --data-file 'relativePathOrFullPath'
```

--------------------------------

### Encrypted Environment File (tc_env_staging.json)

Source: https://docs.thunderclient.com/features/environments/encrypted-envs

Example of an environment file with a variable stored in encrypted format, as used in the Enterprise plan. The value is encrypted and the 'encrypted' field is set to true. To achieve this, set the variable as a Secret in the Environment UI using the lock icon.

```json
{
   "name": "color",
   "value": "F4cuC3C1bmjrhpbG0uDj8A",
   "secret": true,
   "encrypted": true
}
```

--------------------------------

### tc.loadFromPath

Source: https://docs.thunderclient.com/scripting/api

Loads a module from a specified folder path, relative to the project root or absolute.

```APIDOC
## tc.loadFromPath

### Description
Load a module from the specified folder path. The module path can be relative to the project root or an absolute path.

### Method
`tc.loadFromPath(modulePath: string): any`

### Parameters
- **modulePath** (string) - Required - The path to the module.

### Sample Usage
```javascript
console.log("load local module");

var moment = tc.loadFromPath("thunder-tests/packages/node_modules/moment");
```
```

--------------------------------

### tc.exec(command: string): Promise<any>

Source: https://docs.thunderclient.com/scripting/api

Executes a command and returns the result.

```APIDOC
## tc.exec(command: string): Promise<any>

### Description
Executes a command and returns the result.

### Method
Function call

### Signature
`tc.exec(command: string): Promise<any>`

### Parameters
- **command** (string) - Required - The command to execute.

### Returns
- **Promise<any>** - A promise that resolves to the command result.
```

--------------------------------

### tc.readFile(path: string, encoding?: string): Promise<string | undefined>

Source: https://docs.thunderclient.com/scripting/api

Reads a file from disk.

```APIDOC
## tc.readFile(path: string, encoding?: string): Promise<string | undefined>

### Description
Reads a file from disk.

### Method
Function call

### Signature
`tc.readFile(path: string, encoding?: string): Promise<string | undefined>`

### Parameters
- **path** (string) - Required - The file path relative to project root or absolute path.
- **encoding** (string) - Optional - The encoding to use: base64 or utf8. If empty, utf8 will be used.

### Returns
- **Promise<string | undefined>** - A promise that resolves to the file content or undefined.
```

--------------------------------

### Assertions without any library

Source: https://docs.thunderclient.com/scripting/assertions

Use tc.test() to assert response status, JSON body content, and response time. Supports direct boolean values or a function returning a boolean. The example checks status equals 200, JSON message includes 'thunder', and response time under 1000ms.

```javascript
let success = tc.response.status == 200;
let json = tc.response.json;
let containsThunder = json.message?.includes("thunder");

tc.test("Response code is 200", success);
tc.test("Response contains thunder word", containsThunder);

// Assertions using function syntax
tc.test("verifying multiple tests", function () {
        let success = tc.response.status == 200;
        let time = tc.response.time < 1000;
        return success && time;
});
```
Tokens:
Raw