Skip to content

docs: document --model flag in README - #39

Merged
nazarli-shabnam merged 3 commits into
mainfrom
docs/readme-model-flag
Jul 25, 2026
Merged

docs: document --model flag in README#39
nazarli-shabnam merged 3 commits into
mainfrom
docs/readme-model-flag

Conversation

@nazarli-shabnam

Copy link
Copy Markdown
Owner

Summary

  • cli.py already implements a --model override flag (defaults to AI_MODEL from the repo .env), but it was missing from the README's Flags table.
  • Added the --model row.

Test plan

  • pytest -q / ruff check . / ruff format --check . (unaffected, docs-only change)

Closes #23

(Re-opened as a new PR: the original PR #31 was auto-closed by GitHub when main's history was rewritten to correct a contributor's commit attribution — this branch is unchanged. GitAds removal from README still pending as a follow-up commit on this branch.)

cli.py already implements a --model override, but it was missing
from the README's Flags table, so users wouldn't discover it.

Closes #23
@coderabbitai

coderabbitai Bot commented Jul 25, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@nazarli-shabnam, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 5 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 11051521-148a-4956-ac08-fd1066ec6f8c

📥 Commits

Reviewing files that changed from the base of the PR and between 11a379a and 224a0ee.

📒 Files selected for processing (3)
  • .github/workflows/ci.yml
  • README.md
  • pyproject.toml
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-model-flag

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

The lint job's `pip install ruff` had no version pin, decoupled from
pyproject.toml's own ruff>=0.8.0. A newer ruff release enables new
default-on lint rules, breaking CI on pre-existing code unrelated to
this change. Pin to the last known-good version in both places.
Drop the GitAds-Verify comment and the Sponsored section/badge.
@nazarli-shabnam nazarli-shabnam self-assigned this Jul 25, 2026
@nazarli-shabnam nazarli-shabnam added the documentation Improvements or additions to documentation label Jul 25, 2026
@nazarli-shabnam
nazarli-shabnam merged commit 499c601 into main Jul 25, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README Flags table is missing --model

1 participant