Skip to main content

Quick Start

In this quick start, we will go through the necessary steps for you to start using the CLI.

Step 1: Get the authorization token​

First, you have to generate an API Key. It will be your authorization token to for the CLI commands. Check all the necessary steps in the Authentication topic.

Step 2: Install the CLI​

Open a terminal window and install Probely CLI using the following command:

pip install probely

Step 3: Run your first CLI command​

With the CLI installed and your authorization token, you can start running CLI commands. In this case, you're going to list the targets in your account.

In this example, the authorization token is included in the CLI command (you just have to replace <YOUR_API_KEY> with your authorization token). Learn more about how to use the authorization token.

CLI command
probely targets get --api-key <YOUR_API_KEY>

The command will return the following output:

CLI command output
ID            NAME                                  URL                                               RISK     LAST_SCAN         LABELS           
2BRoXafS9kD1  My web app target                     https://example.com/                              HIGH     2024-10-01 17:08  web app    
uaUAtWff6R3n  My API target                         http://api.example.com/                           HIGH     2024-09-30 15:16  api          
...           ...                                   ...                                               ...      ...                  ...

And that's it!
Explore this documentation to learn more about all the CLI capabilities and make the most out of it!