Skip to main content
The Trusys Command-Line Interface (CLI) provides a powerful way to interact with the Trusys platform directly from your terminal. Use the CLI to manage projects, run security and evaluation tests, and automate workflows.

​
Installation

To install Trusys, use the following command:
  • npx
npx trusys@latest

​
Verify Installation

To ensure trusys is installed correctly, run:
  • npx
npx trusys@latest --version

​
Login

Authenticate with your API Key 
npx trusys auth login --api-key <your_api_key>
# OR
npx trusys auth login -k <your_api_key>
Replace <your_api_key> with the API key from your workspace. Learn how to create an API Key

​
Functional Evaluation

  • Run Evaluation with Custom Application and Prompt Library 
    npx trusys eval --run --application <applicationName> --library <library>
  • If using custom application 
    npx trusys eval --run --application <applicationName> --applicationPath <path_to_custom_provider> --library <library>
    Here the applicationPath switch should point to the local path of the custom provider file that you have written.
After the run, you’ll receive a link to view results online. Log in with your registered email to access the test summary.

​
Security Evaluation

  • Run Red Team Security Evaluation 
    npx trusys redteam run --securityConfig <configName> --user <your_email>
  • If using custom application 
    npx trusys redteam run --securityConfig <configName> --user <your_email> --applicationPath <path_to_custom_provider>
    Here the applicationPath switch should point to the local path of the custom provider file that you have written.