Skip to content

Commit 825e1ef

Browse files
committed
feat: upgrade remote scanning and reporting (README.md)
1 parent b8cc6db commit 825e1ef

1 file changed

Lines changed: 22 additions & 1 deletion

File tree

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,12 @@ export GROQ_API_KEY="your-groq-key"
2424
export NVIDIA_NIM_API_KEY="your-nim-key"
2525
```
2626

27+
If you want to roast a private GitHub repository by URL, also set:
28+
29+
```bash
30+
export GITHUB_TOKEN="your-github-token"
31+
```
32+
2733
Default model choices in this project:
2834
- Primary: `llama-3.3-70b-versatile` (Groq)
2935
- Backup: `microsoft/phi-4-mini-instruct` (NIM)
@@ -33,6 +39,7 @@ Default model choices in this project:
3339
```bash
3440
roast ./my-project
3541
roast https://github.com/user/repo
42+
roast https://github.com/user/repo/tree/main --no-llm
3643
roast ./my-project --no-llm --output report.html
3744
```
3845

@@ -43,6 +50,20 @@ roast ./my-project --provider groq --model llama-3.3-70b-versatile
4350
roast ./my-project --provider auto --backup-provider nim --backup-model microsoft/phi-4-mini-instruct
4451
```
4552

53+
CI and machine-readable output:
54+
55+
```bash
56+
roast ./my-project --no-llm --json-output roast-report.json
57+
roast ./my-project --no-llm --fail-under 70
58+
roast ./my-project --no-llm --include-config --max-files 80
59+
```
60+
61+
What changed in `0.2.0`:
62+
- GitHub URL scans now download repo archives instead of cloning full git history.
63+
- Private GitHub repo URLs work when `GITHUB_TOKEN` is configured.
64+
- HTML reports now include hotspot summaries and interactive issue filters.
65+
- JSON report export and `--fail-under` make the CLI usable in CI.
66+
4667
## Demo
4768

4869
![roast-my-code demo](./demo.gif)
@@ -57,4 +78,4 @@ _Recorded with VHS._
5778

5879
## Contributing
5980

60-
Contributions are welcome. Open an issue for bugs/ideas, then submit a PR with tests for behavior changes.
81+
Contributions are welcome. Open an issue for bugs or ideas, then submit a PR with tests for behavior changes. The main verification workflow now runs on pushes and pull requests that touch the CLI, reporter, scanner, or tests.

0 commit comments

Comments
 (0)