For the complete documentation index, see llms.txt. This page is also available as Markdown.

GitHub settings (github: )

GitHub is configured as a list, so multiple instances (e.g. github.com plus a GitHub Enterprise Server) are supported side by side. The settings below cover connection and auth, which orgs/repos/branches to include or exclude, performance tuning, and privacy controls (redact_names_and_urls, strip_text_content).

Key

Required

Default

Description

instance_slug

Yes

-

Unique name for this instance (e.g. github-main)

token

Yes (self-hosted)

-

GitHub Personal Access Token (classic or fine-grained). Omit for Hivel-managed credentials - see Hivel-managed credentials below

url

No

https://api.github.com

Override for GitHub Enterprise Server

earliest_data_date

Yes

-

YYYY-MM-DD - pull commits/PRs updated since this date

include_orgs

No

all accessible

Org slugs to sync

exclude_orgs

No

-

Org slugs to skip

include_repos

No

all

Repo names to sync

exclude_repos

No

-

Repo names to skip

extra_branches

No

-

Additional branch names to fetch for all repos

include_branches

No

-

Per-repo branch override map

concurrent_threads

No

10

Goroutines for concurrent repo fetching

include_top_level_comments

No

false

Include PR-level (non-inline) comments

exclude_file_paths

No

-

Glob patterns for PR file paths to drop

exclude_commit_patterns

No

-

Glob patterns matched against commit messages to skip

exclude_pr_source_branches

No

-

Glob patterns for PR head branch to skip (e.g. dependabot/*)

exclude_pr_target_branches

No

-

Glob patterns for PR base branch to skip

exclude_teams

No

-

Glob patterns for team slugs/names to skip

use_rest_only

No

false

Force REST-only (for GHE without GraphQL)

skip_ssl_verification

No

false

Disable TLS verification (self-signed certs on GHE)

redact_names_and_urls

No

false

Replace names and URLs with redacted-NNNN placeholders

strip_text_content

No

false

Strip all text (commit messages, PR titles, etc.)

GitHub API used: GraphQL (primary) + REST (auth check, rate limits). Public GitHub and GitHub Enterprise Server supported.

Multi-instance credentials - use a different ${ENV_VAR} name per entry in config.yml; define each in .env:

Last updated