Documentation

Looking for something in particular?

ProvarDX Commands

Last Modified:

These are the current commands available for ProvarDX.

To learn more about using ProvarDX, visit our documentation about getting started.

Global Commands

Commands are used for manipulating files, etc…

Get a property from the specified JSON file.
Example:

sf provar config get environment.testEnvironment -f config.json

Flags:

Required:

  • -f | --file-path
    Path to the JSON file.

    • Optional:

    –json
    Format response output as json.

    Set one or more properties in the specified JSON file.
    Example:

    sf provar config set environment.webBrowser="Chrome" -f config.json

    Flags:

    Required:

  • -f | --file-path
    Path to the JSON file.

    • Optional:

    –json
    Format response output as json.

    Provar Automation Commands

    Commands specifically for interacting with Provar Automation.

    Generate a boilerplate property file.
    Example:

    sf provar automation config generate -p provardx-properties.json --json

    Flags:

    Required:

  • -p | --properties-file
    Path to the properties file that will be generated.

    • Optional:

  • -n | --no-prompt
    Don’t prompt to confirm file should be overwritten.
  • –json
    Format response output as json.

    • Load a property file to be used in subsequent commands.
    Example:

    sf provar automation config load -p myproperties.json --json

    Flags:

    Required:

  • -p | --properties-file
    Path to the properties file.

    • Optional:

  • –json
    Format response output as json.

    • Set one or more properties in the properties file.
    Examples:

    sf provar automation config set environment.testEnvironment="SIT"

sf provar automation config set environment.testEnvironment="SIT" environment.webBrowser="Ch
rome"

sf provar automation config set testCases='["tests/myTestCase.testcase","tests/testSuite1/myTestCase1.testCase"]'

    Flags:

    Required:

  • None

    • Optional:

  • –json
    Format response output as json.

    • Get a property from the properties file.
    Example:

    sf provar automation config get environment.testEnvironment

    Flags:

    Required:

  • None

    • Optional:

  • –json
    Format response output as json.

    • Validate a property file is a well-formed ProvarDX property file.
    Example:

    sf provar automation config validate

    Flags:

    Required:

  • None

    • Optional:

  • –json
    Format response output as json.

    • Install Provar Automation.
    Example:

    sf provar automation setup --version 2.12.1

    Flags:

    Required:

  • None

    • Optional:

  • -v | --version
    Provar Automation build version number.
  • –json
    Format response output as json.

    • Compile PageObject and PageControl Java source files into object code using the configuration set in the properties file.
    Example:

    sf provar automation project compile

    Flags:

    Required:

  • None

    • Optional:

  • -v | --version
    Provar Automation build version number.
  • –json
    Format response output as json.

    • Refresh metadata for a specified Salesforce connection and store it in the folder set in the properties file.
    Example:

    sf provar automation metadata download -c MySalesforceConnection

    Flags:

    Required:

  • -c | --connections
    Comma-separated list of names of Provar Salesforce connections to use, as defined in the project.

    • Optional:

  • –json
    Format response output as json.

    • Run the tests as specified in the loaded properties file.
    Example:

    sf provar automation test run

    Flags:

    Required:

  • None

    • Optional:

  • –json
    Format response output as json.

    • Provar Manager Commands

    Commands specifically for interacting with Provar Manager.

    Load the alias or username to be used in subsequent commands to connect to Provar Manager.
    Example:

    sf provar manager connect -o my-scratch-org --json

    Flags:

    Required:

    • None

    Optional:

    • -o | --target-org
      Username or alias set in the SF CLI which corresponds to the Provar Manager org.
    • --json
      Format response output as json.

    Display information about the connected Provar Manager org.
    Example:

    Display information about the connected Provar Manager org.
    Example:

    sf provar manager display

    Flags:

    Required:

    • None

    Optional:

    • --json
      Format response output as json.

    Open Provar Manager in a browser.
    Example:

    sf provar manager open

    Flags:

    Required:

    • None

    Optional:

    • --json
      Format response output as json.

    Retrieve test cases related to the provided user stories (issues) or metadata components, for a given test project.
    Examples:

    sf provar manager testcase retrieve -p MyTestProject -t Apex -m "ApexClass:MyApexClass,YourApexClass;ApexPage" --json

sf provar manager testcase retrieve -p MyTestProject -t ProvarAutomation -i "TM-766,TM-718"

    Flags:

    Required:

    • -p | --test-project
      Test Project Key to filter by.
    • -t | --test-automation-tool
      Test Automation tool used to automate the tests.
      Allowed values: Apex, ProvarAutomation

    Optional:

    • -l | --test-plan
      Test Plan Name. Use if you want to retrieve test instance file paths.
    • -m | --metadata-components
      Semicolon-separated list of metadata components, grouped and prefixed by their metadata type.
    • -n | –ignore-metadata
      Semicolon-separated list of metadata types to ignore from METADATA-COMPONENTS or METADATA-FILE.
    • -f | --metadata-file
      Path to a text file that contains the list of metadata components in source format.
    • -i | --issues
      A comma-separated list of issue names (ISS-000000), issue external keys, or issue external IDs.
    • -o | --output
      Output to a specific file instead of stdout.
    • --json
      Format response output as json.

    Run tests via Provar Manager.
    Example:

    sf provar manager test run -f config/run-grid-tests.json -w 10 -p 30

    Flags:

    Required:

    • -f | --configuration-file
    • Path to the configuration file.

    Optional:

    • -p | --polling-interval
      Sets the polling interval in seconds. Default is 60 seconds.
    • -r | --result-format
      Format of the test results.
    • -w | --wait
      Sets the polling timeout in minutes.
    • -y | --synchronous
      Runs command synchronously; if not specified, the command is run asynchronously.
    • -o | --output
      Output to a specific file instead of stdout.
    • --json
      Format response output as json.

    Aborts an in-progress test run.
    Example:

    sf provar manager test run abort -i 707Q100000G4EGo --json

    Flags:

    Required:

    • -i | --test-run
      Test run ID.

    Optional:

    • --json
      Format response output as json.

    Check or poll for the status of a test run operation.
    Example:

    sf provar manager test run report -i 707Q100000G4EGo

    Flags:

    Required:

    • -i | --test-run
      Test run ID.

    Optional:

    • -r | --result-format
    • Format of the test results. Permissible values are: human, junit, json
    • -o | --output
    • Output to a specific file instead of stdout.
    • --json
      Format response output as json.

    Upload test results to Provar Manager.
    Example:

    sf provar manager test run upload

    Flags:

    Required:

    • None

    Optional:

    • --json
      Format response output as json.

    Uploads a code coverage report to Provar Manager.
    Example:

    sf provar manager code coverage upload

    Flags:

    Required:

    • None

    Optional:

    • --json
      Format response output as json.

    Uploads a static code analysis report to Provar Manager.
    Example:

    sf provar manager code quality upload

    Flags:

    Required:

    • None

    Optional:

    • --json
      Format response output as json.

    Feedback

    Was this article helpful for you?
    Documentation library

    Trying to raise a case with our support team?

    Log into the Success Portal

    We use cookies to better understand how our website is used so we can tailor content for you. For more information about the different cookies we use please take a look at our Privacy Policy.

    Scroll to Top