Aident logoAident logo centerAident Loadout
Use CasesPricingDocs
ENStart Now
AppsGitHub ToolsGithub Get A Repository Readme
GitHub Tools

Github Get A Repository Readme

Fetches the README file (if it exists and is accessible) from a specified GitHub repository, returning its Base64-encoded content and metadata.

Write actionRisk level 2 of 5OAuth connection
Use Github Get A Repository Readme

Pricing and limits

Aident logo

Product

Aident LoadoutAident Playbook EditorOpen-CUAK

About

AppsSkillsUse CasesDocsBlogPricingDownloadsPrivacy PolicyTerms of Service

Alternatives

vs Composiovs Zapier
llms.txtGet an AI summary of Aident LoadoutSummarize with ChatGPTSummarize with ClaudeSummarize with GeminiSummarize with Perplexity

© Aident Labs, 2024-2026

Pricing
Free
Unified payment
Not currently supported

Inputs

  • refstring
    The specific git reference (branch name, tag name, or commit SHA) to retrieve the README from. If omitted, the repository's default branch is used.
  • repostring
    Required
    The name of the repository, excluding the `.git` extension. This name is not case-sensitive.
  • ownerstring
    Required
    The GitHub account owner of the repository. This name is not case-sensitive.

Observable output

  • data
    Required
    Data from the action execution
  • errorstring
    Error if any occurred during the execution of the action
  • successfulboolean
    Required
    Whether or not the action execution was successful or not

Skills that use this Action

Related use cases

No verified related use cases are linked yet.

Official source

Provider source

Skills that use this Action

  • GitHub README Writing SystemDeveloper
    @Aident7,744230
    Audit, rewrite, review, and publish a repository README through GitHub.
    Sep 10, 2026