Skip to content

Commit 9d3cc61

Browse files
committed
Added documentation for the CLI scripts.
1 parent f6ecc98 commit 9d3cc61

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

+38
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ by the test suite, the "survived" mutation can be used to create an additional t
99
- [Installation](#installation)
1010
- [Example](#example)
1111
- [Further features](#further-features)
12+
- [Command-line tools](#command-line-tools)
1213
- [Help!](#help)
1314
- [Used third-party tools](#used-third-party-tools)
1415
- [License](#license)
@@ -252,6 +253,43 @@ In the [project overview](http://127.0.0.1:5000/projects/1), you also get some s
252253
quickcheck command return exit code `77`.
253254

254255

256+
## Command-line tools
257+
258+
Mutate++ provides some command-line scripts to facilitate its usage without the web interface.
259+
These scripts can be found in the `cli` directory, and should be run from the root directory.
260+
261+
### `create_project.py`
262+
This script will create a project and add it to the database.
263+
264+
Example usage:
265+
```bash
266+
venv/bin/python3 cli/create_project.py --name "Example project" --workdir "/tmp/cmake-example/build" --build-command "make" --test-command "ctest"
267+
```
268+
269+
### `add_files.py`
270+
This script will add files to an existing project.
271+
272+
Example usage:
273+
```bash
274+
venv/bin/python3 cli/add_files.py --project "Example project" /tmp/cmake-example/src/*.cpp
275+
```
276+
277+
### `generate_patches.py`
278+
This script will generate patches for all files in a project.
279+
280+
Example usage:
281+
```bash
282+
venv/bin/python3 cli/generate_patches.py --project "Example project"
283+
```
284+
285+
### `queue_control.py`
286+
This script allows you to control the queue and view its state.
287+
288+
Example usage:
289+
```bash
290+
venv/bin/python3 cli/queue_control.py start
291+
```
292+
255293
## Help!
256294

257295
Mutate++ is in a very early stage, and there is a lot to do. In particular, we are aware of severe limitations:

0 commit comments

Comments
 (0)