-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
50 additions
and
45 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# CLI Usage Examples | ||
|
||
When using CLI you need to supply a path to your XML mutation file. A single XML mutation file can contain multiple mutation definitions. Next, you decide if you want to specify XML files one by one and use the [include command](#include-command) or scan the directory and use the [scan command](#scan-command). You can consult how to use CLI with a `help` call. | ||
|
||
```bash | ||
xml-mut --help | ||
``` | ||
|
||
## include command | ||
|
||
You can consult how to use the include command with a `help` call: | ||
|
||
```bash | ||
xml-mut include --help | ||
``` | ||
|
||
The usage is as follows: | ||
|
||
```bash | ||
xml-mut <XML_MUT_PATH> include --xml-path <XML_PATH> | ||
``` | ||
|
||
Here `<XML_MUT_PATH>` is a path to your XML mutation file. You can give it `.xmlmut` extension but it is not mandatory so far. `--xml-path` or `-x` argument can be repeated allowing you to include multiple XML files to be mutated. So a call could look something like this: | ||
|
||
```bash | ||
xml-mut ~/pref-version-fix.xmlmut include -x ~/code/awesome.csproj -x ~/code/amazing.fsproj | ||
``` | ||
|
||
## scan command | ||
|
||
You can consult how to use the `scan` command with a `help` call: | ||
|
||
```bash | ||
xml-mut scan --help | ||
``` | ||
|
||
The usage is as follows: | ||
|
||
```bash | ||
xml-mut <XML_MUT_PATH> scan --extension <EXTENSION> <BASE_PATH> | ||
``` | ||
|
||
Here `<XML_MUT_PATH>` is a path to your XML mutation file. You can give it `.xmlmut` extension but it is not mandatory so far. `--extension` or `-e` allows specifying what file extensions to include when scanning the directory. You can specify multiple extensions. `<BASE_PATH>` defines a path you want to scan. So a call could look something like this: | ||
|
||
```bash | ||
xml-mut ~/pref-version-fix.xmlmut scan -e csproj -e fsproj ~/code | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters