Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mirage.strukto.ai/llms.txt

Use this file to discover all available pages before exploring further.

Dependencies

No additional dependencies - uses aiohttp (included). For credential setup, see the GitHub Setup guide.

Configuration

import os
from mirage import Workspace, MountMode
from mirage.resource.github import GitHubConfig, GitHubResource

config = GitHubConfig(token=os.environ["GITHUB_TOKEN"])
resource = GitHubResource(
    config=config, owner="my-org", repo="my-repo", ref="main")
ws = Workspace({"/github": resource}, mode=MountMode.READ)

Config Reference

FieldRequiredDescription
tokenYesGitHub Personal Access Token