KeyRunner CLI Documentation

Description

Executes various operations related to projects, workspaces, collections, and requests.

Commands

Displays the current version of Keyrunner.

keyrunner show-version

Retrieves a list of all projects.

keyrunner get-all-projects

Retrieves workspaces associated with a specific project.

• <projectId>: ID of the project.

keyrunner get-workspaces --projectId <projectId>

Retrieves collections within a specified workspace.

• <workspaceId>: ID of the workspace.

keyrunner get-collections --workspaceId <workspaceId>

Retrieves requests within a specified workspace and collection.

• <workspaceId>: ID of the workspace.
• <collectionId>: ID of the collection.

keyrunner get-requests --workspaceId <workspaceId> --collectionId <collectionId>

Retrieves request flows within a specified project and workspace.

• <projectId>: ID of the project.
• <workspaceId>: ID of the workspace.

keyrunner get-request-flows --projectId <projectId> --workspaceId <workspaceId>

Executes a specific request and saves the results.

• <projectId>: ID of the project.
• <workspaceId>: ID of the workspace.
• <collectionId>: ID of the collection.
• <requestId>: ID of the request.
• --saveResults Y: Option to save the execution results.

keyrunner execute-request --projectId <projectId> --workspaceId <workspaceId> --collectionId <collectionId> --requestId <requestId> --saveResults Y

Executes a specific request flow and saves the results.

• <workspaceId>: ID of the workspace.
• <requestFlowId>: ID of the request flow.
• --saveResults Y: Option to save the execution results.

keyrunner execute-request-flow --workspaceId <workspaceId> --requestFlowId <requestFlowId> --saveResults Y

Executes a request flow from a JSON file path and saves the results.

• <jsonPath>: Path to the JSON file containing request flow details.
• --saveResults Y: Option to save the execution results.

keyrunner execute-request-flow --jsonPath <jsonPath> --saveResults Y

Executes a collection within a specified workspace and saves the results.

• <workspaceId>: ID of the workspace.
• <collectionId>: ID of the collection.
• --saveResults Y: Option to save the execution results.

keyrunner execute-collection --workspaceId <workspaceId> --collectionId <collectionId> --saveResults Y

File Naming Conventions for Saved Responses

• Request Response Format:

  • Format: execute-request_<projectId>_<workspaceId>_<collectionId>_<requestId>_<YYYY_MM_DD_HH_MM_SS>_<uuid>.json
  • Example: execute-request_665bb9c15252273047debdf8_665bbcd15252273047debe00_665ce9b746a9e565b0b5eb39_665ce9ba46a9e565b0b5eb3f_2024_7_4_6_37_49_3qqjt8fg36xjj7r9vwuo5m.json

• Request Flow Response Format:

  • Format: execute-request-flow_<workspaceId>_<requestFlowId>_<YYYY_MM_DD_HH_MM_SS>_<uuid>.json
  • Example: execute-request-flow_665bbcd15252273047debe00_666a5b438aeb6929fdb386dc_2024_7_4_6_49_15_l7aii7y7bsaia9vnp8869.json

• Local Request Flow Response Format:

  • Format: execute-request-flow_local_workspace_<requestFlowName>_<YYYY_MM_DD_HH_MM_SS>_<uuid>.json
  • Example: execute-request-flow_local_workspace_phani-flow-1_2024_7_4_6_51_5_0o3dah80ppvp8zvwuwmf16t.json

• Collection Execution Response Format:

  • Format: execute-collection_<workspaceId>_<collectionId>_<YYYY_MM_DD_HH_MM_SS>_<uuid>.json
  • Example: execute-collection_665bbcd15252273047debe00_666a5b438aeb6929fdb386dc_2024_7_4_6_47_56_uzr9bb553t862zq2tp0fr.json