bpmcdevitt/github_searcher
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
kenna-bmcdevitt 2025-01-21 10:13:26 -06:00
parent a0c81591eb
commit 7434e17020
1 changed files with 35 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
README.md
View file

@ -81,5 +81,38 @@ python github_searcher.py --query QUERY --search_type SEARCH_TYPE [--get_file_co
6. Use Docker Compose to search for a specific CVE-ID and output results to a file:
```sh
docker-compose run --rm github_searcher python3 /usr/src/app/github_searcher.py --query=CVE-2024-5932 --search_type=in-repo-name --get_open_issues --get_open_pull_requests --get_file_contents --json > cve-2024-5932
```
docker-compose run --rm app python3 /usr/src/app/github_searcher.py --query=CVE-2024-5932 --search_type=in-repo-name --get_open_issues --get_open_pull_requests --get_file_contents --json > cve-2024-5932
```
7. Search for a specific repository by name and get open issues:
```sh
python github_searcher.py --query "torvalds/linux" --search_type in-repo-name --get_open_issues
```
8. Search for a specific repository by name and get open pull requests:
```sh
python github_searcher.py --query "apple/swift" --search_type in-repo-name --get_open_pull_requests
```
9. Search for a specific repository by name and get file contents:
```sh
python github_searcher.py --query "microsoft/vscode" --search_type in-repo-name --get_file_contents
```
10. Search for a specific repository by name and output results in JSON format:
```sh
python github_searcher.py --query "facebook/react" --search_type in-repo-name --json
```
## Output
The output will include the following details based on the flags provided:
- **Repository URL**: The URL of the repository.
- **Open Issues**: A list of open issues with their titles and URLs.
- **Open Pull Requests**: A list of open pull requests with their titles and URLs.
- **File Contents**: A list of file contents with their names, SHAs, sizes, encodings, and URLs.
## License
This project is licensed under the MIT License.