CLI

Follow these quick steps to setup your environment for working with the Cursion CLI

CLI structure

Tips

All of the CLI commands follow the same basic structure.

Command	Objects	Usage
add-<object>	Site, Page	create object
delete-<object>	Site, Page	delete object
get-<object>s	Site, Page, Scan, Test	retrieve one or more objects
scan-<object>	Site, Page	scan an object
test-<object>	Site, Page	test an object
run-<object>	Case, Flow	run an object

CLI Setup

1. Install Cursion CLI: pip install cursion
2. Retrieve your API token located in your account page
3. Configure the CLI: cursion setup and follow the prompts
4. Check the configuation: cursion check

---

Docker CLI Image

This docker image provides easy access to the CLI and priorities single use commands for simple integration with CI/CD tools

Usage

docker run cursiondev/cli test-site \ 
    <site-id> \
    --threshold 85 \
    --max-wait-time 120 \
    --api-key <api_key>

For a full list of commands:

docker run cursiondev/cli --help