|
1 | | -# probely |
| 1 | +# Probely |
2 | 2 |
|
3 | | -### Package level api key setup: |
| 3 | +## Installation |
4 | 4 |
|
5 | | -* Config File: |
6 | | - Create `~/.probely/config` and add: |
| 5 | +Probely requires Python 3.8 or higher. Install the package using pip |
7 | 6 |
|
8 | | - ``` |
9 | | - [AUTH] |
10 | | - api_key = <your_api_key> |
11 | | - ``` |
| 7 | +```sh |
| 8 | +pip install probely |
| 9 | +``` |
12 | 10 |
|
13 | | -* Environment Variables |
14 | | - ``` |
15 | | - export PROBELY_API_KEY=<your_api_key> |
16 | | - ``` |
17 | | -* Tool specific config (see below) |
| 11 | +## Overview |
18 | 12 |
|
19 | | -## CLI |
| 13 | +Probely is a vulnerability scanner for APIs and web applications, designed to empower security teams and software developers in scanning and securing their web applications and APIs. |
20 | 14 |
|
21 | | -### Usage |
| 15 | +This package provides a Command-Line Interface (CLI) to interact with the Probely API, allowing you to perform actions like scanning targets, listing findings, and managing targets directly from your terminal. |
22 | 16 |
|
23 | | -* Use `-h/--help` for available options |
24 | | -* General usage: |
25 | | - * `probely <context> <action> [positional_params ...] [--optinal params ...] -- [positional_params ...]` |
26 | | - * `--` allows you to add positional args after optional |
27 | | -* add `--api-key` for command specific api key |
| 17 | +**For detailed documentation and usage examples, please visit our [CLI documentation](https://developers.probely.com/cli/).** |
28 | 18 |
|
29 | | -## SDK |
30 | | - |
31 | | -* Init `Probely` for specific config |
32 | | - ``` |
33 | | - from probely_cli import Probely |
34 | | -
|
35 | | - Probely.init(api_key=<your_api_key>) |
36 | | - |
37 | | - ... |
38 | | - ``` |
39 | | -* Import `probely_cli` for public interface |
40 | | - |
41 | | - ``` |
42 | | - import probely_cli |
43 | | -
|
44 | | - target = probely_cli.add_target("https://target_url.com") |
45 | | - ``` |
46 | | - |
47 | | -### Development guidelines: |
48 | | - |
49 | | -* Command structure: `Probely <context> <action> params [--optinal params]` |
50 | | -* Follow CLI output good practices. Valid output to `stdout`, errors to `stderr` |
51 | | -* Custom tooling, developers should be aware |
52 | | - * `rich.console` is always available on the `args` |
53 | | - * `probely_cli` pytest fixture (to call CLI commands) |
54 | | -* Error message should have the following structure: `{cmd}: error: {message}`, |
55 | | - following the default implementation of argparse |
56 | | - * eg: `probely targets get: error: filters and target ids are mutually exclusive.` |
| 19 | +## Contributing |
57 | 20 |
|
| 21 | +We appreciate your interest in Probely! While we are not currently accepting external contributions, we welcome feedback and bug reports. If you encounter any issues or have suggestions, please create an issue on our GitHub repository. |
0 commit comments