| commits-count | Number of recent commits to analyze (default: 250) | no | 250 |
| fetch | Clone the repository itself instead of relying on a prior actions/checkout step. When true, the action shallow-clones into a temp dir, analyzes it and cleans up. Read-only: update-files/commit are skipped in this mode. Uses the GITHUB_TOKEN env var for private repos. | no | false |
| repository | Repository to clone when fetch is true, as "owner/repo" or a full git URL. Defaults to the current repository ($GITHUB_REPOSITORY). | no | "" |
| ref | Branch or tag to clone when fetch is true. Defaults to the cloned repo default branch. | no | "" |
| token | Token for authenticated clones when fetch is true. Defaults to the GITHUB_TOKEN environment variable. Needed only for private repositories. | no | "" |
| co-author-multiplier | Multiplier for co-authored code (0.0 to 1.0, default: 0.8) — share of an AI co-authored commit credited to AI | no | 0.8 |
| extra-bot-patterns | Additional regular expressions (one per line) matched against commit author and Co-Authored-By identities, merged on top of the built-in bot/AI signatures. Use to detect agents or automation bots specific to your team, e.g. "@mycorp-bot\.com". Leave empty to use the built-in list only. | no | "" |
| badge-style | Shield.io badge style (flat, flat-square, plastic, for-the-badge, social) | no | flat-square |
| badge-color | Badge color: "auto" (default) interpolates a color along the green->purple gradient from the score, or pass a fixed hex (without #) / named color | no | auto |
| badge-logo | Logo on the badge: the built-in "sparkles" (AI/magic icon, default) or any simple-icons slug (e.g. "github"). Set to an empty string for no logo. | no | sparkles |
| badge-link | URL the badge links to. Defaults to the Vibe Index repository so readers can learn what the metric means. Set to an empty string to render the badge without a link. | no | https://github.com/roxblnfk/action-vibe-index |
| assert-index | Optional range for assertion (e.g., "7.0-10.0" or "5.0-8.0"). Action will fail if index is outside this range | no | "" |
| badge-output-file | File to write badge URL to (e.g., badge-url.txt) | no | "" |
| update-files | Comma- or newline-separated list of markdown files whose badge to update in place. Set to an empty string to disable. | no | README.md |
| badge-discovery | How to locate the badge to update: "auto" (markers, then an existing "" image), "markers" (only the <!-- vibe-index:start/end --> markers), or "markdown" (only an existing "" image) | no | auto |
| commit | Commit the updated files automatically (requires permissions: contents: write). Default false. | no | false |
| push | Push the auto-commit to the current branch (only used when commit is true). Default false. | no | false |
| commit-message | Commit message used by the auto-commit | no | chore: update Vibe Index badge |
| commit-user-name | git user.name for the auto-commit | no | github-actions[bot] |
| commit-user-email | git user.email for the auto-commit | no | 41898282+github-actions[bot]@users.noreply.github.com |
| include-message | Custom message/label for badge (default: "Vibe Index") | no | Vibe Index |