GET
github_repos_get_readme.py
Requires
repo, read:user.Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Get the repository’s README, decoded to text. GitHub picks the preferred file itself across the spellings a repository might use, which saves guessing at repos_get_content.
from charter.packs import github
result = await github.repos_get_readme.ainvoke({"owner": ..., "repo": ...})
repo, read:user.| Field | Type | Description |
|---|---|---|
owner * | string | The account owner of the repository. The name is not case sensitive. |
repo * | string | The name of the repository without the .git extension. The name is not case sensitive. |
| Field | Type | Description |
|---|---|---|
ref | string | The name of the commit/branch/tag. Absent, the repository’s default branch. |
Was this page helpful?