Testfully CLI

Testfully CLI is a multi-platform CLI tool that allows you to work with requests from the command line, and integrate with your CI/CD pipeline.

Pre-requisites

  • Node.js version 16 or higher
  • A Node Package Manager such as npm or yarn.

Installation

Install Testfully CLI globally using npm or yarn.

# Install using npm
npm install -g @testfully/cli

# or install using yarn
yarn global add @testfully/cli

How It Works

To use Testfully CLI, you need to export your requests via the Testfully App. Once exported, you can source the exported files to the Testfully CLI, and run your requests from the command line. To learn more about exporting requests, please refer to the Export Workspace Data page.

run command

The testfully run command executes one or more requests. By default, it runs all requests in the supplied file(s). You can specify one or more requests or folder IDs to run specific requests. Use the following parameters to customize the command.

--request-id

By default, the testfully run command runs all requests in the supplied file(s). You can specify one or more request IDs to run specific requests.

# Run requests with ID 1 and 2 only
testfully run --request-id 1 --request-id 2  rick-and-morty.json

--folder-id

By default, the testfully run command runs all requests in the supplied file(s). You can specify one or more folder IDs to run specific requests.

# Run requests in folder with ID 1 and 2 only
testfully run --folder-id 1 --folder-id 2 rick-and-morty.json

--logs

Display logs in the console.

# Display logs in the console
testfully run --logs  rick-and-morty.json

--verbose

Display raw requests and responses in the console.

testfully run --verbose  rick-and-morty.json

--environment-id

Specify the environment ID to use for the requests.

testfully run --environment-id 1  rick-and-morty.json

positionals

You can specify one or more files to run requests from by passing them as the last arguments.

testfully run --folder-id 1 rick-and-mort-api.json pre-prod.json

FAQ

How does Testfully CLI execute requests?

Testfully CLI uses the host computer to execute requests. It does not use any cloud resources. It uses the same underlying engine as the Testfully App to execute requests so that you can get the same results.

What features are supported in Testfully CLI?

When it comes to executing requests, Testfully CLI supports all features that are supported in the Testfully App except for the following:

  • OAuth2 Authorization using the Authorization Code or PKCE grant types.

Does Testfully CLI store any data on my computer?

Testfully CLI does not store any data. Any computed data is stored in memory and is discarded once the request is completed.

Does Testfully CLI require an internet connection?

Testfully CLI does not require an internet connection to execute requests. However, it may require an internet connection to send requests to API endpoints if they are not available locally.

Can I use Testfully CLI in my CI/CD pipeline?

Yes, Testfully CLI is shipped as a standard Node.js package. You can use it in your CI/CD pipeline to run your requests. We have tested it against Windows 10, Windows 11, Ubutnu 20.04, and macOS 13 and 14.

How can I update Testfully CLI?

You can update Testfully CLI using npm or yarn.

# Update using npm
npm update -g @testfully/cli

# or update using yarn
yarn global upgrade @testfully/cli

How can I uninstall Testfully CLI?

You can uninstall Testfully CLI using npm or yarn.

# Uninstall using npm
npm uninstall -g @testfully/cli

# or uninstall using yarn
yarn global remove @testfully/cli