https://gh-velocity.org/reference/Recent content in Reference on gh-velocityHugoenhttps://gh-velocity.org/reference/config/Mon, 01 Jan 0001 00:00:00 +0000https://gh-velocity.org/reference/config/<h1 id="configuration-reference">Configuration Reference<a class="anchor" href="#configuration-reference">#</a></h1> <p>Complete reference for <code>.gh-velocity.yml</code> fields, types, defaults, and validation rules.</p> <p>All metric commands require a <code>.gh-velocity.yml</code> file. Run <code>gh velocity config preflight --write</code> to generate one, or create one manually in your repository root. Use <code>--config</code> to point to an alternate path. Every field is optional -- the tool uses sensible defaults for anything omitted.</p> <p>To generate a config tailored to your repository:</p> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>gh velocity config preflight <span style="color:#75715e"># preview to stdout (from inside your repo)</span> </span></span><span style="display:flex;"><span>gh velocity config preflight --write <span style="color:#75715e"># save to .gh-velocity.yml</span> </span></span><span style="display:flex;"><span>gh velocity config preflight -R cli/cli <span style="color:#75715e"># analyze a remote repo</span></span></span></code></pre></div><p>To validate an existing config:</p>https://gh-velocity.org/reference/api-consumption/Mon, 01 Jan 0001 00:00:00 +0000https://gh-velocity.org/reference/api-consumption/<h1 id="api-consumption">API Consumption<a class="anchor" href="#api-consumption">#</a></h1> <p>How gh-velocity uses the GitHub API: rate limits, per-command costs, caching, and optimization.</p> <h2 id="api-types-used">API types used<a class="anchor" href="#api-types-used">#</a></h2> <p>gh-velocity uses two GitHub API interfaces:</p> <table> <thead> <tr> <th>API</th> <th>Rate limit</th> <th>Used for</th> </tr> </thead> <tbody> <tr> <td><strong>REST Search API</strong></td> <td>30 requests/minute, 1000 results/query</td> <td>Finding issues, PRs by date range, scope, lifecycle</td> </tr> <tr> <td><strong>GraphQL API</strong></td> <td>5,000 points/hour</td> <td>Project board data, timeline events, closing references, iteration fields</td> </tr> </tbody> </table> <p>The Search API is the primary bottleneck. Each paginated search query (up to 10 pages of 100 results) counts as one request per page against the 30/minute limit.</p>