Skip to content

Commit 3cb7e76

Browse files
committed
update README
1 parent a9c29d0 commit 3cb7e76

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ cd /path/to/your/git/repository
6565
**2. Run the tool**:
6666
6767
```bash
68-
GitContentSearch.exe <file-path> <search-string> [--earliest-commit=<commit>] [--latest-commit=<commit>]
68+
GitContentSearch.exe <file-path> <search-string> [--earliest-commit=<commit>] [--latest-commit=<commit>] [--working-directory=<path>] [--log-directory=<path>]
6969
```
7070
7171
Note: Make sure the file path does not start with a forward slash (/), as this can cause errors when Git tries to locate the file.
@@ -76,18 +76,20 @@ Note: Make sure the file path does not start with a forward slash (/), as this c
7676
* `<search-string>`: The string you want to search for in the Content file.
7777
* `--earliest-commit=<commit>`: (Optional) The earliest commit to begin the search.
7878
* `--latest-commit=<commit>`: (Optional) The latest commit to end the search.
79+
* `--working-directory=<path>`: (Optional) The directory where Git commands should be executed. Defaults to the current directory if not provided.
80+
* `--log-directory=<path>`: (Optional) The directory where the log file and temporary files will be stored. Defaults to the current directory if not provided.
7981
8082
### Example
8183
8284
```bash
83-
GitContentSearch.exe "path/to/your/Content-file.xlsx" "SearchString" --earliest-commit=abc123 --latest-commit=def456
85+
GitContentSearch.exe "path/to/your/Content-file.xlsx" "SearchString" --earliest-commit=abc123 --latest-commit=def456 --working-directory="/your/git/repo" --log-directory="/your/log/directory"
8486
```
8587
86-
This will search for the string "SearchString" within the specified commit range.
88+
This will search for the string "SearchString" within the specified commit range, using the specified working directory for Git operations and storing logs and temporary files in the specified log directory.
8789
8890
## Output
8991
90-
Search Log: A file named search_log.txt is created in the working directory, detailing the commits checked and whether the string was found.
92+
Search Log: A file named search_log.txt is created in the log directory, detailing the commits checked and whether the string was found. The log directory is also used to store any temporary files generated during the search process.
9193
9294
## Dependencies
9395

0 commit comments

Comments
 (0)