[Integrations](https://spiral.ai/integrations) › [Instinct](https://spiral.ai/integrations/instinct) › [GitHub repository file](https://spiral.ai/integrations/instinct/github-repository-file)

# How to Use GitHub repository file in Instinct

Fetch the text of one public repository file at a branch, tag, or commit. Use it to read a README, license, or package manifest, and choose a commit when the review needs a fixed version.

|  |  |
| --- | --- |
| Model | GitHub repository file |
| Available through | Alexandria |
| Category | E-commerce |
| Price | $0.001746 per call. |
| Returns | json |
| Runs | In the background |
| Setup | About 2 minutes, with a Spiral API key |

## Prompts to try with GitHub repository file in Instinct

- Each morning, use GitHub repository file to read SECURITY.md in django/django on main and summarize any changes from the previously saved text.
- Every Monday at 9am: use GitHub repository file to look this up and give me the result as a table.
- Pull the latest numbers from GitHub repository file and tell me what changed since last week.
- Check GitHub repository file and summarize what you find in three bullet points.
- Pull the newest data from GitHub repository file and give me the result as a table.

## How to set up GitHub repository file in Instinct

Pick the way that suits you. Each takes about two minutes.

### Use the Spiral skill

1. **Send Instinct this message**: Your agent reads Spiral's skill and sets itself up.

```
set up https://spiral.ai/SKILL.md
```

2. **Sign in or paste a key**: Approve Spiral in the browser, or give the agent a key from the console.

### Use Spiral's MCP server

1. **Create an API key**: In the console, open API keys and create a key for Instinct. Copy it.

2. **Send Instinct this message**: Instinct reads Spiral's skill and asks for your API key.

```text
set up https://spiral.ai/SKILL.md
```

3. **Give Instinct the key**: When Instinct asks for the key, add it where Instinct keeps secrets, never in the chat itself.

### Use the Spiral CLI

1. **Install and sign in**: Installs the Spiral CLI, signs you in and adds its skill to your coding agents.

```bash
npx -y spiral-cli@latest init
```

### Call the Spiral API

1. **Create an API key**: In the console, under API keys.

2. **Run GitHub repository file**: One request; the result comes back by polling or a webhook.

```bash
curl https://api.spiral.ai/v1/runs \
  -H "Authorization: Bearer $SPIRAL_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "provider": "alexandria",
    "model": "github-com/repositories/file",
    "input": {
      "url": "<url>"
    }
  }'
```

Then paste one of the prompts above: Instinct finds GitHub repository file on Spiral, shows the price and runs it.

Setup guide in the docs: https://spiral.ai/docs/quickstarts/instinct

## GitHub repository file tools and prices

- [GitHub · File](https://spiral.ai/tools/alexandria/github-com/repositories/file) (Alexandria): $0.001746 per call.

## Settings you can ask for

| Setting | Allowed values | Default | Description |
| --- | --- | --- | --- |
| ref |  | — | Branch, tag or commit SHA, with repo and path. Defaults to HEAD, the default branch. |
| path |  | — | File path inside the repository, for example `skills/frontend-design/SKILL.md`. |
| repo |  | — | Repository as `owner/name`, for example `anthropics/skills`. Requires path. Pattern: ^@?/?[A-Za-z0-9](?:[A-Za-z0-9-]{0,37}[A-Za-z0-9])?/[A-Za-z0-9._-]{1,100}(?:\.git)?/?$. |

## What can you do with GitHub repository file in Instinct?

Produce a recurring change report for selected public projects and packages on GitHub. A scheduled agent can compare saved observations of releases, repository status, issue totals, files, or advisories and report what changed.

### Review a dependency before adoption

Build an adoption brief covering repository status, contribution concentration, license text, issue categories and totals, release history, and reported vulnerability or malware concerns for the exact packages under consideration.

### Prepare a dependency upgrade review

Compare the installed version with published releases, read migration files and known issue reports, and check relevant advisories. Include project status and contribution concentration when deciding how much upstream support to expect.

### Investigate a reported package incident

Read the advisory and affected package ranges, compare release notes and manifests, then inspect related issue categories, reports, and totals. Keep a documented vulnerability fix separate from a malicious-package report.

### Maintain a package security watch

Check a defined package list for malware reports and known advisory changes, then compare repository status, manifests, and published releases with the previous review. Produce a change report with links to the supporting records.

### Plan an open source contribution

Read contribution instructions, discover the repository's actual labels, and inspect suitable issues alongside backlog totals. Use project status and contribution distribution to understand the project's context before proposing work.

### Compare migration destinations

Compare two public projects using their README files, repository metadata, contribution distribution, release notes, and issue evidence. Summarize which documented limitations matter for the planned migration.

### Write a vulnerability remediation brief

Explain a known CVE using its affected ranges, upstream files, and release notes. Check malicious-package reports separately and identify whether the evidence supports an upgrade or removing the package.

## Overview

- [Alexandria](https://spiral.ai/providers/alexandria)
- [All Instinct guides](https://spiral.ai/integrations/instinct)

## GitHub repository file in other agents

- [Amp](https://spiral.ai/integrations/amp/github-repository-file)
- [ChatGPT](https://spiral.ai/integrations/chatgpt/github-repository-file)
- [Claude](https://spiral.ai/integrations/claude-desktop/github-repository-file)
- [Claude Code](https://spiral.ai/integrations/claude-code/github-repository-file)
- [Cline](https://spiral.ai/integrations/cline/github-repository-file)
- [Codex](https://spiral.ai/integrations/codex/github-repository-file)
- [Cursor](https://spiral.ai/integrations/cursor/github-repository-file)
- [Devin](https://spiral.ai/integrations/devin/github-repository-file)
- [dots](https://spiral.ai/integrations/dots/github-repository-file)
- [Factory Droid](https://spiral.ai/integrations/factory-droid/github-repository-file)
- [Gemini](https://spiral.ai/integrations/gemini/github-repository-file)
- [Gemini CLI](https://spiral.ai/integrations/gemini-cli/github-repository-file)
- [Google Antigravity](https://spiral.ai/integrations/antigravity/github-repository-file)
- [goose](https://spiral.ai/integrations/goose/github-repository-file)
- [Grok](https://spiral.ai/integrations/grok/github-repository-file)
- [Grok Build](https://spiral.ai/integrations/grok-build/github-repository-file)
- [Hermes](https://spiral.ai/integrations/hermes/github-repository-file)
- [Manus](https://spiral.ai/integrations/manus/github-repository-file)
- [Muse](https://spiral.ai/integrations/muse/github-repository-file)
- [Muse Code](https://spiral.ai/integrations/muse-code/github-repository-file)
- [n8n](https://spiral.ai/integrations/n8n/github-repository-file)
- [Notion](https://spiral.ai/integrations/notion/github-repository-file)
- [OpenClaw](https://spiral.ai/integrations/openclaw/github-repository-file)
- [opencode](https://spiral.ai/integrations/opencode/github-repository-file)
- [Perplexity](https://spiral.ai/integrations/perplexity/github-repository-file)
- [Raycast](https://spiral.ai/integrations/raycast/github-repository-file)
- [VS Code](https://spiral.ai/integrations/vscode/github-repository-file)
- [Windsurf](https://spiral.ai/integrations/windsurf/github-repository-file)
- [Zapier](https://spiral.ai/integrations/zapier/github-repository-file)

## More Instinct guides

- [GitHub repository details](https://spiral.ai/integrations/instinct/github-repository-details)
- [GitHub repository issue counts](https://spiral.ai/integrations/instinct/github-repository-issue-counts)
- [GitHub repository contributors](https://spiral.ai/integrations/instinct/github-repository-contributors)
- [GitHub repository issues](https://spiral.ai/integrations/instinct/github-repository-issues)
- [GitHub release history](https://spiral.ai/integrations/instinct/github-release-history)
- [GitHub repository labels](https://spiral.ai/integrations/instinct/github-repository-labels)

## Questions about GitHub repository file in Instinct

**Can Instinct use GitHub repository file?**

Yes. Add Spiral to Instinct as an MCP server, and Instinct can find and run GitHub repository file like any built-in tool.

**How much does GitHub repository file cost in Instinct?**

$0.001746 per call. You pay from your Spiral balance as you go, with no subscription, and a failed run is not charged. Your Instinct plan is separate.

**Do I need an Alexandria account to use GitHub repository file in Instinct?**

You need no Alexandria account. Instinct uses one Spiral API key for every tool, and Spiral runs GitHub repository file on its own Alexandria account.

**How long does it take to set up GitHub repository file in Instinct?**

About two minutes: create an API key, then send Instinct this message, then give Instinct the key.

**Does Instinct wait while GitHub repository file runs?**

GitHub repository file runs in the background. Instinct starts the run, checks on it and gives you the json when it's ready.

**Can I reuse anything that is public on GitHub?**

Public visibility alone does not grant unrestricted reuse. GitHub says that without a license, default copyright restrictions apply to source code; its Advisory Database has a separate CC BY 4.0 license.

**How current is GitHub's data?**

Freshness depends on the record. Contributor results can be a few hours old because GitHub caches them, while a file selected by branch can change whenever new commits arrive.

**Does a GitHub release history include every version tag?**

No. GitHub excludes Git tags that have no associated release, and its latest-release lookup excludes prereleases and drafts.

**Do GitHub issues include pull requests?**

GitHub's underlying issue responses can contain both, with pull requests identified separately. An issue-only backlog should exclude pull requests before its totals are compared.

**Where do GitHub's malware reports come from?**

GitHub automatically publishes malware advisories from the npm security team and the OpenSSF Malicious Packages repository. These reports concern malicious packages and are separate from ordinary vulnerability advisories.

