Skip to content

Commit b0cf6eb

Browse files
committed
docs: Add GitHub URL scanning documentation
1 parent bd91c9d commit b0cf6eb

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,40 @@ Don't have Go? Download pre-built binaries from [Releases](https://github.com/cs
8787
./cryptodeps analyze . --risk vulnerable # Filter by risk level
8888
```
8989

90+
### GitHub Repository Scanning
91+
92+
Scan any public GitHub repository directly without cloning:
93+
94+
```bash
95+
# Full URL
96+
./cryptodeps analyze https://github.com/hashicorp/vault
97+
98+
# Shorthand (owner/repo)
99+
./cryptodeps analyze hashicorp/vault
100+
101+
# With branch/path
102+
./cryptodeps analyze https://github.com/owner/repo/tree/main/subdir
103+
```
104+
105+
Example scanning HashiCorp Vault:
106+
107+
```
108+
$ cryptodeps analyze hashicorp/vault
109+
Fetching hashicorp/vault from GitHub...
110+
111+
Scanning go.mod... found 541 dependencies
112+
113+
DEPENDENCY CRYPTO RISK
114+
────────────────────────────────────────────────────────────────────────────────
115+
github.com/ProtonMail/go-crypto v1.2.0 RSA, ECDSA, Ed25... VULNERABLE
116+
github.com/go-jose/go-jose/v3 v3.0.4 RS256, ES256, A2... VULNERABLE
117+
github.com/golang-jwt/jwt/v4 v4.5.2 RS256, RS384, RS... VULNERABLE
118+
github.com/cloudflare/circl v1.6.2 ML-KEM, ML-DSA, ... VULNERABLE
119+
golang.org/x/crypto v0.45.0 Ed25519, ChaCha2... VULNERABLE
120+
────────────────────────────────────────────────────────────────────────────────
121+
SUMMARY: 541 deps | 9 use crypto | 28 vulnerable | 8 partial
122+
```
123+
90124
### CI/CD Integration
91125

92126
```bash

0 commit comments

Comments
 (0)