Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Added documentation for the CLI scripts.
  • Loading branch information
dirtcrusher committed Apr 16, 2022
commit 9d3cc612d87d6efee1897d00c7950f1ff98e9397
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ by the test suite, the "survived" mutation can be used to create an additional t
- [Installation](#installation)
- [Example](#example)
- [Further features](#further-features)
- [Command-line tools](#command-line-tools)
- [Help!](#help)
- [Used third-party tools](#used-third-party-tools)
- [License](#license)
Expand Down Expand Up @@ -252,6 +253,43 @@ In the [project overview](http://127.0.0.1:5000/projects/1), you also get some s
quickcheck command return exit code `77`.


## Command-line tools

Mutate++ provides some command-line scripts to facilitate its usage without the web interface.
These scripts can be found in the `cli` directory, and should be run from the root directory.

### `create_project.py`
This script will create a project and add it to the database.

Example usage:
```bash
venv/bin/python3 cli/create_project.py --name "Example project" --workdir "/tmp/cmake-example/build" --build-command "make" --test-command "ctest"
```

### `add_files.py`
This script will add files to an existing project.

Example usage:
```bash
venv/bin/python3 cli/add_files.py --project "Example project" /tmp/cmake-example/src/*.cpp
```

### `generate_patches.py`
This script will generate patches for all files in a project.

Example usage:
```bash
venv/bin/python3 cli/generate_patches.py --project "Example project"
```

### `queue_control.py`
This script allows you to control the queue and view its state.

Example usage:
```bash
venv/bin/python3 cli/queue_control.py start
```

## Help!

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