GitHub - Read File
Read the contents of a file from a GitHub repository
GitHub: Read File
1Description
The GitHub: Read File node allows your Deforge workflows to securely fetch and read the exact contents of any file within a GitHub repository. Because GitHub's API natively returns file data in Base64 encoding, this node automatically decodes the content into plain text so it can be immediately processed by downstream nodes or AI models.
When provided as a Tool to an LLM node, this becomes a critical component for Retrieval-Augmented Generation (RAG) and autonomous coding. It acts as the "eyes" of your AI agent, allowing it to autonomously navigate a codebase, inspect configuration files, or read through documentation to find the exact context it needs before making a decision or writing a fix.
Common Use Cases
- Autonomous Code Debugging: An agent reads a bug report, then uses this node to read the specific
src/index.jsfile mentioned in the ticket to locate the bug. - Dependency Checking: Setting up a scheduled workflow that reads the
package.jsonof a repository, passes the plain text to an LLM to check for deprecated packages, and alerts your team if an update is needed. - Dynamic Documentation Generation: Fetching an existing
README.mdfile, passing it to an LLM alongside new feature notes, and generating updated documentation to be pushed back via the GitHub: Create/Update File node.
Inputs
The input connections this node accepts:
NameDescriptionTypeFlowThe flow of the workflowFlowRepositoryRepository (e.g., octocat/Hello-World)TextFile PathFile Path (e.g., src/index.js)TextOutputs
The output connections this node provides:
NameDescriptionTypeFlowThe Flow to continueFlowFile ContentThe plain text content of the fileTextFile NameThe name of the fileTextDownload URLThe download URL of the fileTextToolThe tool version of this node, to be used by LLMsToolFields
The configurable fields this node provides:
NameDescriptionTypeRepositoryRepository (e.g., owner/repo)Value: ``TextFile PathPath to the fileValue:README.mdTextGitHubConnect your GitHub accountDefaultValue: ``socialLast updated on