Skip to content

Commit 47bcb1f

Browse files
committed
Clarified more use-cases, including adding one related to Forensics
1 parent 9510f3f commit 47bcb1f

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,20 @@ The Octocat getting X-Rayed | [![Build Workflows](https://github.com/kulkansecu
99
# Use cases
1010
Gitxray can be used to, for example:
1111
- Find sensitive information in contributor profiles disclosed by accident within, for example, Armored PGP Keys, or Key Names.
12+
13+
` gitxray -r https://github.com/some-org/some-repository -v -f user_input`
1214
- Identify threat actors in a Repository. You may spot co-owned or shared accounts, as well as inspect public events to spot fake Stargazers.
15+
16+
` gitxray -r https://github.com/some-org/some-repository -v -f keys,association,starred`
1317
- Identify fake or infected Repositories. It can detect tampered commit dates as well as, for example, Release assets updated post-release.
14-
- And a lot more!
18+
19+
` gitxray -r https://github.com/some-org/some-repository -v -f warning`
20+
- Forensics use-cases, such as filtering results by date in order to check what else happened on the day of an incident.
21+
22+
` gitxray -r https://github.com/some-org/some-repository -v -f 2024-09-01`
23+
- And a lot more! Run a full X-Ray in Verbose mode to collect a ton of data.
24+
25+
` gitxray -r https://github.com/some-org/some-repository -v`
1526

1627
Please refer to the Documentation for additional use-cases and introductory information.
1728

0 commit comments

Comments
 (0)