TestRigor Command Line

This is a command line tool for TestRigor. It allows you to run TestRigor tests from the command line.

Installation

1. Install Node.js (version 18 or higher)
2. Install TestRigor CLI: npm install -g testrigor-cli

Examples

1. Basic testrigor test-suite run <test-suite-id> --token <token>
2. With new URL testrigor test-suite run <test-suite-id> --token <token> --url <url>
3. With file upload testrigor test-suite run <test-suite-id> --token <token> --file-path <path-to-file>
4. With branch testrigor test-suite run <test-suite-id> --token <token> --branch <branch> --commit <commit>
5. With variables testrigor test-suite run <test-suite-id> --token <token> --variables-path file.json
6. Localhost mode testrigor test-suite run <test-suite-id> --token <token> --localhost
7. With test cases testrigor test-suite run <test-suite-id> --token <token> --test-cases-path test_cases/**/*.{yaml,txt}
8. With rules testrigor test-suite run <test-suite-id> --token <token> --rules-path rules/**/*.yaml
9. With settings testrigor test-suite run <test-suite-id> --token <token> --settings-path settings.yaml (Can be YAML or JSON)
10. Run a single test case testrigor test-suite run <test-suite-id> --token <token> --test-case-uuid <test-case-uuid>
11. Run with auto create AI rules enabled testrigor test-suite run <test-suite-id> --token <token> --test-cases-path test_cases/**/*.{yaml,txt} --auto-create-ai-rules
12. Run with explicit mutations enabled testrigor test-suite run <test-suite-id> --token <token> --test-cases-path test_cases/**/*.{yaml,txt} --explicit-mutations
13. With all options testrigor test-suite run <test-suite-id> --token <token> --url <url> --branch <branch> --commit <commit> --variables-path file.json --localhost --test-cases-path test_cases/**/*.{yaml,txt} --rules-path rules/**/*.{yaml,txt} --auto-create-ai-rules --explicit-mutations
14. Save JUnit report to ./junit-report.xml (works only in sync mode): testrigor test-suite run <test-suite-id> --token <token> --junit-report-save-path ./report.xml
15. With comma-separated labels testrigor test-suite run <test-suite-id> --token <token> --labels <labels>
16. Excluding comma-separated labels testrigor test-suite run <test-suite-id> --token <token> --excluded-labels <excluded-labels>
17. With different WEB and API URLs testrigor test-suite run <test-suite-id> --token <token> --base-url-web=<base-web-url> --base-url-api=<base_api_url>
18. Set the default test suite ID: testrigor test-suite config --default <test-suite-id>
19. Remove the default test suite ID: testrigor test-suite config --delete
20. Show current configuration: testrigor test-suite config --show
21. Authenticate with TestRigor and store credentials (interactive prompt): testrigor authenticate