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.

GitHubCIResource mounts the Actions surface of a single repository: runs, jobs, step logs, and artifact metadata. Setup steps for the personal access token live at GitHub CI Credentials.

​
Node

pnpm add @struktoai/mirage-node

import { GitHubCIResource, MountMode, Workspace } from '@struktoai/mirage-node'

const ci = new GitHubCIResource({
  token: process.env.GITHUB_TOKEN!,
  owner: 'strukto-ai',
  repo: 'mirage',
  days: 14,
})

const ws = new Workspace({ '/ci': ci }, { mode: MountMode.READ })
await ws.execute('ls /ci/runs/')

​
Browser

pnpm add @struktoai/mirage-browser

import { GitHubCIResource, MountMode, Workspace } from '@struktoai/mirage-browser'

const ci = new GitHubCIResource({
  token: GITHUB_TOKEN,
  owner: 'strukto-ai',
  repo: 'mirage',
})

​
Config

FieldDefaultNotes
tokenrequiredPersonal access token with actions:read. Redacted in snapshots.
ownerrequiredRepo owner.
reporequiredRepo name.
days30Window of recent runs to expose.
maxRuns1000Hard ceiling on listed runs.
baseUrlhttps://api.github.comOverride for GitHub Enterprise.

​
Mount mode

read. For the run/job/log layout see the Python GitHub CI docs.